From ae4247826638a93d674de0f15b0adffa206589b8 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Wed, 26 Mar 2025 12:46:11 -0400
Subject: [PATCH 01/93] fix: cache product list by query

---
 vtex/loaders/intelligentSearch/productList.ts |  7 +++----
 vtex/loaders/legacy/productList.ts            | 15 +++++----------
 2 files changed, 8 insertions(+), 14 deletions(-)

diff --git a/vtex/loaders/intelligentSearch/productList.ts b/vtex/loaders/intelligentSearch/productList.ts
index c920cb59d..eae248a5b 100644
--- a/vtex/loaders/intelligentSearch/productList.ts
+++ b/vtex/loaders/intelligentSearch/productList.ts
@@ -297,12 +297,11 @@ export const cacheKey = (
 
   const url = new URL(req.url);
 
-  if (
-    // Avoid cache on loader call over call and on search pages
-    (!isQueryList(props) && url.searchParams.has("q")) || ctx.isInvoke
-  ) {
+  // Avoid cache on loader call over call as it should be handled by the caller
+  if (ctx.isInvoke) {
     return null;
   }
+
   const segment = getSegmentFromBag(ctx)?.token ?? "";
   const params = new URLSearchParams([
     ...getSearchParams(props, url.searchParams),
diff --git a/vtex/loaders/legacy/productList.ts b/vtex/loaders/legacy/productList.ts
index 97ce53647..00d8e456e 100644
--- a/vtex/loaders/legacy/productList.ts
+++ b/vtex/loaders/legacy/productList.ts
@@ -4,9 +4,8 @@ import { AppContext } from "../../mod.ts";
 import { isFilterParam, toSegmentParams } from "../../utils/legacy.ts";
 import { getSegmentFromBag, withSegmentCookie } from "../../utils/segment.ts";
 import { withIsSimilarTo } from "../../utils/similars.ts";
-import { toProduct } from "../../utils/transform.ts";
+import { sortProducts, toProduct } from "../../utils/transform.ts";
 import type { LegacyItem, LegacySort } from "../../utils/types.ts";
-import { sortProducts } from "../../utils/transform.ts";
 
 /**
  * @title Collection ID
@@ -286,10 +285,8 @@ export const cacheKey = (
 
   const url = new URL(req.url);
 
-  if (
-    // Avoid cache on loader call over call and on search pages
-    (!isTermProps(props) && url.searchParams.has("q")) || ctx.isInvoke
-  ) {
+  // Avoid cache on loader call over call as it should be handled by the caller
+  if (ctx.isInvoke) {
     return null;
   }
 
@@ -304,10 +301,8 @@ export const cacheKey = (
     params.append("skuids", skuIds.join(","));
   }
 
-  if (
-    isProductIDProps(props)
-  ) {
-    const productIds = [props.productIds ?? []].sort();
+  if (isProductIDProps(props)) {
+    const productIds = [...props.productIds ?? []].sort();
     params.append("productids", productIds.join(","));
   }
 

From 41dd7ec0206dee297b353f61932d9e7bc80f07ad Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Matheus=20Gaudencio=20do=20R=C3=AAgo?=
 <matheusgr@users.noreply.github.com>
Date: Wed, 18 Dec 2024 14:11:05 -0300
Subject: [PATCH 02/93] Cookie with subdomains

---
 vtex/utils/segment.ts | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/vtex/utils/segment.ts b/vtex/utils/segment.ts
index 251e573f5..8f2960946 100644
--- a/vtex/utils/segment.ts
+++ b/vtex/utils/segment.ts
@@ -193,11 +193,15 @@ export const setSegmentBag = (
     });
   }
 
+  const hostname = (new URL(req.url)).hostname;
+  const cookieDomain = hostname.startsWith(".") ? hostname : `.${hostname}`;
+
   // Avoid setting cookie when segment from request matches the one generated
   if (vtex_segment !== token) {
     setCookie(ctx.response.headers, {
       value: token,
       name: SEGMENT_COOKIE_NAME,
+      domain: hostname === "localhost" ? "localhost" : cookieDomain,
       path: "/",
       secure: true,
       httpOnly: true,

From bd492c1f02842b8c69ded2b7780d54b7ac8e98a6 Mon Sep 17 00:00:00 2001
From: soutofernando <fernandosoutol45@gmail.com>
Date: Tue, 24 Sep 2024 21:15:51 -0300
Subject: [PATCH 03/93] feat: make it possible to exclude routes from being
 proxied in vtex

---
 vtex/loaders/proxy.ts | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/vtex/loaders/proxy.ts b/vtex/loaders/proxy.ts
index 57d9c7a06..92f4696dc 100644
--- a/vtex/loaders/proxy.ts
+++ b/vtex/loaders/proxy.ts
@@ -30,6 +30,7 @@ const buildProxyRoutes = (
     includeSiteMap,
     generateDecoSiteMap,
     excludePathsFromDecoSiteMap,
+    excludePathsFromVtexProxy,
     includeScriptsToHead,
     includeScriptsToBody,
   }: {
@@ -38,6 +39,7 @@ const buildProxyRoutes = (
     includeSiteMap?: string[];
     generateDecoSiteMap?: boolean;
     excludePathsFromDecoSiteMap: string[];
+    excludePathsFromVtexProxy?: string[];
     includeScriptsToHead?: {
       includes?: Script[];
     };
@@ -84,7 +86,10 @@ const buildProxyRoutes = (
         },
       });
     };
-    const routesFromPaths = [...PATHS_TO_PROXY, ...extraPaths].map(
+    const currentPathsToProxy = PATHS_TO_PROXY.filter((path) =>
+      !excludePathsFromVtexProxy?.includes(path)
+    );
+    const routesFromPaths = [...currentPathsToProxy, ...extraPaths].map(
       routeFromPath,
     );
 
@@ -142,6 +147,10 @@ export interface Props {
    * @title Exclude paths from /deco-sitemap.xml
    */
   excludePathsFromDecoSiteMap?: string[];
+  /**
+   * @title Exclude paths from VTEX PATHS_TO_PROXY
+   */
+  excludePathsFromVtexProxy?: string[];
   /**
    * @title Scripts to include on Html head
    */
@@ -165,6 +174,7 @@ function loader(
     includeSiteMap = [],
     generateDecoSiteMap = true,
     excludePathsFromDecoSiteMap = [],
+    excludePathsFromVtexProxy = [],
     includeScriptsToHead = { includes: [] },
     includeScriptsToBody = { includes: [] },
   }: Props,
@@ -174,6 +184,7 @@ function loader(
   return buildProxyRoutes({
     generateDecoSiteMap,
     excludePathsFromDecoSiteMap,
+    excludePathsFromVtexProxy,
     includeSiteMap,
     publicUrl: ctx.publicUrl,
     extraPaths: extraPathsToProxy,

From 2108385e84d5149eaef474be143ed30a82d5e427 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Thu, 26 Sep 2024 09:27:36 -0400
Subject: [PATCH 04/93] feat: add session loaders

feat: some payments related loaders

feat: my account vtex profile (#899)

feat: add the unitary order loader and start creating its typing

fix: props user.ts

feat: updateAddress action

chore: rebuild manifest

deno check

add try catch

remov throw

feat: adds address list loader

Co-authored-by: @yuri_assuncx <killerkoll2012@gmail.com>

feat: add loader to check if the password has already been changed

fix: receive address update props

feat: create adress action

chore: fixes typing error pointing by linter

chore: fixes typing error pointing by linter

feat: get address by postal code loader

feat: delete address action

fix: get the addresses with all the information and some refacts

fix: delete address

fix: address typing

change to promise allsettled

[VTEX] fix: add new types to support headless account feature (#939)

fix: add logged in user validation
---
 commerce/types.ts                           |  39 +++
 power-reviews/loaders/productListingPage.ts |  26 +-
 vtex/actions/address/createAddress.ts       |  67 +++++
 vtex/actions/address/deleteAddress.ts       |  58 ++++
 vtex/actions/address/updateAddress.ts       |  92 +++++++
 vtex/actions/payments/delete.ts             |  39 +++
 vtex/actions/profile/newsletterProfile.ts   |  60 ++++
 vtex/actions/profile/updateProfile.ts       |  93 +++++++
 vtex/actions/sessions/delete.ts             |  39 +++
 vtex/loaders/address/getAddressByZIP.ts     |  59 ++++
 vtex/loaders/address/list.ts                |  86 ++++++
 vtex/loaders/orders/list.ts                 |   8 +-
 vtex/loaders/orders/order.ts                |  39 +++
 vtex/loaders/payments/info.ts               |  55 ++++
 vtex/loaders/payments/userPayments.ts       |  61 +++++
 vtex/loaders/profile/passwordLastUpdate.ts  |  39 +++
 vtex/loaders/sessions/info.ts               |  68 +++++
 vtex/loaders/user.ts                        |  33 ++-
 vtex/manifest.gen.ts                        | 288 +++++++++++---------
 vtex/utils/client.ts                        |   4 +
 vtex/utils/types.ts                         | 159 ++++++++++-
 21 files changed, 1258 insertions(+), 154 deletions(-)
 create mode 100644 vtex/actions/address/createAddress.ts
 create mode 100644 vtex/actions/address/deleteAddress.ts
 create mode 100644 vtex/actions/address/updateAddress.ts
 create mode 100644 vtex/actions/payments/delete.ts
 create mode 100644 vtex/actions/profile/newsletterProfile.ts
 create mode 100644 vtex/actions/profile/updateProfile.ts
 create mode 100644 vtex/actions/sessions/delete.ts
 create mode 100644 vtex/loaders/address/getAddressByZIP.ts
 create mode 100644 vtex/loaders/address/list.ts
 create mode 100644 vtex/loaders/orders/order.ts
 create mode 100644 vtex/loaders/payments/info.ts
 create mode 100644 vtex/loaders/payments/userPayments.ts
 create mode 100644 vtex/loaders/profile/passwordLastUpdate.ts
 create mode 100644 vtex/loaders/sessions/info.ts

diff --git a/commerce/types.ts b/commerce/types.ts
index 05e3b5430..0aa17f2cf 100644
--- a/commerce/types.ts
+++ b/commerce/types.ts
@@ -413,7 +413,27 @@ export interface Person extends Omit<Thing, "@type"> {
   taxID?: string;
   /** The telephone number. */
   telephone?: string;
+  /** The birth date of the person. */
+  birthDate?: string;
+  /** User's corporate name */
+  corporateName?: string;
+  /** User's corporate document */
+  corporateDocument?: string;
+  /** User's corporate trade name */
+  tradeName?: string;
+  /** User's business phone */
+  businessPhone?: string;
+  /** Whether the user is a corporation or not */
+  isCorporate?: boolean;
+  /** Custom fields */
+  customFields?: CustomFields[];
+}
+
+interface CustomFields {
+  key: string;
+  value: string;
 }
+
 // NON SCHEMA.ORG Compliant. Should be removed ASAP
 export interface Author extends Omit<Thing, "@type"> {
   "@type": "Author";
@@ -597,6 +617,25 @@ export interface PostalAddress extends Omit<ContactPoint, "@type"> {
   /** The street address. For example, 1600 Amphitheatre Pkwy. */
   streetAddress?: string;
 }
+
+export interface PostalAddressVTEX extends Omit<ContactPoint, "@type"> {
+  "@type": "PostalAddress";
+  /** The country. For example, USA. You can also provide the two-letter ISO 3166-1 alpha-2 country code. */
+  addressCountry?: string;
+  /** The locality in which the street address is, and which is in the region. For example, Mountain View. */
+  addressLocality?: string;
+  /** The region in which the locality is, and which is in the country. For example, California. */
+  addressRegion?: string;
+  /** The postal code. For example, 94043. */
+  postalCode?: string;
+  /** The street address. For example, 1600 Amphitheatre Pkwy. */
+  streetAddress?: string;
+  receiverName: string | null;
+  addressName?: string;
+  complement: string | null;
+  addressId: string;
+}
+
 export interface LocationFeatureSpecification
   extends Omit<PropertyValue, "@type"> {
   "@type": "LocationFeatureSpecification";
diff --git a/power-reviews/loaders/productListingPage.ts b/power-reviews/loaders/productListingPage.ts
index 43c090dc9..12941e798 100644
--- a/power-reviews/loaders/productListingPage.ts
+++ b/power-reviews/loaders/productListingPage.ts
@@ -52,17 +52,27 @@ export default function productListingPage(
       })
     );
 
-    const fullReviewsResponse = await Promise.all(fullReviewsPromises);
+    const fullReviewsResponse = await Promise.allSettled(fullReviewsPromises);
 
-    const fullReviewsResults = await Promise.all(
-      fullReviewsResponse.map((review) => review.json()),
+    const fullReviewsResults = await Promise.allSettled(
+      fullReviewsResponse.map((response) => {
+        if (response.status === "fulfilled") {
+          return response.value.json();
+        } else {
+          return null;
+        }
+      }),
     );
 
-    const productsExtendeds = fullReviewsResults.map((review, idx) => {
-      return {
-        ...products[idx],
-        aggregateRating: toAggregateRating(review.results[0].rollup),
-      };
+    const productsExtendeds = fullReviewsResults.map((result, idx) => {
+      if (result.status === "fulfilled" && result.value) {
+        return {
+          ...products[idx],
+          aggregateRating: toAggregateRating(result.value.results[0].rollup),
+        };
+      } else {
+        return products[idx];
+      }
     });
 
     return {
diff --git a/vtex/actions/address/createAddress.ts b/vtex/actions/address/createAddress.ts
new file mode 100644
index 000000000..af849c53a
--- /dev/null
+++ b/vtex/actions/address/createAddress.ts
@@ -0,0 +1,67 @@
+import { AppContext } from "../../mod.ts";
+import { parseCookie } from "../../utils/vtexId.ts";
+
+interface AddressInput {
+  name?: string;
+  addressName: string;
+  addressType?: string;
+  city?: string;
+  complement?: string;
+  country?: string;
+  geoCoordinates?: number[];
+  neighborhood?: string;
+  number?: string;
+  postalCode?: string;
+  receiverName?: string;
+  reference?: string;
+  state?: string;
+  street?: string;
+}
+
+interface SavedAddress {
+  id: string;
+  cacheId: string;
+}
+
+async function action(
+  props: AddressInput,
+  req: Request,
+  ctx: AppContext,
+): Promise<
+  | SavedAddress
+  | null
+> {
+  const { io } = ctx;
+  const { cookie } = parseCookie(req.headers, ctx.account);
+
+  const mutation = `
+  mutation SaveAddress($address: AddressInput!) {
+    saveAddress(address: $address) @context(provider: "vtex.store-graphql") {
+      id
+      cacheId
+    }
+  }`;
+
+  try {
+    const { saveAddress: savedAddress } = await io.query<
+      { saveAddress: SavedAddress },
+      { address: AddressInput }
+    >(
+      {
+        query: mutation,
+        operationName: "SaveAddress",
+        variables: {
+          address: props,
+        },
+      },
+      { headers: { cookie } },
+    );
+
+    return savedAddress;
+  } catch (error) {
+    console.error("Error saving address:", error);
+    return null;
+  }
+}
+
+export default action;
diff --git a/vtex/actions/address/deleteAddress.ts b/vtex/actions/address/deleteAddress.ts
new file mode 100644
index 000000000..760afd133
--- /dev/null
+++ b/vtex/actions/address/deleteAddress.ts
@@ -0,0 +1,58 @@
+import { AppContext } from "../../mod.ts";
+import { parseCookie } from "../../utils/vtexId.ts";
+
+interface DeleteAddress {
+  addressId: string;
+}
+
+interface AddressInput {
+  addressId: string;
+}
+
+async function action(
+  { addressId }: AddressInput,
+  req: Request,
+  ctx: AppContext,
+) {
+  const { io } = ctx;
+  const { cookie } = parseCookie(req.headers, ctx.account);
+
+  const mutation = `
+  mutation DeleteAddress($addressId: String) {
+    deleteAddress(id: $addressId) {
+      cacheId
+      addresses: address {
+        addressId: id
+        addressType
+        addressName
+        city
+        complement
+        country
+        neighborhood
+        number
+        postalCode
+        geoCoordinates
+        receiverName
+        reference
+        state
+        street
+      }
+    }
+  }`;
+
+  try {
+    return await io.query<DeleteAddress, { addressId: string }>(
+      {
+        query: mutation,
+        operationName: "DeleteAddress",
+        variables: { addressId },
+      },
+      { headers: { cookie } },
+    );
+  } catch (error) {
+    console.error("Error deleting address:", error);
+    return null;
+  }
+}
+
+export default action;
diff --git a/vtex/actions/address/updateAddress.ts b/vtex/actions/address/updateAddress.ts
new file mode 100644
index 000000000..136ed41bc
--- /dev/null
+++ b/vtex/actions/address/updateAddress.ts
@@ -0,0 +1,92 @@
+import { PostalAddressVTEX } from "../../../commerce/types.ts";
+import { AppContext } from "../../mod.ts";
+import { parseCookie } from "../../utils/vtexId.ts";
+
+interface Address {
+  name?: string;
+  addressName?: string;
+  addressType?: string;
+  city?: string;
+  complement: string | null;
+  country?: string;
+  geoCoordinates?: number[];
+  neighborhood?: string;
+  number?: string;
+  postalCode?: string;
+  receiverName: string | null;
+  reference?: string;
+  state?: string;
+  street?: string;
+  addressId: string;
+}
+
+async function action(
+  props: Address,
+  req: Request,
+  ctx: AppContext,
+): Promise<
+  | PostalAddressVTEX
+  | null
+> {
+  const { io } = ctx;
+  const { cookie } = parseCookie(req.headers, ctx.account);
+  const { addressId, ...addressFields } = props;
+
+  const mutation = `
+    mutation UpdateAddress($addressId: String!, $addressFields: AddressInput) {
+      updateAddress(id: $addressId, fields: $addressFields)
+        @context(provider: "vtex.store-graphql") {
+        cacheId
+        addresses: address {
+          addressId: id
+          addressType
+          addressName
+          city
+          complement
+          country
+          neighborhood
+          number
+          postalCode
+          geoCoordinates
+          receiverName
+          reference
+          state
+          street
+        }
+      }
+    }
+  `;
+
+  try {
+    const { updateAddress: updatedAddress } = await io.query<
+      { updateAddress: Address },
+      { addressId: string; addressFields: Omit<Address, "addressId"> }
+    >(
+      {
+        query: mutation,
+        operationName: "UpdateAddress",
+        variables: {
+          addressId,
+          addressFields,
+        },
+      },
+      { headers: { cookie } },
+    );
+
+    return {
+      "@type": "PostalAddress",
+      addressCountry: updatedAddress?.country,
+      addressLocality: updatedAddress?.city,
+      addressRegion: updatedAddress?.state,
+      postalCode: updatedAddress?.postalCode,
+      streetAddress: updatedAddress?.street,
+      receiverName: updatedAddress?.receiverName,
+      complement: updatedAddress?.complement,
+      addressId: updatedAddress?.addressId,
+    };
+  } catch (error) {
+    console.error("Error updating address:", error);
+    return null;
+  }
+}
+export default action;
diff --git a/vtex/actions/payments/delete.ts b/vtex/actions/payments/delete.ts
new file mode 100644
index 000000000..341ecee37
--- /dev/null
+++ b/vtex/actions/payments/delete.ts
@@ -0,0 +1,39 @@
+import { AppContext } from "../../mod.ts";
+import { parseCookie } from "../../utils/vtexId.ts";
+
+export interface DeleteCard {
+  deletePaymentToken: boolean;
+}
+
+interface Props {
+  id: string;
+}
+
+async function loader(
+  { id }: Props,
+  req: Request,
+  ctx: AppContext,
+): Promise<DeleteCard | null> {
+  const { io } = ctx;
+  const { cookie, payload } = parseCookie(req.headers, ctx.account);
+
+  if (!payload?.sub || !payload?.userId) {
+    return null;
+  }
+
+  const mutation = `mutation DeleteCreditCardToken($tokenId: ID!) {
+    deletePaymentToken(tokenId: $tokenId) @context(provider: "vtex.my-cards-graphql@2.x")
+  }`;
+
+  try {
+    return await io.query<DeleteCard, { tokenId: string }>({
+      query: mutation,
+      variables: { tokenId: id },
+    }, { headers: { cookie } });
+  } catch (e) {
+    console.error(e);
+    return null;
+  }
+}
+
+export default loader;
diff --git a/vtex/actions/profile/newsletterProfile.ts b/vtex/actions/profile/newsletterProfile.ts
new file mode 100644
index 000000000..1f14b6403
--- /dev/null
+++ b/vtex/actions/profile/newsletterProfile.ts
@@ -0,0 +1,60 @@
+import { AppContext } from "../../mod.ts";
+import { parseCookie } from "../../utils/vtexId.ts";
+
+interface NewsletterInput {
+  email: string;
+  isNewsletterOptIn: boolean;
+}
+
+const newsletterProfile = async (
+  props: NewsletterInput,
+  req: Request,
+  ctx: AppContext,
+): Promise<boolean | null> => {
+  const { io } = ctx;
+  const { cookie } = parseCookie(req.headers, ctx.account);
+
+  if (!props?.email) {
+    console.error("User profile not found or email is missing:", props.email);
+    return null;
+  }
+
+  const mutation = `
+    mutation SubscribeNewsletter($email: String!, $isNewsletterOptIn: Boolean!) {
+      subscribeNewsletter(email: $email, isNewsletterOptIn: $isNewsletterOptIn) 
+      @context(provider: "vtex.store-graphql@2.x")
+    }
+  `;
+
+  const variables = {
+    email: props.email,
+    isNewsletterOptIn: props.isNewsletterOptIn,
+  };
+
+  try {
+    await io.query<{ subscribeNewsletter: boolean }, unknown>(
+      {
+        query: mutation,
+        operationName: "SubscribeNewsletter",
+        variables,
+      },
+      {
+        headers: {
+          cookie,
+        },
+      },
+    );
+
+    const result = await ctx.invoke("vtex/loaders/user.ts");
+    const newsletterField = result?.customFields?.find((field) =>
+      field.key === "isNewsletterOptIn"
+    );
+
+    return newsletterField?.value === "true";
+  } catch (error) {
+    console.error("Error subscribing to newsletter:", error);
+    return null;
+  }
+};
+
+export default newsletterProfile;
diff --git a/vtex/actions/profile/updateProfile.ts b/vtex/actions/profile/updateProfile.ts
new file mode 100644
index 000000000..17c4f724b
--- /dev/null
+++ b/vtex/actions/profile/updateProfile.ts
@@ -0,0 +1,93 @@
+import { AppContext } from "../../mod.ts";
+import { parseCookie } from "../../utils/vtexId.ts";
+import { Person } from "../../../commerce/types.ts";
+import type { User } from "../../loaders/user.ts";
+
+export interface UserMutation {
+  firstName?: string;
+  lastName?: string;
+  email?: string;
+  homePhone?: string | null;
+  gender?: string | null;
+  birthDate?: string | null;
+  corporateName?: string | null;
+  tradeName?: string | null;
+  businessPhone?: string | null;
+  isCorporate?: boolean;
+}
+
+const updateProfile = async (
+  props: UserMutation,
+  req: Request,
+  ctx: AppContext,
+): Promise<Person | null> => {
+  const { io } = ctx;
+  const { cookie } = parseCookie(req.headers, ctx.account);
+
+  if (!props?.email) {
+    console.error("User profile not found or email is missing:", props.email);
+    return null;
+  }
+  const mutation = `
+   mutation UpdateProfile($input: ProfileInput!) {
+      updateProfile(fields: $input) @context(provider: "vtex.store-graphql") {
+        cacheId
+        firstName
+        lastName
+        birthDate
+        gender
+        homePhone
+        businessPhone
+        document
+        email
+        tradeName
+        corporateName
+        corporateDocument
+        stateRegistration
+        isCorporate
+      }
+    }
+  `;
+
+  try {
+    const { updateProfile: updatedUser } = await io.query<
+      { updateProfile: User },
+      { input: UserMutation }
+    >(
+      {
+        query: mutation,
+        operationName: "UpdateProfile",
+        variables: {
+          input: {
+            ...props,
+            email: props.email,
+          },
+        },
+      },
+      { headers: { cookie } },
+    );
+
+    return {
+      "@id": updatedUser?.userId ?? updatedUser.id,
+      email: updatedUser.email,
+      givenName: updatedUser?.firstName,
+      familyName: updatedUser?.lastName,
+      taxID: updatedUser?.document?.replace(/[^\d]/g, ""),
+      gender: updatedUser?.gender === "female"
+        ? "https://schema.org/Female"
+        : "https://schema.org/Male",
+      telephone: updatedUser?.homePhone,
+      birthDate: updatedUser?.birthDate,
+      corporateName: updatedUser?.tradeName,
+      corporateDocument: updatedUser?.corporateDocument,
+      businessPhone: updatedUser?.businessPhone,
+      isCorporate: updatedUser?.isCorporate,
+      customFields: updatedUser?.customFields,
+    };
+  } catch (error) {
+    console.error("Error updating user profile:", error);
+    return null;
+  }
+};
+
+export default updateProfile;
diff --git a/vtex/actions/sessions/delete.ts b/vtex/actions/sessions/delete.ts
new file mode 100644
index 000000000..e55b77e31
--- /dev/null
+++ b/vtex/actions/sessions/delete.ts
@@ -0,0 +1,39 @@
+import { AppContext } from "../../mod.ts";
+import { parseCookie } from "../../utils/vtexId.ts";
+
+export interface DeleteSession {
+  logOutFromSession: string;
+}
+
+interface Props {
+  sessionId: string;
+}
+
+async function loader(
+  { sessionId }: Props,
+  req: Request,
+  ctx: AppContext,
+): Promise<DeleteSession | null> {
+  const { io } = ctx;
+  const { cookie, payload } = parseCookie(req.headers, ctx.account);
+
+  if (!payload?.sub || !payload?.userId) {
+    return null;
+  }
+
+  const mutation = `mutation LogOutFromSession($sessionId: ID) {
+    logOutFromSession(sessionId: $sessionId) @context(provider: "vtex.store-graphql@2.x")
+  }`;
+
+  try {
+    return await io.query<DeleteSession, { sessionId: string }>({
+      query: mutation,
+      variables: { sessionId },
+    }, { headers: { cookie } });
+  } catch (e) {
+    console.error(e);
+    return null;
+  }
+}
+
+export default loader;
diff --git a/vtex/loaders/address/getAddressByZIP.ts b/vtex/loaders/address/getAddressByZIP.ts
new file mode 100644
index 000000000..a7f7a1e53
--- /dev/null
+++ b/vtex/loaders/address/getAddressByZIP.ts
@@ -0,0 +1,59 @@
+import { AppContext } from "../../mod.ts";
+
+interface Props {
+  /**
+   * @description User country code. Ex: USA
+   */
+  countryCode: string;
+  /**
+   * @description User postal code.
+   */
+  postalCode: string;
+}
+
+interface AddressByPostalCode {
+  postalCode: string;
+  city: string;
+  state: string;
+  country: string;
+  street: string | null;
+  number: string | null;
+  neighborhood: string | null;
+  complement: string | null;
+  reference: string | null;
+  geoCoordinates: number[] | null;
+}
+
+export default async function loader(
+  props: Props,
+  _req: Request,
+  ctx: AppContext,
+): Promise<AddressByPostalCode> {
+  const { countryCode, postalCode } = props;
+  const { vcs } = ctx;
+
+  try {
+    const addressByPostalCode = await vcs
+      ["GET /api/checkout/pub/postal-code/:countryCode/:postalCode"]({
+        countryCode,
+        postalCode,
+      })
+      .then((r) => r.json()) as AddressByPostalCode;
+
+    return addressByPostalCode;
+  } catch (error) {
+    console.log(error);
+    return {
+      postalCode: "",
+      city: "",
+      state: "",
+      country: "",
+      street: null,
+      number: null,
+      neighborhood: null,
+      complement: null,
+      reference: null,
+      geoCoordinates: [],
+    };
+  }
+}
diff --git a/vtex/loaders/address/list.ts b/vtex/loaders/address/list.ts
new file mode 100644
index 000000000..eaadbba7b
--- /dev/null
+++ b/vtex/loaders/address/list.ts
@@ -0,0 +1,86 @@
+import { Address } from "../../utils/types.ts";
+import { PostalAddressVTEX } from "../../../commerce/types.ts";
+import { parseCookie } from "../../utils/vtexId.ts";
+import { AppContext } from "../../mod.ts";
+
+export interface User {
+  id: string;
+  userId: string;
+  email: string;
+  firstName?: string;
+  lastName?: string;
+  profilePicture?: string;
+  gender?: string;
+  document?: string;
+  homePhone?: string;
+  birthDate?: string;
+  corporateDocument?: string;
+  corporateName?: string;
+  tradeName?: string;
+  businessPhone?: string;
+  isCorporate?: boolean;
+  customFields?: { key: string; value: string }[];
+}
+
+async function loader(
+  _props: unknown,
+  req: Request,
+  ctx: AppContext,
+): Promise<
+  PostalAddressVTEX[] | null
+> {
+  const { io } = ctx;
+  const { cookie, payload } = parseCookie(req.headers, ctx.account);
+
+  if (!payload?.sub || !payload?.userId) {
+    return null;
+  }
+
+  const query = `query Addresses @context(scope: "private") {
+    profile {
+      cacheId
+      addresses: address {
+        addressId: id
+        addressType
+        addressName
+        city
+        complement
+        country
+        neighborhood
+        number
+        postalCode
+        geoCoordinates
+        receiverName
+        state
+        street
+      }
+    }
+  }`;
+
+  try {
+    const { profile } = await io.query<
+      { profile: { addresses: Address[] } },
+      null
+    >(
+      { query },
+      { headers: { cookie } },
+    );
+
+    return profile?.addresses?.map((address) => ({
+      "@type": "PostalAddress",
+      addressCountry: address?.country,
+      addressLocality: address?.city,
+      addressRegion: address?.state,
+      postalCode: address?.postalCode,
+      streetAddress: address?.street,
+      receiverName: address?.receiverName,
+      addressName: address?.addressName,
+      complement: address?.complement,
+      addressId: address?.addressId,
+    }));
+  } catch (_) {
+    return null;
+  }
+}
+
+export default loader;
diff --git a/vtex/loaders/orders/list.ts b/vtex/loaders/orders/list.ts
index 2921e0bcb..2895c267a 100644
--- a/vtex/loaders/orders/list.ts
+++ b/vtex/loaders/orders/list.ts
@@ -12,10 +12,14 @@ export default async function loader(
   props: Props,
   req: Request,
   ctx: AppContext,
-): Promise<Userorderslist> {
+): Promise<Userorderslist | null> {
   const { vcsDeprecated } = ctx;
   const { clientEmail, page = "0", per_page = "15" } = props;
-  const { cookie } = parseCookie(req.headers, ctx.account);
+  const { cookie, payload } = parseCookie(req.headers, ctx.account);
+
+  if (!payload?.sub || !payload?.userId) {
+    return null;
+  }
 
   const ordersResponse = await vcsDeprecated
     ["GET /api/oms/user/orders"](
diff --git a/vtex/loaders/orders/order.ts b/vtex/loaders/orders/order.ts
new file mode 100644
index 000000000..2b4501206
--- /dev/null
+++ b/vtex/loaders/orders/order.ts
@@ -0,0 +1,39 @@
+import { RequestURLParam } from "../../../website/functions/requestToParam.ts";
+import { AppContext } from "../../mod.ts";
+import { OrderItem } from "../../utils/types.ts";
+import { parseCookie } from "../../utils/vtexId.ts";
+
+export interface Props {
+  slug: RequestURLParam;
+}
+
+export default async function loader(
+  props: Props,
+  req: Request,
+  ctx: AppContext,
+): Promise<OrderItem | null> {
+  const { vcsDeprecated } = ctx;
+  const { cookie, payload } = parseCookie(req.headers, ctx.account);
+
+  if (!payload?.sub || !payload?.userId) {
+    return null;
+  }
+
+  const { slug } = props;
+
+  const response = await vcsDeprecated["GET /api/oms/user/orders/:orderId"](
+    { orderId: slug },
+    {
+      headers: {
+        cookie,
+      },
+    },
+  );
+
+  if (response.ok) {
+    const order = await response.json();
+    return order;
+  }
+
+  return null;
+}
diff --git a/vtex/loaders/payments/info.ts b/vtex/loaders/payments/info.ts
new file mode 100644
index 000000000..3390d23fd
--- /dev/null
+++ b/vtex/loaders/payments/info.ts
@@ -0,0 +1,55 @@
+import { AppContext } from "../../mod.ts";
+import { parseCookie } from "../../utils/vtexId.ts";
+
+const query = `query getPaymentSystems {
+  paymentSystems {
+    name
+    groupName
+    requiresDocument
+    displayDocument
+    validator {
+      regex
+      mask
+      cardCodeMask
+      cardCodeRegex
+    }
+  }
+}`;
+
+export interface PaymentSystem {
+  name: string;
+  groupName: string;
+  requiresDocument: boolean;
+  displayDocument: boolean;
+  validator: {
+    regex: string | null;
+    mask: string | null;
+    cardCodeMask: string | null;
+    cardCodeRegex: string | null;
+  };
+}
+
+export default async function loader(
+  _props: unknown,
+  req: Request,
+  ctx: AppContext,
+) {
+  const { io } = ctx;
+  const { cookie, payload } = parseCookie(req.headers, ctx.account);
+
+  if (!payload?.sub || !payload?.userId) {
+    return null;
+  }
+
+  try {
+    const data = await io.query<{ paymentSystems: PaymentSystem[] }, null>(
+      { query },
+      { headers: { cookie } },
+    );
+
+    return data.paymentSystems;
+  } catch (e) {
+    console.error(e);
+    return null;
+  }
+}
diff --git a/vtex/loaders/payments/userPayments.ts b/vtex/loaders/payments/userPayments.ts
new file mode 100644
index 000000000..78cd5f2d0
--- /dev/null
+++ b/vtex/loaders/payments/userPayments.ts
@@ -0,0 +1,61 @@
+// fetch("https://www.als.com/_v/private/graphql/v1?workspace=master&maxAge=long&appsEtag=remove&domain=store&locale=en-US&__bindingId=d8649f18-3877-43de-88e6-c45a81eddc02", {
+// 	"headers": {
+// 		"content-type": "application/json",
+// 	},
+// 	"body": "{\"operationName\":\"Payments\",\"variables\":{},\"extensions\":{\"persistedQuery\":{\"version\":1,\"sha256Hash\":\"95af11127e44f1857144e38f18635e0d085113c3bfdda3e4b8bc99ae63e14e60\",\"sender\":\"vtex.my-cards@1.x\",\"provider\":\"vtex.store-graphql@2.x\"}}}",
+// 	"method": "POST"
+// })
+
+import { AppContext } from "../../mod.ts";
+import { parseCookie } from "../../utils/vtexId.ts";
+
+export interface Payment {
+  accountStatus: string | null;
+  cardNumber: string;
+  expirationDate: string;
+  id: string;
+  isExpired: boolean;
+  paymentSystem: string;
+  paymentSystemName: string;
+}
+
+async function loader(
+  _props: unknown,
+  req: Request,
+  ctx: AppContext,
+): Promise<Payment[] | null> {
+  const { io } = ctx;
+  const { cookie, payload } = parseCookie(req.headers, ctx.account);
+
+  if (!payload?.sub || !payload?.userId) {
+    return null;
+  }
+
+  const query = `query getUserPayments {
+      profile {
+        payments {
+          accountStatus
+          cardNumber
+          expirationDate
+          id
+          isExpired
+          paymentSystem
+          paymentSystemName
+        }
+      }
+  }`;
+
+  try {
+    const data = await io.query<{ profile: { payments: Payment[] } }, null>(
+      { query },
+      { headers: { cookie } },
+    );
+
+    return data.profile.payments;
+  } catch (e) {
+    console.error(e);
+    return null;
+  }
+}
+
+export default loader;
diff --git a/vtex/loaders/profile/passwordLastUpdate.ts b/vtex/loaders/profile/passwordLastUpdate.ts
new file mode 100644
index 000000000..f60d69731
--- /dev/null
+++ b/vtex/loaders/profile/passwordLastUpdate.ts
@@ -0,0 +1,39 @@
+import { AppContext } from "../../mod.ts";
+import { parseCookie } from "../../utils/vtexId.ts";
+
+export interface ProfilePassword {
+  passwordLastUpdate?: PasswordLastUpdate;
+}
+
+export type PasswordLastUpdate = string | null;
+
+async function loader(
+  _props: unknown,
+  req: Request,
+  ctx: AppContext,
+): Promise<PasswordLastUpdate | null> {
+  const { io } = ctx;
+  const { cookie, payload } = parseCookie(req.headers, ctx.account);
+
+  if (!payload?.sub || !payload?.userId) {
+    return null;
+  }
+  console.log({ teste: payload?.userId });
+
+  const query = `query getUserProfile { profile { passwordLastUpdate }}`;
+
+  try {
+    const { profile } = await io.query<{ profile: ProfilePassword }, null>(
+      { query },
+      { headers: { cookie } },
+    );
+
+    console.log({ profile });
+
+    return profile.passwordLastUpdate ?? null;
+  } catch (_) {
+    return null;
+  }
+}
+
+export default loader;
diff --git a/vtex/loaders/sessions/info.ts b/vtex/loaders/sessions/info.ts
new file mode 100644
index 000000000..1739fd41c
--- /dev/null
+++ b/vtex/loaders/sessions/info.ts
@@ -0,0 +1,68 @@
+import { AppContext } from "../../mod.ts";
+import { parseCookie } from "../../utils/vtexId.ts";
+
+export interface LoginSessionInfo {
+  currentLoginSessionId: string;
+  loginSessions: LoginSession[];
+}
+
+export interface LoginSession {
+  id: string;
+  cacheId: string;
+  deviceType: string;
+  lastAccess: string;
+  city: string;
+  fullAddress: string;
+  ip: string;
+  browser: string;
+  os: string;
+  firstAccess: string;
+}
+
+async function loader(
+  _props: unknown,
+  req: Request,
+  ctx: AppContext,
+): Promise<LoginSessionInfo | null> {
+  const { io } = ctx;
+  const { cookie, payload } = parseCookie(req.headers, ctx.account);
+
+  if (!payload?.sub || !payload?.userId) {
+    return null;
+  }
+
+  const query = `query getUserSessions {
+      loginSessionsInfo {
+        currentLoginSessionId
+        loginSessions {
+          id
+          cacheId
+          deviceType
+          lastAccess
+          city
+          fullAddress
+          ip
+          browser
+          os
+          firstAccess
+        }
+      }
+    }`;
+
+  try {
+    const data = await io.query<
+      { loginSessionsInfo: LoginSessionInfo },
+      null
+    >(
+      { query },
+      { headers: { cookie } },
+    );
+
+    return data.loginSessionsInfo;
+  } catch (e) {
+    console.error(e);
+    return null;
+  }
+}
+
+export default loader;
diff --git a/vtex/loaders/user.ts b/vtex/loaders/user.ts
index 47a8ad03a..533b4a8f3 100644
--- a/vtex/loaders/user.ts
+++ b/vtex/loaders/user.ts
@@ -2,7 +2,7 @@ import { Person } from "../../commerce/types.ts";
 import { AppContext } from "../mod.ts";
 import { parseCookie } from "../utils/vtexId.ts";
 
-interface User {
+export interface User {
   id: string;
   userId: string;
   email: string;
@@ -12,7 +12,13 @@ interface User {
   gender?: string;
   document?: string;
   homePhone?: string;
+  birthDate?: string;
+  corporateDocument?: string;
+  corporateName?: string;
+  tradeName?: string;
   businessPhone?: string;
+  isCorporate?: boolean;
+  customFields?: { key: string; value: string }[];
 }
 
 async function loader(
@@ -28,7 +34,7 @@ async function loader(
   }
 
   const query =
-    "query getUserProfile { profile { id userId email firstName lastName profilePicture gender document homePhone businessPhone }}";
+    `query getUserProfile { profile(customFields: "isNewsletterOptIn") { id userId email firstName lastName profilePicture gender document homePhone birthDate corporateDocument corporateName tradeName businessPhone isCorporate customFields { key value } }}`;
 
   try {
     const { profile: user } = await io.query<{ profile: User }, null>(
@@ -37,17 +43,22 @@ async function loader(
     );
 
     return {
-      "@id": user.userId ?? user.id,
+      "@id": user?.userId ?? user.id,
       email: user.email,
-      givenName: user.firstName,
-      familyName: user.lastName,
+      givenName: user?.firstName,
+      familyName: user?.lastName,
       taxID: user?.document?.replace(/[^\d]/g, ""),
-      gender: user.gender
-        ? user.gender === "f"
-          ? "https://schema.org/Female"
-          : "https://schema.org/Male"
-        : undefined,
-      telephone: user.homePhone ?? user.businessPhone,
+      gender: user?.gender === "female"
+        ? "https://schema.org/Female"
+        : "https://schema.org/Male",
+      telephone: user?.homePhone,
+      birthDate: user?.birthDate,
+      corporateName: user?.corporateName,
+      tradeName: user?.tradeName,
+      corporateDocument: user?.corporateDocument,
+      businessPhone: user?.businessPhone,
+      isCorporate: user?.isCorporate,
+      customFields: user?.customFields,
     };
   } catch (_) {
     return null;
diff --git a/vtex/manifest.gen.ts b/vtex/manifest.gen.ts
index 921f1446c..f80a3c0c9 100644
--- a/vtex/manifest.gen.ts
+++ b/vtex/manifest.gen.ts
@@ -2,118 +2,139 @@
 // This file SHOULD be checked into source version control.
 // This file is automatically updated during development when running `dev.ts`.
 
-import * as $$$$$$$$$0 from "./actions/analytics/sendEvent.ts";
-import * as $$$$$$$$$1 from "./actions/cart/addItems.ts";
-import * as $$$$$$$$$2 from "./actions/cart/addOfferings.ts";
-import * as $$$$$$$$$3 from "./actions/cart/clearOrderformMessages.ts";
-import * as $$$$$$$$$4 from "./actions/cart/getInstallment.ts";
-import * as $$$$$$$$$5 from "./actions/cart/removeItemAttachment.ts";
-import * as $$$$$$$$$6 from "./actions/cart/removeItems.ts";
-import * as $$$$$$$$$7 from "./actions/cart/removeOffering.ts";
-import * as $$$$$$$$$8 from "./actions/cart/simulation.ts";
-import * as $$$$$$$$$9 from "./actions/cart/updateAttachment.ts";
-import * as $$$$$$$$$10 from "./actions/cart/updateCoupons.ts";
-import * as $$$$$$$$$11 from "./actions/cart/updateGifts.ts";
-import * as $$$$$$$$$12 from "./actions/cart/updateItemAttachment.ts";
-import * as $$$$$$$$$13 from "./actions/cart/updateItemPrice.ts";
-import * as $$$$$$$$$14 from "./actions/cart/updateItems.ts";
-import * as $$$$$$$$$15 from "./actions/cart/updateProfile.ts";
-import * as $$$$$$$$$16 from "./actions/cart/updateUser.ts";
-import * as $$$$$$$$$17 from "./actions/masterdata/createDocument.ts";
-import * as $$$$$$$$$18 from "./actions/masterdata/updateDocument.ts";
-import * as $$$$$$$$$19 from "./actions/newsletter/subscribe.ts";
-import * as $$$$$$$$$20 from "./actions/notifyme.ts";
-import * as $$$$$$$$$21 from "./actions/review/submit.ts";
-import * as $$$$$$$$$22 from "./actions/trigger.ts";
-import * as $$$$$$$$$23 from "./actions/wishlist/addItem.ts";
-import * as $$$$$$$$$24 from "./actions/wishlist/removeItem.ts";
+import * as $$$$$$$$$0 from "./actions/address/createAddress.ts";
+import * as $$$$$$$$$1 from "./actions/address/deleteAddress.ts";
+import * as $$$$$$$$$2 from "./actions/address/updateAddress.ts";
+import * as $$$$$$$$$3 from "./actions/analytics/sendEvent.ts";
+import * as $$$$$$$$$4 from "./actions/cart/addItems.ts";
+import * as $$$$$$$$$5 from "./actions/cart/addOfferings.ts";
+import * as $$$$$$$$$6 from "./actions/cart/clearOrderformMessages.ts";
+import * as $$$$$$$$$7 from "./actions/cart/getInstallment.ts";
+import * as $$$$$$$$$8 from "./actions/cart/removeItemAttachment.ts";
+import * as $$$$$$$$$9 from "./actions/cart/removeItems.ts";
+import * as $$$$$$$$$10 from "./actions/cart/removeOffering.ts";
+import * as $$$$$$$$$11 from "./actions/cart/simulation.ts";
+import * as $$$$$$$$$12 from "./actions/cart/updateAttachment.ts";
+import * as $$$$$$$$$13 from "./actions/cart/updateCoupons.ts";
+import * as $$$$$$$$$14 from "./actions/cart/updateGifts.ts";
+import * as $$$$$$$$$15 from "./actions/cart/updateItemAttachment.ts";
+import * as $$$$$$$$$16 from "./actions/cart/updateItemPrice.ts";
+import * as $$$$$$$$$17 from "./actions/cart/updateItems.ts";
+import * as $$$$$$$$$18 from "./actions/cart/updateProfile.ts";
+import * as $$$$$$$$$19 from "./actions/cart/updateUser.ts";
+import * as $$$$$$$$$20 from "./actions/masterdata/createDocument.ts";
+import * as $$$$$$$$$21 from "./actions/masterdata/updateDocument.ts";
+import * as $$$$$$$$$22 from "./actions/newsletter/subscribe.ts";
+import * as $$$$$$$$$23 from "./actions/notifyme.ts";
+import * as $$$$$$$$$24 from "./actions/payments/delete.ts";
+import * as $$$$$$$$$25 from "./actions/profile/newsletterProfile.ts";
+import * as $$$$$$$$$26 from "./actions/profile/updateProfile.ts";
+import * as $$$$$$$$$27 from "./actions/review/submit.ts";
+import * as $$$$$$$$$28 from "./actions/sessions/delete.ts";
+import * as $$$$$$$$$29 from "./actions/trigger.ts";
+import * as $$$$$$$$$30 from "./actions/wishlist/addItem.ts";
+import * as $$$$$$$$$31 from "./actions/wishlist/removeItem.ts";
 import * as $$$$0 from "./handlers/sitemap.ts";
-import * as $$$0 from "./loaders/cart.ts";
-import * as $$$1 from "./loaders/categories/tree.ts";
-import * as $$$2 from "./loaders/collections/list.ts";
-import * as $$$3 from "./loaders/config.ts";
-import * as $$$4 from "./loaders/intelligentSearch/productDetailsPage.ts";
-import * as $$$5 from "./loaders/intelligentSearch/productList.ts";
-import * as $$$6 from "./loaders/intelligentSearch/productListingPage.ts";
-import * as $$$7 from "./loaders/intelligentSearch/productSearchValidator.ts";
-import * as $$$8 from "./loaders/intelligentSearch/suggestions.ts";
-import * as $$$9 from "./loaders/intelligentSearch/topsearches.ts";
-import * as $$$10 from "./loaders/legacy/brands.ts";
-import * as $$$11 from "./loaders/legacy/pageType.ts";
-import * as $$$12 from "./loaders/legacy/productDetailsPage.ts";
-import * as $$$13 from "./loaders/legacy/productList.ts";
-import * as $$$14 from "./loaders/legacy/productListingPage.ts";
-import * as $$$15 from "./loaders/legacy/relatedProductsLoader.ts";
-import * as $$$16 from "./loaders/legacy/suggestions.ts";
-import * as $$$17 from "./loaders/logistics/getSalesChannelById.ts";
-import * as $$$18 from "./loaders/logistics/listPickupPoints.ts";
-import * as $$$19 from "./loaders/logistics/listPickupPointsByLocation.ts";
-import * as $$$20 from "./loaders/logistics/listSalesChannelById.ts";
-import * as $$$21 from "./loaders/logistics/listStockByStore.ts";
-import * as $$$22 from "./loaders/masterdata/searchDocuments.ts";
-import * as $$$23 from "./loaders/navbar.ts";
-import * as $$$24 from "./loaders/options/productIdByTerm.ts";
-import * as $$$25 from "./loaders/orders/list.ts";
-import * as $$$26 from "./loaders/paths/PDPDefaultPath.ts";
-import * as $$$27 from "./loaders/paths/PLPDefaultPath.ts";
-import * as $$$28 from "./loaders/product/extend.ts";
-import * as $$$29 from "./loaders/product/extensions/detailsPage.ts";
-import * as $$$30 from "./loaders/product/extensions/list.ts";
-import * as $$$31 from "./loaders/product/extensions/listingPage.ts";
-import * as $$$32 from "./loaders/product/extensions/suggestions.ts";
-import * as $$$33 from "./loaders/product/wishlist.ts";
-import * as $$$34 from "./loaders/promotion/getPromotionById.ts";
-import * as $$$35 from "./loaders/proxy.ts";
-import * as $$$36 from "./loaders/user.ts";
-import * as $$$37 from "./loaders/wishlist.ts";
-import * as $$$38 from "./loaders/workflow/product.ts";
-import * as $$$39 from "./loaders/workflow/products.ts";
+import * as $$$0 from "./loaders/address/getAddressByZIP.ts";
+import * as $$$1 from "./loaders/address/list.ts";
+import * as $$$2 from "./loaders/cart.ts";
+import * as $$$3 from "./loaders/categories/tree.ts";
+import * as $$$4 from "./loaders/collections/list.ts";
+import * as $$$5 from "./loaders/config.ts";
+import * as $$$6 from "./loaders/intelligentSearch/productDetailsPage.ts";
+import * as $$$7 from "./loaders/intelligentSearch/productList.ts";
+import * as $$$8 from "./loaders/intelligentSearch/productListingPage.ts";
+import * as $$$9 from "./loaders/intelligentSearch/productSearchValidator.ts";
+import * as $$$10 from "./loaders/intelligentSearch/suggestions.ts";
+import * as $$$11 from "./loaders/intelligentSearch/topsearches.ts";
+import * as $$$12 from "./loaders/legacy/brands.ts";
+import * as $$$13 from "./loaders/legacy/pageType.ts";
+import * as $$$14 from "./loaders/legacy/productDetailsPage.ts";
+import * as $$$15 from "./loaders/legacy/productList.ts";
+import * as $$$16 from "./loaders/legacy/productListingPage.ts";
+import * as $$$17 from "./loaders/legacy/relatedProductsLoader.ts";
+import * as $$$18 from "./loaders/legacy/suggestions.ts";
+import * as $$$19 from "./loaders/logistics/getSalesChannelById.ts";
+import * as $$$20 from "./loaders/logistics/listPickupPoints.ts";
+import * as $$$21 from "./loaders/logistics/listPickupPointsByLocation.ts";
+import * as $$$22 from "./loaders/logistics/listSalesChannelById.ts";
+import * as $$$23 from "./loaders/logistics/listStockByStore.ts";
+import * as $$$24 from "./loaders/masterdata/searchDocuments.ts";
+import * as $$$25 from "./loaders/navbar.ts";
+import * as $$$26 from "./loaders/options/productIdByTerm.ts";
+import * as $$$27 from "./loaders/orders/list.ts";
+import * as $$$28 from "./loaders/orders/order.ts";
+import * as $$$29 from "./loaders/paths/PDPDefaultPath.ts";
+import * as $$$30 from "./loaders/paths/PLPDefaultPath.ts";
+import * as $$$31 from "./loaders/payments/info.ts";
+import * as $$$32 from "./loaders/payments/userPayments.ts";
+import * as $$$33 from "./loaders/product/extend.ts";
+import * as $$$34 from "./loaders/product/extensions/detailsPage.ts";
+import * as $$$35 from "./loaders/product/extensions/list.ts";
+import * as $$$36 from "./loaders/product/extensions/listingPage.ts";
+import * as $$$37 from "./loaders/product/extensions/suggestions.ts";
+import * as $$$38 from "./loaders/product/wishlist.ts";
+import * as $$$39 from "./loaders/profile/passwordLastUpdate.ts";
+import * as $$$40 from "./loaders/promotion/getPromotionById.ts";
+import * as $$$41 from "./loaders/proxy.ts";
+import * as $$$42 from "./loaders/sessions/info.ts";
+import * as $$$43 from "./loaders/user.ts";
+import * as $$$44 from "./loaders/wishlist.ts";
+import * as $$$45 from "./loaders/workflow/product.ts";
+import * as $$$46 from "./loaders/workflow/products.ts";
 import * as $$$$$$0 from "./sections/Analytics/Vtex.tsx";
 import * as $$$$$$$$$$0 from "./workflows/events.ts";
 import * as $$$$$$$$$$1 from "./workflows/product/index.ts";
 
 const manifest = {
   "loaders": {
-    "vtex/loaders/cart.ts": $$$0,
-    "vtex/loaders/categories/tree.ts": $$$1,
-    "vtex/loaders/collections/list.ts": $$$2,
-    "vtex/loaders/config.ts": $$$3,
-    "vtex/loaders/intelligentSearch/productDetailsPage.ts": $$$4,
-    "vtex/loaders/intelligentSearch/productList.ts": $$$5,
-    "vtex/loaders/intelligentSearch/productListingPage.ts": $$$6,
-    "vtex/loaders/intelligentSearch/productSearchValidator.ts": $$$7,
-    "vtex/loaders/intelligentSearch/suggestions.ts": $$$8,
-    "vtex/loaders/intelligentSearch/topsearches.ts": $$$9,
-    "vtex/loaders/legacy/brands.ts": $$$10,
-    "vtex/loaders/legacy/pageType.ts": $$$11,
-    "vtex/loaders/legacy/productDetailsPage.ts": $$$12,
-    "vtex/loaders/legacy/productList.ts": $$$13,
-    "vtex/loaders/legacy/productListingPage.ts": $$$14,
-    "vtex/loaders/legacy/relatedProductsLoader.ts": $$$15,
-    "vtex/loaders/legacy/suggestions.ts": $$$16,
-    "vtex/loaders/logistics/getSalesChannelById.ts": $$$17,
-    "vtex/loaders/logistics/listPickupPoints.ts": $$$18,
-    "vtex/loaders/logistics/listPickupPointsByLocation.ts": $$$19,
-    "vtex/loaders/logistics/listSalesChannelById.ts": $$$20,
-    "vtex/loaders/logistics/listStockByStore.ts": $$$21,
-    "vtex/loaders/masterdata/searchDocuments.ts": $$$22,
-    "vtex/loaders/navbar.ts": $$$23,
-    "vtex/loaders/options/productIdByTerm.ts": $$$24,
-    "vtex/loaders/orders/list.ts": $$$25,
-    "vtex/loaders/paths/PDPDefaultPath.ts": $$$26,
-    "vtex/loaders/paths/PLPDefaultPath.ts": $$$27,
-    "vtex/loaders/product/extend.ts": $$$28,
-    "vtex/loaders/product/extensions/detailsPage.ts": $$$29,
-    "vtex/loaders/product/extensions/list.ts": $$$30,
-    "vtex/loaders/product/extensions/listingPage.ts": $$$31,
-    "vtex/loaders/product/extensions/suggestions.ts": $$$32,
-    "vtex/loaders/product/wishlist.ts": $$$33,
-    "vtex/loaders/promotion/getPromotionById.ts": $$$34,
-    "vtex/loaders/proxy.ts": $$$35,
-    "vtex/loaders/user.ts": $$$36,
-    "vtex/loaders/wishlist.ts": $$$37,
-    "vtex/loaders/workflow/product.ts": $$$38,
-    "vtex/loaders/workflow/products.ts": $$$39,
+    "vtex/loaders/address/getAddressByZIP.ts": $$$0,
+    "vtex/loaders/address/list.ts": $$$1,
+    "vtex/loaders/cart.ts": $$$2,
+    "vtex/loaders/categories/tree.ts": $$$3,
+    "vtex/loaders/collections/list.ts": $$$4,
+    "vtex/loaders/config.ts": $$$5,
+    "vtex/loaders/intelligentSearch/productDetailsPage.ts": $$$6,
+    "vtex/loaders/intelligentSearch/productList.ts": $$$7,
+    "vtex/loaders/intelligentSearch/productListingPage.ts": $$$8,
+    "vtex/loaders/intelligentSearch/productSearchValidator.ts": $$$9,
+    "vtex/loaders/intelligentSearch/suggestions.ts": $$$10,
+    "vtex/loaders/intelligentSearch/topsearches.ts": $$$11,
+    "vtex/loaders/legacy/brands.ts": $$$12,
+    "vtex/loaders/legacy/pageType.ts": $$$13,
+    "vtex/loaders/legacy/productDetailsPage.ts": $$$14,
+    "vtex/loaders/legacy/productList.ts": $$$15,
+    "vtex/loaders/legacy/productListingPage.ts": $$$16,
+    "vtex/loaders/legacy/relatedProductsLoader.ts": $$$17,
+    "vtex/loaders/legacy/suggestions.ts": $$$18,
+    "vtex/loaders/logistics/getSalesChannelById.ts": $$$19,
+    "vtex/loaders/logistics/listPickupPoints.ts": $$$20,
+    "vtex/loaders/logistics/listPickupPointsByLocation.ts": $$$21,
+    "vtex/loaders/logistics/listSalesChannelById.ts": $$$22,
+    "vtex/loaders/logistics/listStockByStore.ts": $$$23,
+    "vtex/loaders/masterdata/searchDocuments.ts": $$$24,
+    "vtex/loaders/navbar.ts": $$$25,
+    "vtex/loaders/options/productIdByTerm.ts": $$$26,
+    "vtex/loaders/orders/list.ts": $$$27,
+    "vtex/loaders/orders/order.ts": $$$28,
+    "vtex/loaders/paths/PDPDefaultPath.ts": $$$29,
+    "vtex/loaders/paths/PLPDefaultPath.ts": $$$30,
+    "vtex/loaders/payments/info.ts": $$$31,
+    "vtex/loaders/payments/userPayments.ts": $$$32,
+    "vtex/loaders/product/extend.ts": $$$33,
+    "vtex/loaders/product/extensions/detailsPage.ts": $$$34,
+    "vtex/loaders/product/extensions/list.ts": $$$35,
+    "vtex/loaders/product/extensions/listingPage.ts": $$$36,
+    "vtex/loaders/product/extensions/suggestions.ts": $$$37,
+    "vtex/loaders/product/wishlist.ts": $$$38,
+    "vtex/loaders/profile/passwordLastUpdate.ts": $$$39,
+    "vtex/loaders/promotion/getPromotionById.ts": $$$40,
+    "vtex/loaders/proxy.ts": $$$41,
+    "vtex/loaders/sessions/info.ts": $$$42,
+    "vtex/loaders/user.ts": $$$43,
+    "vtex/loaders/wishlist.ts": $$$44,
+    "vtex/loaders/workflow/product.ts": $$$45,
+    "vtex/loaders/workflow/products.ts": $$$46,
   },
   "handlers": {
     "vtex/handlers/sitemap.ts": $$$$0,
@@ -122,31 +143,38 @@ const manifest = {
     "vtex/sections/Analytics/Vtex.tsx": $$$$$$0,
   },
   "actions": {
-    "vtex/actions/analytics/sendEvent.ts": $$$$$$$$$0,
-    "vtex/actions/cart/addItems.ts": $$$$$$$$$1,
-    "vtex/actions/cart/addOfferings.ts": $$$$$$$$$2,
-    "vtex/actions/cart/clearOrderformMessages.ts": $$$$$$$$$3,
-    "vtex/actions/cart/getInstallment.ts": $$$$$$$$$4,
-    "vtex/actions/cart/removeItemAttachment.ts": $$$$$$$$$5,
-    "vtex/actions/cart/removeItems.ts": $$$$$$$$$6,
-    "vtex/actions/cart/removeOffering.ts": $$$$$$$$$7,
-    "vtex/actions/cart/simulation.ts": $$$$$$$$$8,
-    "vtex/actions/cart/updateAttachment.ts": $$$$$$$$$9,
-    "vtex/actions/cart/updateCoupons.ts": $$$$$$$$$10,
-    "vtex/actions/cart/updateGifts.ts": $$$$$$$$$11,
-    "vtex/actions/cart/updateItemAttachment.ts": $$$$$$$$$12,
-    "vtex/actions/cart/updateItemPrice.ts": $$$$$$$$$13,
-    "vtex/actions/cart/updateItems.ts": $$$$$$$$$14,
-    "vtex/actions/cart/updateProfile.ts": $$$$$$$$$15,
-    "vtex/actions/cart/updateUser.ts": $$$$$$$$$16,
-    "vtex/actions/masterdata/createDocument.ts": $$$$$$$$$17,
-    "vtex/actions/masterdata/updateDocument.ts": $$$$$$$$$18,
-    "vtex/actions/newsletter/subscribe.ts": $$$$$$$$$19,
-    "vtex/actions/notifyme.ts": $$$$$$$$$20,
-    "vtex/actions/review/submit.ts": $$$$$$$$$21,
-    "vtex/actions/trigger.ts": $$$$$$$$$22,
-    "vtex/actions/wishlist/addItem.ts": $$$$$$$$$23,
-    "vtex/actions/wishlist/removeItem.ts": $$$$$$$$$24,
+    "vtex/actions/address/createAddress.ts": $$$$$$$$$0,
+    "vtex/actions/address/deleteAddress.ts": $$$$$$$$$1,
+    "vtex/actions/address/updateAddress.ts": $$$$$$$$$2,
+    "vtex/actions/analytics/sendEvent.ts": $$$$$$$$$3,
+    "vtex/actions/cart/addItems.ts": $$$$$$$$$4,
+    "vtex/actions/cart/addOfferings.ts": $$$$$$$$$5,
+    "vtex/actions/cart/clearOrderformMessages.ts": $$$$$$$$$6,
+    "vtex/actions/cart/getInstallment.ts": $$$$$$$$$7,
+    "vtex/actions/cart/removeItemAttachment.ts": $$$$$$$$$8,
+    "vtex/actions/cart/removeItems.ts": $$$$$$$$$9,
+    "vtex/actions/cart/removeOffering.ts": $$$$$$$$$10,
+    "vtex/actions/cart/simulation.ts": $$$$$$$$$11,
+    "vtex/actions/cart/updateAttachment.ts": $$$$$$$$$12,
+    "vtex/actions/cart/updateCoupons.ts": $$$$$$$$$13,
+    "vtex/actions/cart/updateGifts.ts": $$$$$$$$$14,
+    "vtex/actions/cart/updateItemAttachment.ts": $$$$$$$$$15,
+    "vtex/actions/cart/updateItemPrice.ts": $$$$$$$$$16,
+    "vtex/actions/cart/updateItems.ts": $$$$$$$$$17,
+    "vtex/actions/cart/updateProfile.ts": $$$$$$$$$18,
+    "vtex/actions/cart/updateUser.ts": $$$$$$$$$19,
+    "vtex/actions/masterdata/createDocument.ts": $$$$$$$$$20,
+    "vtex/actions/masterdata/updateDocument.ts": $$$$$$$$$21,
+    "vtex/actions/newsletter/subscribe.ts": $$$$$$$$$22,
+    "vtex/actions/notifyme.ts": $$$$$$$$$23,
+    "vtex/actions/payments/delete.ts": $$$$$$$$$24,
+    "vtex/actions/profile/newsletterProfile.ts": $$$$$$$$$25,
+    "vtex/actions/profile/updateProfile.ts": $$$$$$$$$26,
+    "vtex/actions/review/submit.ts": $$$$$$$$$27,
+    "vtex/actions/sessions/delete.ts": $$$$$$$$$28,
+    "vtex/actions/trigger.ts": $$$$$$$$$29,
+    "vtex/actions/wishlist/addItem.ts": $$$$$$$$$30,
+    "vtex/actions/wishlist/removeItem.ts": $$$$$$$$$31,
   },
   "workflows": {
     "vtex/workflows/events.ts": $$$$$$$$$$0,
diff --git a/vtex/utils/client.ts b/vtex/utils/client.ts
index 7fb63b193..6794f41e7 100644
--- a/vtex/utils/client.ts
+++ b/vtex/utils/client.ts
@@ -9,6 +9,7 @@ import {
   LegacyProduct,
   LegacySort,
   OrderForm,
+  OrderItem,
   PageType,
   PortalSuggestion,
   ProductSearchResult,
@@ -248,6 +249,9 @@ export interface VTEXCommerceStable {
   "GET /api/oms/user/orders": {
     response: Userorderslist;
   };
+  "GET /api/oms/user/orders/:orderId": {
+    response: OrderItem;
+  };
 }
 
 export interface SP {
diff --git a/vtex/utils/types.ts b/vtex/utils/types.ts
index 89b86ec21..a433c6bdb 100644
--- a/vtex/utils/types.ts
+++ b/vtex/utils/types.ts
@@ -62,11 +62,12 @@ export interface ClientProfileData {
 
 export interface ClientPreferencesData {
   locale: string;
-  optinNewsLetter: null;
+  optinNewsLetter: boolean;
 }
 
 export interface ItemMetadata {
-  items: ItemMetadataItem[];
+  items?: ItemMetadataItem[];
+  Items?: ItemMetadataItemUppercase[];
 }
 
 export interface ItemMetadataItem {
@@ -82,6 +83,19 @@ export interface ItemMetadataItem {
   assemblyOptions: AssemblyOption[];
 }
 
+export interface ItemMetadataItemUppercase {
+  Id: string;
+  Seller: string;
+  Name: string;
+  SkuName: string;
+  ProductId: string;
+  RefId: string;
+  Ean: null | string;
+  ImageUrl: string;
+  DetailUrl: string;
+  AssemblyOptions: AssemblyOption[];
+}
+
 export interface AssemblyOption {
   id: Name;
   name: Name;
@@ -259,11 +273,43 @@ export interface Fields {
   skuName?: string;
 }
 
+export interface Transaction {
+  isActive: boolean;
+  transactionId: string;
+  merchantName: string;
+  payments: Payment[];
+}
+
+export interface Payment {
+  id: string;
+  paymentSystem: string;
+  paymentSystemName: string;
+  value: number;
+  installments: number;
+  referenceValue: number;
+  cardHolder: string | null;
+  cardNumber: string | null;
+  firstDigits: string | null;
+  lastDigits: string | null;
+  cvv2: string | null;
+  expireMonth: string | null;
+  expireYear: string | null;
+  url: string;
+  giftCardId: null;
+  giftCardName: null;
+  giftCardCaption: null;
+  redemptionCode: null;
+  group: string;
+  tid: null;
+  dueDate: Date;
+}
+
 export interface PaymentData {
   updateStatus: string;
   installmentOptions: InstallmentOption[];
   paymentSystems: PaymentSystem[];
   payments: unknown[];
+  transactions: Transaction[];
   giftCards: unknown[];
   giftCardMessages: unknown[];
   availableAccounts: unknown[];
@@ -364,7 +410,8 @@ export interface ShippingData {
 
 export interface Address {
   addressType: string;
-  receiverName: null;
+  addressName: string;
+  receiverName: string | null;
   addressId: string;
   isDisposable: boolean;
   postalCode: string;
@@ -382,8 +429,16 @@ export interface Address {
 export interface LogisticsInfo {
   itemIndex: number;
   selectedSla: SelectedSla | null;
+  price: number;
+  listPrice: number;
+  sellingPrice: number;
+  deliveryCompany: string;
+  shippingEstimate: string;
+  shippingEstimateDate: string;
   selectedDeliveryChannel: SelectedDeliveryChannel;
   addressId: string;
+  pickupPointId: string;
+  pickupStoreInfo: PickupStoreInfo;
   slas: Sla[];
   shipsTo: string[];
   itemId: string;
@@ -1291,6 +1346,7 @@ export interface Order {
   invoiceOutput: string[];
   isAllDelivered: boolean;
   isAnyDelivered: boolean;
+  itemMetadata: ItemMetadata;
   items: OrderFormItem[];
   lastChange: string;
   lastMessageUnread: string;
@@ -1313,6 +1369,103 @@ export interface Order {
   workflowInRetry: boolean;
 }
 
+export interface OrderItem {
+  orderId: string;
+  sequence: string;
+  origin: string;
+  sellerOrderId: string;
+  salesChannel: string;
+  affiliateId: string;
+  workflowIsInError: boolean;
+  orderGroup: string;
+  status: string;
+  statusDescription: string;
+  value: number;
+  allowCancellation: boolean;
+  allowEdition?: boolean;
+  authorizedDate: string;
+  callCenterOperatorData: string;
+  cancelReason: string;
+  cancellationData: {
+    RequestedByUser: boolean;
+    RequestedBySystem: boolean;
+    RequestedBySellerNotification: boolean;
+    RequestedByPaymentNotification: boolean;
+    Reason: string;
+    CancellationDate: string;
+  };
+  cancellationRequests?: {
+    id: string;
+    reason: string;
+    cancellationRequestDate: string;
+    requestedByUser: boolean;
+    deniedBySeller: boolean;
+    deniedBySellerReason: string | null;
+    cancellationRequestDenyDate: string | null;
+  }[] | null;
+  changesAttachment: string;
+  checkedInPickupPointId: string | null;
+  paymentData: PaymentData;
+  shippingData: ShippingData;
+  clientPreferencesData: ClientPreferencesData;
+  clientProfileData: ClientProfileData;
+  totals: Total[];
+  commercialConditionData?: string | null;
+  creationDate: string;
+  // deno-lint-ignore no-explicit-any
+  customData?: Record<string, any> | null;
+  followUpEmail?: string;
+  giftRegistryData?: GiftRegistry | null;
+  hostname: string;
+  invoiceData: string | null;
+  invoicedDate: string | null;
+  isCheckedIn: boolean;
+  isCompleted: boolean;
+  sellers?: {
+    id: string;
+    name: string;
+    logo: string;
+    fulfillmentEndpoint: string;
+  }[];
+  itemMetadata: ItemMetadata;
+  items: OrderFormItem[];
+  lastChange: string;
+  lastMessage: string;
+  marketingData: OrderFormMarketingData | null;
+  marketplace: Marketplace;
+  marketplaceItems: [];
+  marketplaceOrderId: string;
+  marketplaceServicesEndpoint: string;
+  merchantName: string;
+  openTextField: string | null;
+}
+
+interface Marketplace {
+  baseURL: string;
+  // deno-lint-ignore no-explicit-any
+  isCertified?: any | null;
+  name: string;
+}
+
+interface OrderFormMarketingData {
+  utmCampaign?: string;
+  utmMedium?: string;
+  utmSource?: string;
+  utmiCampaign?: string;
+  utmiPart?: string;
+  utmipage?: string;
+  marketingTags?: string | string[];
+}
+
+interface GiftRegistry {
+  attachmentId: string;
+  giftRegistryId: string;
+  giftRegistryType: string;
+  giftRegistryTypeName: string;
+  addressId: string;
+  description: string;
+}
+
 export interface Orders {
   facets: Facet[];
   list: Order[];

From c416e5a01fde9f4a959710895f7d33090ca407c1 Mon Sep 17 00:00:00 2001
From: "@yuri_assuncx" <killerkoll2012@gmail.com>
Date: Mon, 28 Oct 2024 13:52:04 -0300
Subject: [PATCH 05/93] [VTEX] Feat: add new types and cancel order action
 (#945)

---
 vtex/actions/orders/cancel.ts | 43 +++++++++++++++++++++++++++++++++++
 vtex/manifest.gen.ts          | 34 ++++++++++++++-------------
 vtex/utils/client.ts          |  7 ++++++
 vtex/utils/types.ts           | 27 ++++++++++++++++++++++
 4 files changed, 95 insertions(+), 16 deletions(-)
 create mode 100644 vtex/actions/orders/cancel.ts

diff --git a/vtex/actions/orders/cancel.ts b/vtex/actions/orders/cancel.ts
new file mode 100644
index 000000000..c6dfa38d1
--- /dev/null
+++ b/vtex/actions/orders/cancel.ts
@@ -0,0 +1,43 @@
+import { parseCookie } from "../../utils/vtexId.ts";
+import { AppContext } from "../../mod.ts";
+import { CanceledOrder } from "../../utils/types.ts";
+
+interface Props {
+  orderId: string;
+  reason: string;
+}
+
+async function action(
+  props: Props,
+  req: Request,
+  ctx: AppContext,
+): Promise<CanceledOrder | null> {
+  const { vcsDeprecated } = ctx;
+  const { cookie, payload } = parseCookie(req.headers, ctx.account);
+
+  if (!payload?.sub || !payload?.userId) {
+    return null;
+  }
+
+  const { orderId, reason } = props;
+
+  const response = await vcsDeprecated
+    ["POST /api/oms/user/orders/:orderId/cancel"](
+      { orderId },
+      {
+        body: { reason },
+        headers: {
+          cookie,
+        },
+      },
+    );
+
+  if (response.ok) {
+    const canceledOrder = await response.json();
+    return canceledOrder;
+  }
+
+  return null;
+}
+
+export default action;
diff --git a/vtex/manifest.gen.ts b/vtex/manifest.gen.ts
index f80a3c0c9..7a1b1e417 100644
--- a/vtex/manifest.gen.ts
+++ b/vtex/manifest.gen.ts
@@ -26,14 +26,15 @@ import * as $$$$$$$$$20 from "./actions/masterdata/createDocument.ts";
 import * as $$$$$$$$$21 from "./actions/masterdata/updateDocument.ts";
 import * as $$$$$$$$$22 from "./actions/newsletter/subscribe.ts";
 import * as $$$$$$$$$23 from "./actions/notifyme.ts";
-import * as $$$$$$$$$24 from "./actions/payments/delete.ts";
-import * as $$$$$$$$$25 from "./actions/profile/newsletterProfile.ts";
-import * as $$$$$$$$$26 from "./actions/profile/updateProfile.ts";
-import * as $$$$$$$$$27 from "./actions/review/submit.ts";
-import * as $$$$$$$$$28 from "./actions/sessions/delete.ts";
-import * as $$$$$$$$$29 from "./actions/trigger.ts";
-import * as $$$$$$$$$30 from "./actions/wishlist/addItem.ts";
-import * as $$$$$$$$$31 from "./actions/wishlist/removeItem.ts";
+import * as $$$$$$$$$24 from "./actions/orders/cancel.ts";
+import * as $$$$$$$$$25 from "./actions/payments/delete.ts";
+import * as $$$$$$$$$26 from "./actions/profile/newsletterProfile.ts";
+import * as $$$$$$$$$27 from "./actions/profile/updateProfile.ts";
+import * as $$$$$$$$$28 from "./actions/review/submit.ts";
+import * as $$$$$$$$$29 from "./actions/sessions/delete.ts";
+import * as $$$$$$$$$30 from "./actions/trigger.ts";
+import * as $$$$$$$$$31 from "./actions/wishlist/addItem.ts";
+import * as $$$$$$$$$32 from "./actions/wishlist/removeItem.ts";
 import * as $$$$0 from "./handlers/sitemap.ts";
 import * as $$$0 from "./loaders/address/getAddressByZIP.ts";
 import * as $$$1 from "./loaders/address/list.ts";
@@ -167,14 +168,15 @@ const manifest = {
     "vtex/actions/masterdata/updateDocument.ts": $$$$$$$$$21,
     "vtex/actions/newsletter/subscribe.ts": $$$$$$$$$22,
     "vtex/actions/notifyme.ts": $$$$$$$$$23,
-    "vtex/actions/payments/delete.ts": $$$$$$$$$24,
-    "vtex/actions/profile/newsletterProfile.ts": $$$$$$$$$25,
-    "vtex/actions/profile/updateProfile.ts": $$$$$$$$$26,
-    "vtex/actions/review/submit.ts": $$$$$$$$$27,
-    "vtex/actions/sessions/delete.ts": $$$$$$$$$28,
-    "vtex/actions/trigger.ts": $$$$$$$$$29,
-    "vtex/actions/wishlist/addItem.ts": $$$$$$$$$30,
-    "vtex/actions/wishlist/removeItem.ts": $$$$$$$$$31,
+    "vtex/actions/orders/cancel.ts": $$$$$$$$$24,
+    "vtex/actions/payments/delete.ts": $$$$$$$$$25,
+    "vtex/actions/profile/newsletterProfile.ts": $$$$$$$$$26,
+    "vtex/actions/profile/updateProfile.ts": $$$$$$$$$27,
+    "vtex/actions/review/submit.ts": $$$$$$$$$28,
+    "vtex/actions/sessions/delete.ts": $$$$$$$$$29,
+    "vtex/actions/trigger.ts": $$$$$$$$$30,
+    "vtex/actions/wishlist/addItem.ts": $$$$$$$$$31,
+    "vtex/actions/wishlist/removeItem.ts": $$$$$$$$$32,
   },
   "workflows": {
     "vtex/workflows/events.ts": $$$$$$$$$$0,
diff --git a/vtex/utils/client.ts b/vtex/utils/client.ts
index 6794f41e7..0f1feb091 100644
--- a/vtex/utils/client.ts
+++ b/vtex/utils/client.ts
@@ -1,6 +1,7 @@
 import { Userorderslist } from "./openapi/vcs.openapi.gen.ts";
 import {
   Brand,
+  CanceledOrder,
   Category,
   CreateNewDocument,
   FacetSearchResult,
@@ -252,6 +253,12 @@ export interface VTEXCommerceStable {
   "GET /api/oms/user/orders/:orderId": {
     response: OrderItem;
   };
+  "POST /api/oms/user/orders/:orderId/cancel": {
+    response: CanceledOrder;
+    body: {
+      reason: string;
+    };
+  };
 }
 
 export interface SP {
diff --git a/vtex/utils/types.ts b/vtex/utils/types.ts
index a433c6bdb..2097514bb 100644
--- a/vtex/utils/types.ts
+++ b/vtex/utils/types.ts
@@ -1369,6 +1369,24 @@ export interface Order {
   workflowInRetry: boolean;
 }
 
+export interface Package {
+  cfop: string | null;
+  invoiceNumber: string;
+  invoiceValue: number;
+  invoiceUrl: string | null;
+  issuanceDate: string;
+  trackingNumber: string | null;
+  invoiceKey: string;
+  trackingUrl: string | null;
+  embeddedInvoice: string;
+  courierStatus: {
+    status: string | null;
+    finished: boolean;
+    deliveredDate: string;
+  };
+  type: "Input" | "Output";
+}
+
 export interface OrderItem {
   orderId: string;
   sequence: string;
@@ -1386,6 +1404,9 @@ export interface OrderItem {
   authorizedDate: string;
   callCenterOperatorData: string;
   cancelReason: string;
+  packageAttachment: {
+    packages: Package[];
+  } | null;
   cancellationData: {
     RequestedByUser: boolean;
     RequestedBySystem: boolean;
@@ -1440,6 +1461,12 @@ export interface OrderItem {
   openTextField: string | null;
 }
 
+export interface CanceledOrder {
+  date: string;
+  orderId: string;
+  receipt: string | null;
+}
+
 interface Marketplace {
   baseURL: string;
   // deno-lint-ignore no-explicit-any

From 037d02722922e61627710926aec97df733ae3459 Mon Sep 17 00:00:00 2001
From: guitavano <tavano62@gmail.com>
Date: Mon, 28 Oct 2024 22:53:56 -0300
Subject: [PATCH 06/93] fix brand canonical

---
 vtex/utils/legacy.ts | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/vtex/utils/legacy.ts b/vtex/utils/legacy.ts
index 759964974..ef12d5b5e 100644
--- a/vtex/utils/legacy.ts
+++ b/vtex/utils/legacy.ts
@@ -136,7 +136,8 @@ export const pageTypesToSeo = (
     noIndexing: hasMapTermOrSkuId,
     canonical: toCanonical(
       new URL(
-        (current.url && current.pageType !== "Collection")
+        (current.url && current.pageType !== "Collection" &&
+            current.pageType !== "Brand")
           ? current.url.replace(/.+\.vtexcommercestable\.com\.br/, "")
             .toLowerCase()
           : url,

From 3fa4be9944414385a43118862859d0849b334220 Mon Sep 17 00:00:00 2001
From: marcoferreiradev <mw.marcowilliam@gmail.com>
Date: Tue, 29 Oct 2024 15:08:12 -0300
Subject: [PATCH 07/93] fix: change product cancellation route

---
 vtex/actions/orders/cancel.ts | 2 +-
 vtex/utils/client.ts          | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/vtex/actions/orders/cancel.ts b/vtex/actions/orders/cancel.ts
index c6dfa38d1..6f1982370 100644
--- a/vtex/actions/orders/cancel.ts
+++ b/vtex/actions/orders/cancel.ts
@@ -22,7 +22,7 @@ async function action(
   const { orderId, reason } = props;
 
   const response = await vcsDeprecated
-    ["POST /api/oms/user/orders/:orderId/cancel"](
+    ["POST /api/oms/pvt/orders/:orderId/cancel"](
       { orderId },
       {
         body: { reason },
diff --git a/vtex/utils/client.ts b/vtex/utils/client.ts
index 0f1feb091..f2546079e 100644
--- a/vtex/utils/client.ts
+++ b/vtex/utils/client.ts
@@ -253,7 +253,7 @@ export interface VTEXCommerceStable {
   "GET /api/oms/user/orders/:orderId": {
     response: OrderItem;
   };
-  "POST /api/oms/user/orders/:orderId/cancel": {
+  "POST /api/oms/pvt/orders/:orderId/cancel": {
     response: CanceledOrder;
     body: {
       reason: string;

From db7c3ca46a7e8683082cad31b402194db97bfbe7 Mon Sep 17 00:00:00 2001
From: guitavano <tavano62@gmail.com>
Date: Wed, 30 Oct 2024 03:14:24 -0300
Subject: [PATCH 08/93] add brand to breadcrumb

---
 vtex/utils/legacy.ts | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/vtex/utils/legacy.ts b/vtex/utils/legacy.ts
index ef12d5b5e..79dab88cc 100644
--- a/vtex/utils/legacy.ts
+++ b/vtex/utils/legacy.ts
@@ -84,10 +84,11 @@ export const pageTypesToBreadcrumbList = (
   pages: PageType[],
   baseUrl: string,
 ) => {
+  console.log({ pages });
   const filteredPages = pages
     .filter(({ pageType }) =>
       pageType === "Category" || pageType === "Department" ||
-      pageType === "SubCategory"
+      pageType === "SubCategory" || pageType === "Brand"
     );
 
   return filteredPages.map((page, index) => {

From 00dc0ae1a90f80acf9ce57b9348515453f0a7338 Mon Sep 17 00:00:00 2001
From: guitavano <tavano62@gmail.com>
Date: Wed, 30 Oct 2024 03:29:51 -0300
Subject: [PATCH 09/93] remove console log

---
 vtex/utils/legacy.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/vtex/utils/legacy.ts b/vtex/utils/legacy.ts
index 79dab88cc..07e832b2b 100644
--- a/vtex/utils/legacy.ts
+++ b/vtex/utils/legacy.ts
@@ -84,7 +84,7 @@ export const pageTypesToBreadcrumbList = (
   pages: PageType[],
   baseUrl: string,
 ) => {
-  console.log({ pages });
+
   const filteredPages = pages
     .filter(({ pageType }) =>
       pageType === "Category" || pageType === "Department" ||

From 03d781a930dcad7cde03613111f38d7d3d8af914 Mon Sep 17 00:00:00 2001
From: guitavano <tavano62@gmail.com>
Date: Wed, 30 Oct 2024 06:33:02 -0300
Subject: [PATCH 10/93] fix orderPlaced page

---
 vtex/loaders/orders/order.ts | 12 ++++--------
 1 file changed, 4 insertions(+), 8 deletions(-)

diff --git a/vtex/loaders/orders/order.ts b/vtex/loaders/orders/order.ts
index 2b4501206..cebadf0d9 100644
--- a/vtex/loaders/orders/order.ts
+++ b/vtex/loaders/orders/order.ts
@@ -12,17 +12,13 @@ export default async function loader(
   req: Request,
   ctx: AppContext,
 ): Promise<OrderItem | null> {
-  const { vcsDeprecated } = ctx;
-  const { cookie, payload } = parseCookie(req.headers, ctx.account);
-
-  if (!payload?.sub || !payload?.userId) {
-    return null;
-  }
+  const { vcs } = ctx;
+  const { cookie } = parseCookie(req.headers, ctx.account);
 
   const { slug } = props;
 
-  const response = await vcsDeprecated["GET /api/oms/user/orders/:orderId"](
-    { orderId: slug },
+  const response = await vcs["GET /api/oms/user/orders/:orderId"](
+    { orderId: slug + "-01" },
     {
       headers: {
         cookie,

From 6cda6cf0f6f7a69a370bb056fd12487d13506c29 Mon Sep 17 00:00:00 2001
From: guitavano <tavano62@gmail.com>
Date: Wed, 30 Oct 2024 06:42:40 -0300
Subject: [PATCH 11/93] fixfixfix

---
 vtex/loaders/orders/order.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/vtex/loaders/orders/order.ts b/vtex/loaders/orders/order.ts
index cebadf0d9..0cc1e1cac 100644
--- a/vtex/loaders/orders/order.ts
+++ b/vtex/loaders/orders/order.ts
@@ -18,7 +18,7 @@ export default async function loader(
   const { slug } = props;
 
   const response = await vcs["GET /api/oms/user/orders/:orderId"](
-    { orderId: slug + "-01" },
+    { orderId: slug.includes("-") ? slug : slug + "-01" },
     {
       headers: {
         cookie,

From 37badd6d5f821b204ad5a85ec2ddfb32fe39182d Mon Sep 17 00:00:00 2001
From: guitavano <tavano62@gmail.com>
Date: Thu, 31 Oct 2024 12:06:51 -0300
Subject: [PATCH 12/93] improve cache

---
 power-reviews/loaders/productDetailsPage.ts | 2 ++
 power-reviews/loaders/productListingPage.ts | 2 ++
 vtex/loaders/config.ts                      | 2 ++
 vtex/loaders/logistics/listPickupPoints.ts  | 2 ++
 4 files changed, 8 insertions(+)

diff --git a/power-reviews/loaders/productDetailsPage.ts b/power-reviews/loaders/productDetailsPage.ts
index 406f7c658..1b01c75d2 100644
--- a/power-reviews/loaders/productDetailsPage.ts
+++ b/power-reviews/loaders/productDetailsPage.ts
@@ -78,3 +78,5 @@ export default function productDetailsPage(
     };
   };
 }
+
+export const cache = "no-cache";
\ No newline at end of file
diff --git a/power-reviews/loaders/productListingPage.ts b/power-reviews/loaders/productListingPage.ts
index 12941e798..f914118a1 100644
--- a/power-reviews/loaders/productListingPage.ts
+++ b/power-reviews/loaders/productListingPage.ts
@@ -81,3 +81,5 @@ export default function productListingPage(
     };
   };
 }
+
+export const cache = "no-cache";
diff --git a/vtex/loaders/config.ts b/vtex/loaders/config.ts
index eb1083fba..25f7214f8 100644
--- a/vtex/loaders/config.ts
+++ b/vtex/loaders/config.ts
@@ -23,3 +23,5 @@ const loader = (_props: unknown, _req: Request, ctx: AppContext): Config => ({
 });
 
 export default loader;
+
+export const cache = "no-cache";
\ No newline at end of file
diff --git a/vtex/loaders/logistics/listPickupPoints.ts b/vtex/loaders/logistics/listPickupPoints.ts
index 7c06bc3ae..9d63b7a57 100644
--- a/vtex/loaders/logistics/listPickupPoints.ts
+++ b/vtex/loaders/logistics/listPickupPoints.ts
@@ -15,3 +15,5 @@ export default async function loader(
 
   return pickupPoints.map((pickup) => toPlace(pickup));
 }
+
+export const cache = "stale-while-revalidate";
\ No newline at end of file

From 55b639a60603eec6f8c37b922a7ee32d63d29253 Mon Sep 17 00:00:00 2001
From: marcoferreiradev <mw.marcowilliam@gmail.com>
Date: Thu, 31 Oct 2024 17:27:15 -0300
Subject: [PATCH 13/93] fix: add new type

---
 power-reviews/loaders/productDetailsPage.ts |    2 +-
 vtex/loaders/config.ts                      |    2 +-
 vtex/loaders/logistics/listPickupPoints.ts  |    2 +-
 vtex/utils/legacy.ts                        |    1 -
 vtex/utils/openapi/vcs.openapi.gen.ts       | 7683 ++++++++++---------
 vtex/utils/types.ts                         |    6 +
 6 files changed, 3910 insertions(+), 3786 deletions(-)

diff --git a/power-reviews/loaders/productDetailsPage.ts b/power-reviews/loaders/productDetailsPage.ts
index 1b01c75d2..0e05e61d6 100644
--- a/power-reviews/loaders/productDetailsPage.ts
+++ b/power-reviews/loaders/productDetailsPage.ts
@@ -79,4 +79,4 @@ export default function productDetailsPage(
   };
 }
 
-export const cache = "no-cache";
\ No newline at end of file
+export const cache = "no-cache";
diff --git a/vtex/loaders/config.ts b/vtex/loaders/config.ts
index 25f7214f8..2c9daa378 100644
--- a/vtex/loaders/config.ts
+++ b/vtex/loaders/config.ts
@@ -24,4 +24,4 @@ const loader = (_props: unknown, _req: Request, ctx: AppContext): Config => ({
 
 export default loader;
 
-export const cache = "no-cache";
\ No newline at end of file
+export const cache = "no-cache";
diff --git a/vtex/loaders/logistics/listPickupPoints.ts b/vtex/loaders/logistics/listPickupPoints.ts
index 9d63b7a57..5f31804e2 100644
--- a/vtex/loaders/logistics/listPickupPoints.ts
+++ b/vtex/loaders/logistics/listPickupPoints.ts
@@ -16,4 +16,4 @@ export default async function loader(
   return pickupPoints.map((pickup) => toPlace(pickup));
 }
 
-export const cache = "stale-while-revalidate";
\ No newline at end of file
+export const cache = "stale-while-revalidate";
diff --git a/vtex/utils/legacy.ts b/vtex/utils/legacy.ts
index 07e832b2b..9b66cfcdc 100644
--- a/vtex/utils/legacy.ts
+++ b/vtex/utils/legacy.ts
@@ -84,7 +84,6 @@ export const pageTypesToBreadcrumbList = (
   pages: PageType[],
   baseUrl: string,
 ) => {
-
   const filteredPages = pages
     .filter(({ pageType }) =>
       pageType === "Category" || pageType === "Department" ||
diff --git a/vtex/utils/openapi/vcs.openapi.gen.ts b/vtex/utils/openapi/vcs.openapi.gen.ts
index c870b409d..6d0166fd6 100644
--- a/vtex/utils/openapi/vcs.openapi.gen.ts
+++ b/vtex/utils/openapi/vcs.openapi.gen.ts
@@ -7,6 +7,8 @@
 // To generate this file: deno task start
 //        
 
+import { OrderItem } from "../types.ts";
+
 
 export type SkuComplement = {
 /**
@@ -65,19 +67,22 @@ export type SavePersonalData = boolean
 export type OptinNewsLetter = boolean
 
 export interface OpenAPI {
+  "GET /api/oms/user/orders/:orderId": {
+    response: OrderItem;
+  };
 /**
- * Retrieves a specific promotion by its Promotion ID or a specific tax by its tax ID.
- * 
- * ## Permissions
- * 
- * Any user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Rates and Benefits | Manage benefits and rates | **GerenciarPromocoesETarifas** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * Retrieves a specific promotion by its Promotion ID or a specific tax by its tax ID.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Rates and Benefits | Manage benefits and rates | **GerenciarPromocoesETarifas** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "GET /api/rnb/pvt/calculatorconfiguration/:idCalculatorConfiguration": {
@@ -651,83 +656,135 @@ percentualDiscountValueList?: number[]
 }
 }
 /**
- * Searches Master Data v1 documents with highly customizable filters.
- * 
- * > Learn more about [Master Data v1 search queries](https://developers.vtex.com/vtex-rest-api/docs/how-the-queries-in-master-data-v1-work).
- * 
- * ## Query Examples
- * 
- * 
- * ### Simple filter
- * 
- * ```
- * /dataentities/CL/search?email=my@email.com
- * ```
- * 
- * ### Complex filter
- * 
- * ```
- * /dataentities/CL/search?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)
- * ```
- * 
- * ### Filter by range
- * 
- * #### Date Range
- * 
- * ```
- * /dataentities/CL/search?_where=createdIn between 2001-01-01 AND 2016-01-01
- * ```
- * 
- * #### Range numeric fields
- * 
- * ```
- * /dataentities/CL/search?_where=age between 18 AND 25
- * ```
- * 
- * ### Partial filter
- * 
- * ```
- * /dataentities/CL/search?firstName=*Maria*
- * ```
- * 
- * ### Filter for null values
- * 
- * ```
- * /dataentities/CL/search?_where=firstName is null
- * ```
- * 
- * ### Filter for non-null values
- * 
- * ```
- * /dataentities/CL/search?_where=firstName is not null
- * ```
- * 
- * ### Filter for difference
- * ```
- * /dataentities/CL/search?_where=firstName<>maria
- * ```
- * 
- * ### Filter greater than or less than
- * ```
- * /dataentities/CL/search?_where=number>5
- * /dataentities/CL/search?_where=date<2001-01-01
+ * Searches Master Data v1 documents with highly customizable filters.
+ * 
+ * > Learn more about [Master Data v1 search queries](https://developers.vtex.com/vtex-rest-api/docs/how-the-queries-in-master-data-v1-work).
+ * 
+ * ## Query Examples
+ * 
+ * 
+ * ### Simple filter
+ * 
+ * ```
+ * /dataentities/CL/search?email=my@email.com
+ * ```
+ * 
+ * ### Complex filter
+ * 
+ * ```
+ * /dataentities/CL/search?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)
+ * ```
+ * 
+ * ### Filter by range
+ * 
+ * #### Date Range
+ * 
+ * ```
+ * /dataentities/CL/search?_where=createdIn between 2001-01-01 AND 2016-01-01
  * ```
- * 
- * 
> Avoid sending too many requests with wildcards (`*`) in the search parameters or that use the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens you will receive an error with status code `503`. 
- * 
- * ## Permissions
- * 
- * Any user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Dynamic Storage | Dynamic storage generic resources | **Read only documents** |
- * | Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |
- * | Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |
- * | Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 
+ * #### Range numeric fields
+ * 
+ * ```
+ * /dataentities/CL/search?_where=age between 18 AND 25
+ * ```
+ * 
+ * ### Partial filter
+ * 
+ * ```
+ * /dataentities/CL/search?firstName=*Maria*
+ * ```
+ * 
+ * ### Filter for null values
+ * 
+ * ```
+ * /dataentities/CL/search?_where=firstName is null
+ * ```
+ * 
+ * ### Filter for non-null values
+ * 
+ * ```
+ * /dataentities/CL/search?_where=firstName is not null
+ * ```
+ * 
+ * ### Filter for difference
+ * ```
+ * /dataentities/CL/search?_where=firstName<>maria
+ * ```
+ * 
+ * ### Filter greater than or less than
+ * ```
+ * /dataentities/CL/search?_where=number>5
+ * /dataentities/CL/search?_where=date<2001-01-01
+ * ```
+ * /dataentities/CL/search?email=my@email.com
+ * ```
+ * 
+ * ### Complex filter
+ * 
+ * ```
+ * /dataentities/CL/search?_where=(firstName=Jon OR lastName=Smith) OR (createdIn between 2001-01-01 AND 2016-01-01)
+ * ```
+ * 
+ * ### Filter by range
+ * 
+ * #### Date Range
+ * 
+ * ```
+ * /dataentities/CL/search?_where=createdIn between 2001-01-01 AND 2016-01-01
+ * ```
+ * 
+ * #### Range numeric fields
+ * 
+ * ```
+ * /dataentities/CL/search?_where=age between 18 AND 25
+ * ```
+ * 
+ * ### Partial filter
+ * 
+ * ```
+ * /dataentities/CL/search?firstName=*Maria*
+ * ```
+ * 
+ * ### Filter for null values
+ * 
+ * ```
+ * /dataentities/CL/search?_where=firstName is null
+ * ```
+ * 
+ * ### Filter for non-null values
+ * 
+ * ```
+ * /dataentities/CL/search?_where=firstName is not null
+ * ```
+ * 
+ * ### Filter for difference
+ * ```
+ * /dataentities/CL/search?_where=firstName<>maria
+ * ```
+ * 
+ * ### Filter greater than or less than
+ * ```
+ * /dataentities/CL/search?_where=number>5
+ * /dataentities/CL/search?_where=date<2001-01-01
+ * ```
+ * 
+ * 
+> Avoid sending too many requests with wildcards (`*`) in the search parameters or that use the `keyword` parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens you will receive an error with status code `503`. 
+ * 
+ * ## Permissions
+ * 
+ * Any user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Dynamic Storage | Dynamic storage generic resources | **Read only documents** |
+ * | Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |
+ * | Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |
+ * | Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "GET /api/dataentities/:acronym/search": {
@@ -797,8 +854,8 @@ warehouseName?: string
 }
 }
 /**
- * Retrieves information about [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) of your store.
- * 
+ * Retrieves information about [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) of your store.
+ * 
  * >⚠️ The response is limited to 1.000 pickup points. If you need more than 1000 results, you can use the [List paged pickup points](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/configuration/pickuppoints/_search) endpoint.
  */
 "GET /api/logistics/pvt/configuration/pickuppoints": {
@@ -808,9 +865,9 @@ warehouseName?: string
 response: PickupPoint[]
 }
 /**
- * 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": {
@@ -871,22 +928,22 @@ DocumentId?: string
 }
 }
 /**
- * Creates a partial document, sending only some of the fields.
- * 
- * > You can use this request to create documents in any given data entity. Because of this, you are not restricted to using the fields exemplified below in your requests. But you should be aware of the fields allowed or required for each document you wish to update. 
- * 
- * ## Permissions
- * 
- * Any user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |
- * | Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |
- * | Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * Creates a partial document, sending only some of the fields.
+ * 
+ * > You can use this request to create documents in any given data entity. Because of this, you are not restricted to using the fields exemplified below in your requests. But you should be aware of the fields allowed or required for each document you wish to update. 
+ * 
+ * ## Permissions
+ * 
+ * Any user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |
+ * | Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |
+ * | Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "PATCH /api/dataentities/:acronym/documents": {
@@ -904,21 +961,21 @@ id?: string
 response: IdHrefDocumentID
 }
 /**
- * Retrieves a document.
- * 
- * ## Permissions
- * 
- * Any user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Dynamic Storage | Dynamic storage generic resources | **Read only documents** |
- * | Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |
- * | Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |
- * | Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * Retrieves a document.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Dynamic Storage | Dynamic storage generic resources | **Read only documents** |
+ * | Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |
+ * | Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |
+ * | Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "GET /api/dataentities/:acronym/documents/:id": {
@@ -931,47 +988,47 @@ _fields?: string
 response: Document
 }
 /**
- * Creates a new document with a custom ID, or updates an entire document if there is already a document with the informed ID.
- * 
- * >ℹ️ You can use this request to create or update documents in any given data entity. Because of this, you are not restricted to using the fields exemplified below in your requests. But you should be aware of the fields allowed or required for each document you wish to update.
- * 
- * ## Custom field types
- * 
- * The table below presents the types of custom fields you can use when creating or updating documents in Master Data v1 and example values.
- * 
- * | Field Type| Example value |
- * | - | - |
- * | Boolean | `true` |
- * | Currency | `2.5` |
- * | Date | `1992-11-17` |
- * | Date_Time | `2016-09-14T19:21:01.3163733Z` |
- * | Decimal | `2.5` |
- * | Email | `meu@email.com` |
- * | Integer | `1000000` |
- * | Long | `1000000000` |
- * | Percent | `85.42` |
- * | Time | `23:50` |
- * | URL | `https://www.vtex.com` |
- * | Varchar10 | `Lorem ipsu` |
- * | Varchar50 | `Lorem ipsum dolor sit amet, consectetur adipiscing` |
- * | Varchar750  | `Lorem ipsum dolor sit amet, consectetur adipiscing elit...` |
- * | Varchar100  | `Lorem ipsum dolor sit amet, consectetur adipiscing elit...` |
- * | Relationship | `5eb31afb-7ab0-11e6-94b4-0a44686e393f` |
- * | Text | `Lorem ipsum dolor sit amet, consectetur adipiscing elit...` |
- *  
- * 
- * ## Permissions
- * 
- * Any user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |
- * | Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |
- * | Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * Creates a new document with a custom ID, or updates an entire document if there is already a document with the informed ID.
+ * 
+ * >ℹ️ You can use this request to create or update documents in any given data entity. Because of this, you are not restricted to using the fields exemplified below in your requests. But you should be aware of the fields allowed or required for each document you wish to update.
+ * 
+ * ## Custom field types
+ * 
+ * The table below presents the types of custom fields you can use when creating or updating documents in Master Data v1 and example values.
+ * 
+ * | Field Type| Example value |
+ * | - | - |
+ * | Boolean | `true` |
+ * | Currency | `2.5` |
+ * | Date | `1992-11-17` |
+ * | Date_Time | `2016-09-14T19:21:01.3163733Z` |
+ * | Decimal | `2.5` |
+ * | Email | `meu@email.com` |
+ * | Integer | `1000000` |
+ * | Long | `1000000000` |
+ * | Percent | `85.42` |
+ * | Time | `23:50` |
+ * | URL | `https://www.vtex.com` |
+ * | Varchar10 | `Lorem ipsu` |
+ * | Varchar50 | `Lorem ipsum dolor sit amet, consectetur adipiscing` |
+ * | Varchar750  | `Lorem ipsum dolor sit amet, consectetur adipiscing elit...` |
+ * | Varchar100  | `Lorem ipsum dolor sit amet, consectetur adipiscing elit...` |
+ * | Relationship | `5eb31afb-7ab0-11e6-94b4-0a44686e393f` |
+ * | Text | `Lorem ipsum dolor sit amet, consectetur adipiscing elit...` |
+ *  
+ * 
+ * ## Permissions
+ * 
+ * Any user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |
+ * | Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |
+ * | Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "PUT /api/dataentities/:acronym/documents/:id": {
@@ -987,41 +1044,41 @@ body: {
 }
 }
 /**
- * Deletes a document. 
- * 
- * ## Permissions
- * 
- * Any user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |
- * | Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * Deletes a document. 
+ * 
+ * ## Permissions
+ * 
+ * Any user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |
+ * | Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "DELETE /api/dataentities/:acronym/documents/:id": {
 
 }
 /**
- * Updates a subset of fields of a document, without impacting the other fields.
- * 
- * >ℹ️ You can use this request to update documents in any given data entity. Because of this, you are not restricted to using the fields exemplified below in your requests. But you should be aware of the fields allowed or required for each document you wish to update. 
- * 
- * ## Permissions
- * 
- * Any user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |
- * | Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |
- * | Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * Updates a subset of fields of a document, without impacting the other fields.
+ * 
+ * >ℹ️ You can use this request to update documents in any given data entity. Because of this, you are not restricted to using the fields exemplified below in your requests. But you should be aware of the fields allowed or required for each document you wish to update. 
+ * 
+ * ## Permissions
+ * 
+ * Any user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |
+ * | Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |
+ * | Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "PATCH /api/dataentities/:acronym/documents/:id": {
@@ -1033,9 +1090,9 @@ body: {
 }
 }
 /**
- * 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": {
@@ -1077,9 +1134,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: `<vtex.cmc:productDescriptionShort/>`.
+ * 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: `<vtex.cmc:productDescriptionShort/>`.
  * 
  */
 DescriptionShort?: string
@@ -1088,8 +1145,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
@@ -1171,9 +1228,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: `<vtex.cmc:productDescriptionShort/>`.
+ * 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: `<vtex.cmc:productDescriptionShort/>`.
  * 
  */
 DescriptionShort?: string
@@ -1182,8 +1239,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
@@ -1264,9 +1321,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: `<vtex.cmc:productDescriptionShort/>`.
+ * 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: `<vtex.cmc:productDescriptionShort/>`.
  * 
  */
 DescriptionShort?: string
@@ -1275,8 +1332,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
@@ -1507,119 +1564,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": {
@@ -1787,98 +1844,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": {
@@ -1924,9 +1981,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: `<vtex.cmc:productDescriptionShort/>`.
+ * 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: `<vtex.cmc:productDescriptionShort/>`.
  * 
  */
 DescriptionShort?: string
@@ -1935,8 +1992,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
@@ -2017,9 +2074,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: `<vtex.cmc:productDescriptionShort/>`.
+ * 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: `<vtex.cmc:productDescriptionShort/>`.
  * 
  */
 DescriptionShort?: string
@@ -2028,8 +2085,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
@@ -2074,72 +2131,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": {
@@ -2167,27 +2224,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": {
@@ -2241,43 +2298,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": {
@@ -2326,26 +2383,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": {
@@ -2365,209 +2422,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": {
@@ -2580,38 +2637,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": {
@@ -2729,111 +2786,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": {
@@ -3059,12 +3116,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": {
@@ -3074,205 +3131,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": {
@@ -3291,44 +3348,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": {
@@ -3440,72 +3497,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": {
@@ -3719,56 +3776,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": {
@@ -3788,27 +3845,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": {
@@ -3829,17 +3886,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": {
@@ -3852,176 +3909,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": {
@@ -4049,24 +4106,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": {
@@ -4114,17 +4171,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": {
@@ -4154,16 +4211,17 @@ 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": {
@@ -4179,36 +4237,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": {
@@ -4243,31 +4301,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": {
@@ -4302,29 +4360,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": {
@@ -4359,26 +4417,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/": {
@@ -4415,17 +4473,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": {
@@ -4442,27 +4500,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": {
@@ -4516,21 +4574,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": {
@@ -4596,79 +4654,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": {
@@ -4739,24 +4797,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": {
@@ -4807,36 +4865,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": {
@@ -4844,57 +4902,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": {
@@ -4908,28 +4966,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": {
@@ -4937,45 +4995,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": {
@@ -4989,52 +5047,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": {
@@ -5051,29 +5109,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": {
@@ -5114,35 +5172,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": {
@@ -5193,22 +5251,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": {
@@ -5238,196 +5296,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": {
@@ -5494,75 +5552,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": {
@@ -5570,21 +5628,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/": {
@@ -5603,15 +5661,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": {
@@ -5636,68 +5694,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": {
@@ -5706,22 +5764,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": {
@@ -5751,37 +5809,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": {
@@ -5791,44 +5849,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": {
@@ -5871,41 +5929,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": {
@@ -5913,46 +5971,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": {
@@ -5968,22 +6026,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": {
@@ -6013,79 +6071,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": {
@@ -6099,50 +6157,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": {
@@ -6150,151 +6208,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": {
@@ -6476,22 +6534,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": {
@@ -6537,33 +6595,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": {
@@ -6639,33 +6697,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": {
@@ -6733,36 +6791,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": {
@@ -6796,18 +6854,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": {
@@ -6841,18 +6899,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": {
@@ -6916,29 +6974,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": {
@@ -6994,15 +7052,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": {
@@ -7022,29 +7080,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": {
@@ -7117,53 +7175,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": {
@@ -7256,14 +7314,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
@@ -7272,8 +7330,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
@@ -7290,14 +7348,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
@@ -7308,50 +7366,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": {
@@ -7377,14 +7435,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
@@ -7393,8 +7451,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
@@ -7411,14 +7469,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
@@ -7453,14 +7511,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
@@ -7469,8 +7527,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
@@ -7487,14 +7545,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
@@ -7505,35 +7563,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": {
@@ -7575,20 +7633,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
@@ -7597,14 +7655,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
@@ -7623,38 +7681,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": {
@@ -7665,37 +7723,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": {
@@ -7706,20 +7764,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": {
@@ -7751,88 +7809,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": {
@@ -7865,27 +7923,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": {
@@ -7896,18 +7954,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": {
@@ -7939,30 +7997,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": {
@@ -8018,29 +8076,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": {
@@ -8096,66 +8154,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": {
@@ -8174,25 +8232,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": {
@@ -8234,16 +8292,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": {
@@ -8273,18 +8331,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": {
@@ -8325,35 +8383,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": {
@@ -8442,34 +8500,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": {
@@ -9115,38 +9173,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": {
@@ -9154,38 +9212,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": {
@@ -9199,28 +9257,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": {
@@ -9248,34 +9306,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": {
@@ -9303,55 +9361,55 @@ onlyAssigned?: boolean
 response: number[]
 }
 /**
- * Retrieve details of a Product's Indexed Information in XML format. 
- * ## Response body example
- * 
- * ```xml
- * "
- * <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n
- * <response>\n
- *     <lst name=\"responseHeader\">
- *         <bool name=\"zkConnected\">true</bool>
- *         <int name=\"status\">0</int>
- *         <int name=\"QTime\">2</int>
- *         <lst name=\"params\">
- *             <str name=\"fl\">*</str>
- *             <arr name=\"fq\">
- *                 <str>instanceId:394dbdc8-b1f4-4dea-adfa-1ec104f3bfe1</str>
- *                 <str>productId:1</str>
- *             </arr>
- *         </lst>
- *     </lst>
- *     <result name=\"response\" numFound=\"0\" start=\"0\" maxScore=\"0.0\"></result>
- *     <lst name=\"facet_counts\">
- *         <lst name=\"facet_queries\"/>
- *         <lst name=\"facet_fields\"/>
- *         <lst name=\"facet_ranges\"/>
- *         <lst name=\"facet_intervals\"/>
- *         <lst name=\"facet_heatmaps\"/></lst>\n
- * </response>\n"
+ * Retrieve details of a Product's Indexed Information in XML format. 
+ * ## Response body example
+ * 
+ * ```xml
+ * "
+ * <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n
+ * <response>\n
+ *     <lst name=\"responseHeader\">
+ *         <bool name=\"zkConnected\">true</bool>
+ *         <int name=\"status\">0</int>
+ *         <int name=\"QTime\">2</int>
+ *         <lst name=\"params\">
+ *             <str name=\"fl\">*</str>
+ *             <arr name=\"fq\">
+ *                 <str>instanceId:394dbdc8-b1f4-4dea-adfa-1ec104f3bfe1</str>
+ *                 <str>productId:1</str>
+ *             </arr>
+ *         </lst>
+ *     </lst>
+ *     <result name=\"response\" numFound=\"0\" start=\"0\" maxScore=\"0.0\"></result>
+ *     <lst name=\"facet_counts\">
+ *         <lst name=\"facet_queries\"/>
+ *         <lst name=\"facet_fields\"/>
+ *         <lst name=\"facet_ranges\"/>
+ *         <lst name=\"facet_intervals\"/>
+ *         <lst name=\"facet_heatmaps\"/></lst>\n
+ * </response>\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": {
@@ -9371,15 +9429,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": {
@@ -9573,22 +9631,23 @@ 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
 /**
@@ -10332,13 +10391,14 @@ 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: {
@@ -10349,11 +10409,12 @@ 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: {
@@ -10364,12 +10425,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": {
@@ -10384,10 +10445,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": {
@@ -10395,22 +10456,26 @@ 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[]
 }
@@ -11517,18 +11582,20 @@ 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[]
 }
@@ -12644,15 +12711,18 @@ 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: {
@@ -13789,26 +13859,30 @@ 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": {
@@ -13821,12 +13895,15 @@ 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": {
@@ -13982,12 +14059,13 @@ 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": {
@@ -14046,14 +14124,15 @@ 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": {
@@ -15195,11 +15274,12 @@ 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: {
@@ -15215,18 +15295,20 @@ 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
 /**
@@ -15260,11 +15342,12 @@ 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: {
@@ -15312,11 +15395,12 @@ 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: {
@@ -15339,11 +15423,13 @@ 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": {
@@ -15357,11 +15443,13 @@ 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": {
@@ -15369,20 +15457,24 @@ 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: {
@@ -15467,11 +15559,15 @@ 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
 /**
@@ -15490,37 +15586,41 @@ 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": {
@@ -16610,13 +16710,15 @@ 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: {
@@ -16628,12 +16730,15 @@ 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": {
@@ -17724,8 +17829,9 @@ 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: {
@@ -17871,8 +17977,8 @@ ClosingTime?: 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": {
@@ -17880,8 +17986,9 @@ ClosingTime?: 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: {
@@ -17906,8 +18013,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": {
@@ -18024,10 +18131,12 @@ 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: {
 /**
@@ -18085,8 +18194,9 @@ 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?: {
 /**
@@ -19440,21 +19550,26 @@ 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: {
@@ -19496,29 +19611,29 @@ logo?: (null | string)
 }
 }
 /**
- * Lists all orders from a given customer, filtering by their email. 
- * 
- * > You can only access information from orders created in the last two years, and that same period is valid for customers through [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh). 
- * 
- * > Note that this request should be made by an [user](https://developers.vtex.com/docs/guides/user-authentication-and-login) or [an appKey / appToken pair](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) that is associated with the [Call center operator](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy#call-center-operator) role. Otherwise, it will return only orders from the same email informed in the `clientEmail` query parameter. 
- * 
- * ## Permissions
- * 
- * Any user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | OMS | OMS access | **View order** |
- * 
- * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
- * 
- * | **Role** | **Resource** | 
- * | --------------- | ----------------- | 
- * | Call center operator | View order |
- * | OMS - Read only | View order |
- * 
- * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). 
- * 
+ * Lists all orders from a given customer, filtering by their email. 
+ * 
+ * > You can only access information from orders created in the last two years, and that same period is valid for customers through [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh). 
+ * 
+ * > Note that this request should be made by an [user](https://developers.vtex.com/docs/guides/user-authentication-and-login) or [an appKey / appToken pair](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) that is associated with the [Call center operator](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy#call-center-operator) role. Otherwise, it will return only orders from the same email informed in the `clientEmail` query parameter. 
+ * 
+ * ## Permissions
+ * 
+ * Any user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | OMS | OMS access | **View order** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Call center operator | View order |
+ * | OMS - Read only | View order |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). 
+ * 
  * To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
  */
 "GET /api/oms/user/orders": {
@@ -20994,8 +21109,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
@@ -21014,14 +21129,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 (`<vtex.cmc:departmentNavigator/>`).
+ * Store Framework - Deprecated.
+ * Legacy CMS Portal - Defines if the Brand appears in the Department Menu control (`<vtex.cmc:departmentNavigator/>`).
  * 
  */
 MenuHome?: boolean
@@ -21138,14 +21253,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
@@ -21159,14 +21274,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
@@ -21221,14 +21336,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
@@ -21242,14 +21357,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
@@ -21718,11 +21833,15 @@ 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
 /**
diff --git a/vtex/utils/types.ts b/vtex/utils/types.ts
index 2097514bb..c15cc43ee 100644
--- a/vtex/utils/types.ts
+++ b/vtex/utils/types.ts
@@ -175,6 +175,12 @@ export interface AdditionalInfo {
   offeringInfo: null;
   offeringType: null;
   offeringTypeId: null;
+  categories: CategoryItem[];
+}
+
+export interface CategoryItem {
+  id: number;
+  name: string;
 }
 
 export interface AttachmentOffering {

From c5dbc1cedf11860d149ffcca1ca71503a83f9b80 Mon Sep 17 00:00:00 2001
From: marcoferreiradev <mw.marcowilliam@gmail.com>
Date: Thu, 31 Oct 2024 18:23:54 -0300
Subject: [PATCH 14/93] fix: add new type

---
 vtex/utils/types.ts | 1 +
 1 file changed, 1 insertion(+)

diff --git a/vtex/utils/types.ts b/vtex/utils/types.ts
index c15cc43ee..04e06ac50 100644
--- a/vtex/utils/types.ts
+++ b/vtex/utils/types.ts
@@ -1448,6 +1448,7 @@ export interface OrderItem {
   invoicedDate: string | null;
   isCheckedIn: boolean;
   isCompleted: boolean;
+  storePreferencesData: StorePreferencesData;
   sellers?: {
     id: string;
     name: string;

From 94c3caabfd53283649b5f4dd7112592e5da70886 Mon Sep 17 00:00:00 2001
From: "@yuri_assuncx" <killerkoll2012@gmail.com>
Date: Mon, 4 Nov 2024 11:54:13 -0300
Subject: [PATCH 15/93] feat: add new prop and body item to cancel order action
 (#951)

---
 vtex/actions/orders/cancel.ts | 5 +++--
 vtex/utils/client.ts          | 1 +
 2 files changed, 4 insertions(+), 2 deletions(-)

diff --git a/vtex/actions/orders/cancel.ts b/vtex/actions/orders/cancel.ts
index 6f1982370..78401327b 100644
--- a/vtex/actions/orders/cancel.ts
+++ b/vtex/actions/orders/cancel.ts
@@ -5,6 +5,7 @@ import { CanceledOrder } from "../../utils/types.ts";
 interface Props {
   orderId: string;
   reason: string;
+  requestedByUser: boolean;
 }
 
 async function action(
@@ -19,13 +20,13 @@ async function action(
     return null;
   }
 
-  const { orderId, reason } = props;
+  const { orderId, reason, requestedByUser } = props;
 
   const response = await vcsDeprecated
     ["POST /api/oms/pvt/orders/:orderId/cancel"](
       { orderId },
       {
-        body: { reason },
+        body: { reason, requestedByUser },
         headers: {
           cookie,
         },
diff --git a/vtex/utils/client.ts b/vtex/utils/client.ts
index f2546079e..9866e4b8f 100644
--- a/vtex/utils/client.ts
+++ b/vtex/utils/client.ts
@@ -257,6 +257,7 @@ export interface VTEXCommerceStable {
     response: CanceledOrder;
     body: {
       reason: string;
+      requestedByUser: boolean;
     };
   };
 }

From dbb75fa53dfbb8b100e30f7923a0f11d9741a4f5 Mon Sep 17 00:00:00 2001
From: Dex <fernandofrizzatti@gmail.com>
Date: Mon, 4 Nov 2024 19:07:44 -0300
Subject: [PATCH 16/93] (feat): creating an action for vtex masterdata's
 updatePartialDocument (#949)

---
 .../masterdata/updatePartialDocument.ts       | 43 +++++++++++++++++++
 1 file changed, 43 insertions(+)
 create mode 100644 vtex/actions/masterdata/updatePartialDocument.ts

diff --git a/vtex/actions/masterdata/updatePartialDocument.ts b/vtex/actions/masterdata/updatePartialDocument.ts
new file mode 100644
index 000000000..996a76cba
--- /dev/null
+++ b/vtex/actions/masterdata/updatePartialDocument.ts
@@ -0,0 +1,43 @@
+import { AppContext } from "../../mod.ts";
+import { parseCookie } from "../../utils/vtexId.ts";
+
+export interface Props {
+  data: Record<string, unknown>;
+  acronym: string;
+  documentId: string;
+  isPrivateEntity?: boolean;
+}
+
+/**
+ * @docs https://developers.vtex.com/docs/api-reference/master-data-api-v2#patch-/api/dataentities/-dataEntityName-/documents/-id-
+ */
+const action = async (
+  props: Props,
+  req: Request,
+  ctx: AppContext,
+): Promise<void> => {
+  const { vcs, vcsDeprecated } = ctx;
+  const { data, acronym, documentId, isPrivateEntity } = props;
+  const { cookie } = parseCookie(req.headers, ctx.account);
+
+  const requestOptions = {
+    body: data,
+    headers: {
+      accept: "application/json",
+      "content-type": "application/json",
+      cookie,
+    },
+  };
+
+  await (isPrivateEntity
+    ? vcs[`PATCH /api/dataentities/:acronym/documents/:documentId`](
+      { acronym, documentId },
+      requestOptions,
+    )
+    : vcsDeprecated[`PATCH /api/dataentities/:acronym/documents/:documentId`](
+      { acronym, documentId },
+      requestOptions,
+    ));
+};
+
+export default action;

From e86208f32eced9d1851515ee561fe78064d2f0ea Mon Sep 17 00:00:00 2001
From: guitavano <tavano62@gmail.com>
Date: Tue, 5 Nov 2024 14:59:34 -0300
Subject: [PATCH 17/93] chec before render seo tags

---
 website/components/Seo.tsx | 26 +++++++++++++-------------
 1 file changed, 13 insertions(+), 13 deletions(-)

diff --git a/website/components/Seo.tsx b/website/components/Seo.tsx
index ad875a050..1f23ef6ac 100644
--- a/website/components/Seo.tsx
+++ b/website/components/Seo.tsx
@@ -62,25 +62,25 @@ function Component({
 
   return (
     <Head>
-      <title>{renderTemplateString(titleTemplate, title)}</title>
-      <meta
+      {title && <title>{renderTemplateString(titleTemplate, title)}</title>}
+      {description && <meta
         name="description"
         content={renderTemplateString(descriptionTemplate, description)}
-      />
-      <meta name="theme-color" content={themeColor} />
-      <link rel="icon" href={favicon} />
+      />}
+      {themeColor && <meta name="theme-color" content={themeColor} />}
+      {favicon && <link rel="icon" href={favicon} />}
 
       {/* Twitter tags */}
-      <meta property="twitter:title" content={title} />
-      <meta property="twitter:description" content={description} />
-      <meta property="twitter:image" content={image} />
-      <meta property="twitter:card" content={twitterCard} />
+      {title && <meta property="twitter:title" content={title} />}
+      {description && <meta property="twitter:description" content={description} />}
+      {image && <meta property="twitter:image" content={image} />}
+      {twitterCard && <meta property="twitter:card" content={twitterCard} />}
 
       {/* OpenGraph tags */}
-      <meta property="og:title" content={title} />
-      <meta property="og:description" content={description} />
-      <meta property="og:type" content={type} />
-      <meta property="og:image" content={image} />
+      {title && <meta property="og:title" content={title} />}
+      {description && <meta property="og:description" content={description} />}
+      {type && <meta property="og:type" content={type} />}
+      {image && <meta property="og:image" content={image} />}
 
       {/* Link tags */}
       {canonical && <link rel="canonical" href={canonical} />}

From 64f065db361fe351113dd97580f4b060964623e2 Mon Sep 17 00:00:00 2001
From: marcoferreiradev <mw.marcowilliam@gmail.com>
Date: Tue, 5 Nov 2024 15:22:49 -0300
Subject: [PATCH 18/93] feat: update types for materData and OrderItem

---
 .../masterdata/updatePartialDocument.ts       |    4 +-
 vtex/loaders/orders/order.ts                  |   16 +-
 vtex/manifest.gen.ts                          |   46 +-
 vtex/utils/client.ts                          |    4 +
 vtex/utils/openapi/vcs.openapi.gen.ts         | 2088 +++-
 vtex/utils/openapi/vcs.openapi.json           | 8760 ++++++++++++++++-
 vtex/utils/types.ts                           |    7 +-
 7 files changed, 10683 insertions(+), 242 deletions(-)

diff --git a/vtex/actions/masterdata/updatePartialDocument.ts b/vtex/actions/masterdata/updatePartialDocument.ts
index 996a76cba..445b9f0dc 100644
--- a/vtex/actions/masterdata/updatePartialDocument.ts
+++ b/vtex/actions/masterdata/updatePartialDocument.ts
@@ -30,8 +30,8 @@ const action = async (
   };
 
   await (isPrivateEntity
-    ? vcs[`PATCH /api/dataentities/:acronym/documents/:documentId`](
-      { acronym, documentId },
+    ? vcs["PATCH /api/dataentities/:acronym/documents/:id"](
+      { acronym, id: documentId },
       requestOptions,
     )
     : vcsDeprecated[`PATCH /api/dataentities/:acronym/documents/:documentId`](
diff --git a/vtex/loaders/orders/order.ts b/vtex/loaders/orders/order.ts
index 0cc1e1cac..e2c968e1b 100644
--- a/vtex/loaders/orders/order.ts
+++ b/vtex/loaders/orders/order.ts
@@ -1,6 +1,6 @@
 import { RequestURLParam } from "../../../website/functions/requestToParam.ts";
 import { AppContext } from "../../mod.ts";
-import { OrderItem } from "../../utils/types.ts";
+import { Userorderdetails } from "../../utils/openapi/vcs.openapi.gen.ts";
 import { parseCookie } from "../../utils/vtexId.ts";
 
 export interface Props {
@@ -11,14 +11,22 @@ export default async function loader(
   props: Props,
   req: Request,
   ctx: AppContext,
-): Promise<OrderItem | null> {
+): Promise<Userorderdetails | null> {
   const { vcs } = ctx;
-  const { cookie } = parseCookie(req.headers, ctx.account);
+  const { cookie, payload } = parseCookie(req.headers, ctx.account);
+
+  // sub is userEmail
+  if (!payload?.sub || !payload?.userId) {
+    return null;
+  }
 
   const { slug } = props;
 
   const response = await vcs["GET /api/oms/user/orders/:orderId"](
-    { orderId: slug.includes("-") ? slug : slug + "-01" },
+    {
+      orderId: slug.includes("-") ? slug : slug + "-01",
+      clientEmail: payload?.sub,
+    },
     {
       headers: {
         cookie,
diff --git a/vtex/manifest.gen.ts b/vtex/manifest.gen.ts
index 7a1b1e417..1d95b3e79 100644
--- a/vtex/manifest.gen.ts
+++ b/vtex/manifest.gen.ts
@@ -24,17 +24,18 @@ import * as $$$$$$$$$18 from "./actions/cart/updateProfile.ts";
 import * as $$$$$$$$$19 from "./actions/cart/updateUser.ts";
 import * as $$$$$$$$$20 from "./actions/masterdata/createDocument.ts";
 import * as $$$$$$$$$21 from "./actions/masterdata/updateDocument.ts";
-import * as $$$$$$$$$22 from "./actions/newsletter/subscribe.ts";
-import * as $$$$$$$$$23 from "./actions/notifyme.ts";
-import * as $$$$$$$$$24 from "./actions/orders/cancel.ts";
-import * as $$$$$$$$$25 from "./actions/payments/delete.ts";
-import * as $$$$$$$$$26 from "./actions/profile/newsletterProfile.ts";
-import * as $$$$$$$$$27 from "./actions/profile/updateProfile.ts";
-import * as $$$$$$$$$28 from "./actions/review/submit.ts";
-import * as $$$$$$$$$29 from "./actions/sessions/delete.ts";
-import * as $$$$$$$$$30 from "./actions/trigger.ts";
-import * as $$$$$$$$$31 from "./actions/wishlist/addItem.ts";
-import * as $$$$$$$$$32 from "./actions/wishlist/removeItem.ts";
+import * as $$$$$$$$$22 from "./actions/masterdata/updatePartialDocument.ts";
+import * as $$$$$$$$$23 from "./actions/newsletter/subscribe.ts";
+import * as $$$$$$$$$24 from "./actions/notifyme.ts";
+import * as $$$$$$$$$25 from "./actions/orders/cancel.ts";
+import * as $$$$$$$$$26 from "./actions/payments/delete.ts";
+import * as $$$$$$$$$27 from "./actions/profile/newsletterProfile.ts";
+import * as $$$$$$$$$28 from "./actions/profile/updateProfile.ts";
+import * as $$$$$$$$$29 from "./actions/review/submit.ts";
+import * as $$$$$$$$$30 from "./actions/sessions/delete.ts";
+import * as $$$$$$$$$31 from "./actions/trigger.ts";
+import * as $$$$$$$$$32 from "./actions/wishlist/addItem.ts";
+import * as $$$$$$$$$33 from "./actions/wishlist/removeItem.ts";
 import * as $$$$0 from "./handlers/sitemap.ts";
 import * as $$$0 from "./loaders/address/getAddressByZIP.ts";
 import * as $$$1 from "./loaders/address/list.ts";
@@ -166,17 +167,18 @@ const manifest = {
     "vtex/actions/cart/updateUser.ts": $$$$$$$$$19,
     "vtex/actions/masterdata/createDocument.ts": $$$$$$$$$20,
     "vtex/actions/masterdata/updateDocument.ts": $$$$$$$$$21,
-    "vtex/actions/newsletter/subscribe.ts": $$$$$$$$$22,
-    "vtex/actions/notifyme.ts": $$$$$$$$$23,
-    "vtex/actions/orders/cancel.ts": $$$$$$$$$24,
-    "vtex/actions/payments/delete.ts": $$$$$$$$$25,
-    "vtex/actions/profile/newsletterProfile.ts": $$$$$$$$$26,
-    "vtex/actions/profile/updateProfile.ts": $$$$$$$$$27,
-    "vtex/actions/review/submit.ts": $$$$$$$$$28,
-    "vtex/actions/sessions/delete.ts": $$$$$$$$$29,
-    "vtex/actions/trigger.ts": $$$$$$$$$30,
-    "vtex/actions/wishlist/addItem.ts": $$$$$$$$$31,
-    "vtex/actions/wishlist/removeItem.ts": $$$$$$$$$32,
+    "vtex/actions/masterdata/updatePartialDocument.ts": $$$$$$$$$22,
+    "vtex/actions/newsletter/subscribe.ts": $$$$$$$$$23,
+    "vtex/actions/notifyme.ts": $$$$$$$$$24,
+    "vtex/actions/orders/cancel.ts": $$$$$$$$$25,
+    "vtex/actions/payments/delete.ts": $$$$$$$$$26,
+    "vtex/actions/profile/newsletterProfile.ts": $$$$$$$$$27,
+    "vtex/actions/profile/updateProfile.ts": $$$$$$$$$28,
+    "vtex/actions/review/submit.ts": $$$$$$$$$29,
+    "vtex/actions/sessions/delete.ts": $$$$$$$$$30,
+    "vtex/actions/trigger.ts": $$$$$$$$$31,
+    "vtex/actions/wishlist/addItem.ts": $$$$$$$$$32,
+    "vtex/actions/wishlist/removeItem.ts": $$$$$$$$$33,
   },
   "workflows": {
     "vtex/workflows/events.ts": $$$$$$$$$$0,
diff --git a/vtex/utils/client.ts b/vtex/utils/client.ts
index 9866e4b8f..afe62a9ba 100644
--- a/vtex/utils/client.ts
+++ b/vtex/utils/client.ts
@@ -244,6 +244,10 @@ export interface VTEXCommerceStable {
     response: CreateNewDocument;
     body: Record<string, unknown>;
   };
+  "PATCH /api/dataentities/:acronym/documents/:documentId": {
+    response: CreateNewDocument;
+    body: Record<string, unknown>;
+  };
   "GET /api/catalog_system/pub/brand/list": {
     response: Brand[];
   };
diff --git a/vtex/utils/openapi/vcs.openapi.gen.ts b/vtex/utils/openapi/vcs.openapi.gen.ts
index 6d0166fd6..29f7b5b58 100644
--- a/vtex/utils/openapi/vcs.openapi.gen.ts
+++ b/vtex/utils/openapi/vcs.openapi.gen.ts
@@ -7,8 +7,6 @@
 // To generate this file: deno task start
 //        
 
-import { OrderItem } from "../types.ts";
-
 
 export type SkuComplement = {
 /**
@@ -67,9 +65,6 @@ export type SavePersonalData = boolean
 export type OptinNewsLetter = boolean
 
 export interface OpenAPI {
-  "GET /api/oms/user/orders/:orderId": {
-    response: OrderItem;
-  };
 /**
  * Retrieves a specific promotion by its Promotion ID or a specific tax by its tax ID.
  * 
@@ -828,138 +823,6 @@ accountName?: string
 dataEntityId?: string
 }[]
 }
-"GET /api/logistics/pvt/inventory/skus/:skuId": {
-response: {
-/**
- * Unique identifier of the SKU.
- */
-skuId?: string
-/**
- * List of warehouses.
- */
-balance?: {
-hasUnlimitedQuantity?: boolean
-leadTime?: string
-reservedQuantity?: number
-totalQuantity?: number
-/**
- * Warehouse ID.
- */
-warehouseId?: string
-/**
- * Warehouse name.
- */
-warehouseName?: string
-}[]
-}
-}
-/**
- * Retrieves information about [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) of your store.
- * 
- * >⚠️ The response is limited to 1.000 pickup points. If you need more than 1000 results, you can use the [List paged pickup points](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/configuration/pickuppoints/_search) endpoint.
- */
-"GET /api/logistics/pvt/configuration/pickuppoints": {
-/**
- * List of pickup points, limited to 1.000 pickup points. If you need more than 1000 results, you can use the [List paged pickup points](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/configuration/pickuppoints/_search) endpoint.
- */
-response: PickupPoint[]
-}
-/**
- * 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": {
-searchParams: {
-/**
- * ID of the category from which you need to retrieve Products and SKUs.
- */
-categoryId?: number
-/**
- * Insert the ID that will start the request result.
- */
-_from?: number
-/**
- * Insert the ID that will end the request result.
- */
-_to?: number
-}
-response: {
-/**
- * Object composed by Product IDs and SKU IDs, where the parent ID is from Products and the SKU IDs are the Child IDs.
- */
-data?: {
-/**
- * Array with SKU IDs of a certain product.
- */
-"Product ID"?: number[]
-}
-/**
- * Object with information about the product and SKUs list.
- */
-range?: {
-/**
- * Total quantity of SKUs.
- */
-total?: number
-/**
- * Initial product ID.
- */
-from?: number
-/**
- * Final product ID.
- */
-to?: number
-}
-}
-}
-/**
- * Create a new document
- */
-"POST /api/dataentities/:acronym/documents": {
-body: {
-anyProperty?: string
-}
-response: {
-Id?: string
-Href?: string
-DocumentId?: string
-}
-}
-/**
- * Creates a partial document, sending only some of the fields.
- * 
- * > You can use this request to create documents in any given data entity. Because of this, you are not restricted to using the fields exemplified below in your requests. But you should be aware of the fields allowed or required for each document you wish to update. 
- * 
- * ## Permissions
- * 
- * Any user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |
- * | Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |
- * | Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
- * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
- */
-"PATCH /api/dataentities/:acronym/documents": {
-body: {
-/**
- * Unique identifier of the document to be created.
- */
-id?: string
-/**
- * Field(s) to be filled in and its respective value(s).
- */
-"{fieldName}"?: string
-[k: string]: any
-}
-response: IdHrefDocumentID
-}
 /**
  * Retrieves a document.
  * 
@@ -1089,116 +952,248 @@ body: {
 
 }
 }
-/**
- * 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": {
+"GET /api/logistics/pvt/inventory/skus/:skuId": {
 response: {
 /**
- * Product’s unique numerical identifier.
- */
-Id?: number
-/**
- * Product's name. Limited to 150 characters.
- */
-Name?: string
-/**
- * Department ID according to the product's category.
- */
-DepartmentId?: number
-/**
- * Category ID associated with this product.
- */
-CategoryId?: number
-/**
- * Brand ID associated with this product.
- */
-BrandId?: number
-/**
- * Slug that will be used to build the product page URL. If it not informed, it will be generated according to the product's name replacing spaces and special characters by hyphens (`-`).
+ * Unique identifier of the SKU.
  */
-LinkId?: string
+skuId?: string
 /**
- * Product Reference Code.
+ * List of warehouses.
  */
-RefId?: string
+balance?: {
+hasUnlimitedQuantity?: boolean
+leadTime?: string
+reservedQuantity?: number
+totalQuantity?: number
 /**
- * Shows (`true`) or hides (`false`) the product in search result and product pages, but the product can still be added to the shopping cart. Usually applicable for gifts.
+ * Warehouse ID.
  */
-IsVisible?: boolean
+warehouseId?: string
 /**
- * Product description.
+ * Warehouse name.
  */
-Description?: string
+warehouseName?: 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: `<vtex.cmc:productDescriptionShort/>`.
+ * Retrieves information about [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) of your store.
  * 
+ * >⚠️ The response is limited to 1.000 pickup points. If you need more than 1000 results, you can use the [List paged pickup points](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/configuration/pickuppoints/_search) endpoint.
  */
-DescriptionShort?: string
+"GET /api/logistics/pvt/configuration/pickuppoints": {
 /**
- * Used to assist in the ordering of the search result of the site. Using the `O=OrderByReleaseDateDESC` query string, you can pull this value and show the display order by release date. This attribute is also used as a condition for dynamic collections.
+ * List of pickup points, limited to 1.000 pickup points. If you need more than 1000 results, you can use the [List paged pickup points](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/configuration/pickuppoints/_search) endpoint.
  */
-ReleaseDate?: string
+response: PickupPoint[]
+}
 /**
- * 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.
- * 
+ * 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.
  */
-KeyWords?: string
+"GET /api/catalog_system/pvt/products/GetProductAndSkuIds": {
+searchParams: {
 /**
- * Product's Title tag. Limited to 150 characters. It is presented in the browser tab and corresponds to the title of the product page. This field is important for SEO.
+ * ID of the category from which you need to retrieve Products and SKUs.
  */
-Title?: string
+categoryId?: number
 /**
- * Activate (`true`) or inactivate (`false`) product.
+ * Insert the ID that will start the request result.
  */
-IsActive?: boolean
+_from?: number
 /**
- * Product tax code, used for tax calculation.
+ * Insert the ID that will end the request result.
  */
-TaxCode?: string
+_to?: number
+}
+response: {
 /**
- * Brief description of the product for SEO. It is recommended not to exceed 150 characters.
+ * Object composed by Product IDs and SKU IDs, where the parent ID is from Products and the SKU IDs are the Child IDs.
  */
-MetaTagDescription?: string
+data?: {
 /**
- * @deprecated
+ * Array with SKU IDs of a certain product.
  */
-SupplierId?: (null | number)
+"Product ID"?: number[]
+}
 /**
- * If `true`, activates the [Notify Me](https://help.vtex.com/en/tutorial/setting-up-the-notify-me-option--2VqVifQuf6Co2KG048Yu6e) option when the product is out of stock.
+ * Object with information about the product and SKUs list.
  */
-ShowWithoutStock?: boolean
+range?: {
 /**
- * @deprecated
- * This is a legacy field. Do not take this information into consideration.
+ * Total quantity of SKUs.
  */
-AdWordsRemarketingCode?: string
+total?: number
 /**
- * @deprecated
- * This is a legacy field. Do not take this information into consideration.
+ * Initial product ID.
  */
-LomadeeCampaignCode?: string
+from?: number
 /**
- * Value used to set the priority on the search result page.
+ * Final product ID.
  */
-Score?: number
+to?: number
+}
 }
 }
 /**
- * Updates an existing Product.
+ * Create a new document
  */
-"PUT /api/catalog/pvt/product/:productId": {
+"POST /api/dataentities/:acronym/documents": {
 body: {
-/**
- * Product's name. Limited to 150 characters.
- */
-Name: string
+anyProperty?: string
+}
+response: {
+Id?: string
+Href?: string
+DocumentId?: string
+}
+}
+/**
+ * Creates a partial document, sending only some of the fields.
+ * 
+ * > You can use this request to create documents in any given data entity. Because of this, you are not restricted to using the fields exemplified below in your requests. But you should be aware of the fields allowed or required for each document you wish to update. 
+ * 
+ * ## Permissions
+ * 
+ * Any user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |
+ * | Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |
+ * | Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"PATCH /api/dataentities/:acronym/documents": {
+body: {
+/**
+ * Unique identifier of the document to be created.
+ */
+id?: string
+/**
+ * Field(s) to be filled in and its respective value(s).
+ */
+"{fieldName}"?: string
+[k: string]: any
+}
+response: IdHrefDocumentID
+}
+/**
+ * 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": {
+response: {
+/**
+ * Product’s unique numerical identifier.
+ */
+Id?: number
+/**
+ * Product's name. Limited to 150 characters.
+ */
+Name?: string
+/**
+ * Department ID according to the product's category.
+ */
+DepartmentId?: number
+/**
+ * Category ID associated with this product.
+ */
+CategoryId?: number
+/**
+ * Brand ID associated with this product.
+ */
+BrandId?: number
+/**
+ * Slug that will be used to build the product page URL. If it not informed, it will be generated according to the product's name replacing spaces and special characters by hyphens (`-`).
+ */
+LinkId?: string
+/**
+ * Product Reference Code.
+ */
+RefId?: string
+/**
+ * Shows (`true`) or hides (`false`) the product in search result and product pages, but the product can still be added to the shopping cart. Usually applicable for gifts.
+ */
+IsVisible?: boolean
+/**
+ * Product description.
+ */
+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: `<vtex.cmc:productDescriptionShort/>`.
+ * 
+ */
+DescriptionShort?: string
+/**
+ * Used to assist in the ordering of the search result of the site. Using the `O=OrderByReleaseDateDESC` query string, you can pull this value and show the display order by release date. This attribute is also used as a condition for dynamic collections.
+ */
+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.
+ * 
+ */
+KeyWords?: string
+/**
+ * Product's Title tag. Limited to 150 characters. It is presented in the browser tab and corresponds to the title of the product page. This field is important for SEO.
+ */
+Title?: string
+/**
+ * Activate (`true`) or inactivate (`false`) product.
+ */
+IsActive?: boolean
+/**
+ * Product tax code, used for tax calculation.
+ */
+TaxCode?: string
+/**
+ * Brief description of the product for SEO. It is recommended not to exceed 150 characters.
+ */
+MetaTagDescription?: string
+/**
+ * @deprecated
+ */
+SupplierId?: (null | number)
+/**
+ * If `true`, activates the [Notify Me](https://help.vtex.com/en/tutorial/setting-up-the-notify-me-option--2VqVifQuf6Co2KG048Yu6e) option when the product is out of stock.
+ */
+ShowWithoutStock?: boolean
+/**
+ * @deprecated
+ * This is a legacy field. Do not take this information into consideration.
+ */
+AdWordsRemarketingCode?: string
+/**
+ * @deprecated
+ * This is a legacy field. Do not take this information into consideration.
+ */
+LomadeeCampaignCode?: string
+/**
+ * Value used to set the priority on the search result page.
+ */
+Score?: number
+}
+}
+/**
+ * Updates an existing Product.
+ */
+"PUT /api/catalog/pvt/product/:productId": {
+body: {
+/**
+ * Product's name. Limited to 150 characters.
+ */
+Name: string
 /**
  * Department ID according to the product's category.
  */
@@ -19653,6 +19648,66 @@ per_page: string
 }
 response: Userorderslist
 }
+/**
+ * Lists all details from an order, through the perspective of the customer who placed the order. 
+ * 
+ * > You can only access information from orders created in the last two years, and that same period is valid for customers through [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh). 
+ * 
+ * > Note that this request should be made by an [user](https://developers.vtex.com/docs/guides/user-authentication-and-login) or [an appKey / appToken pair](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) that is associated with the [Call center operator](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy#call-center-operator) role. Otherwise, it will return only orders from the same email informed in the `clientEmail` query parameter. 
+ * 
+ * ## Permissions
+ * 
+ * Any user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | OMS | OMS access | **View order** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Call center operator | View order |
+ * | OMS - Read only | View order |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). 
+ * 
+ * To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"GET /api/oms/user/orders/:orderId": {
+searchParams: {
+/**
+ * Customer email.
+ */
+clientEmail: string
+}
+response: Userorderdetails
+}
+}
+/**
+ * Object representing each document.
+ */
+export interface Document {
+/**
+ * Custom property.
+ */
+"{customProperty}"?: string
+/**
+ * Unique identifier of the document.
+ */
+id: string
+/**
+ * Unique identifier of the account.
+ */
+accountId: string
+/**
+ * Account name.
+ */
+accountName: string
+/**
+ * Two-letter string that identifies the data entity.
+ */
+dataEntityId: string
 }
 /**
  * Pickup point information.
@@ -22096,3 +22151,1620 @@ Facets: {
 
 }
 }
+export interface Userorderdetails {
+/**
+ * Order ID is a unique code that identifies an order.
+ */
+orderId: string
+/**
+ * Sequence is a six-digit string that follows the order ID. For example, in order `1268540501456-01 (501456)`, the sequence is `501456`.
+ */
+sequence: string
+/**
+ * Marketplace order ID.
+ */
+marketplaceOrderId: string
+/**
+ * Marketplace services endpoint.
+ */
+marketplaceServicesEndpoint: string
+/**
+ * ID of the seller related to the order. It can be a VTEX seller or an external seller.
+ */
+sellerOrderId: string
+/**
+ * Order's [origin in the order flow](https://developers.vtex.com/docs/guides/orders-overview#understanding-order-flow-types), which can be `Marketplace`, `Fulfillment` or `Chain`.
+ */
+origin: string
+/**
+ * Corresponds to the three-digit [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) identification code of the seller responsible for the order.
+ */
+affiliateId: string
+/**
+ * Sales channel (or [trade policy](https://help.vtex.com/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) ID related to the order.
+ */
+salesChannel: string
+/**
+ * Name of the merchant.
+ */
+merchantName: string
+/**
+ * Order [status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196).
+ */
+status: string
+/**
+ * Indicates if the order workflow is in an error state.
+ */
+workflowIsInError: boolean
+/**
+ * @deprecated
+ * `Deprecated`. Status description which is displayed on the Admin panel. This field is obsolete and may not return any value.
+ */
+statusDescription: string
+/**
+ * Order's total amount.
+ */
+value: number
+/**
+ * Order's creation date.
+ */
+creationDate: string
+/**
+ * Order's last change date.
+ */
+lastChange: string
+/**
+ * Order's group ID.
+ */
+orderGroup: string
+/**
+ * List with details about orders' totals.
+ */
+totals: Total[]
+/**
+ * Information about order's items.
+ */
+items: OrderItem[]
+/**
+ * Marketplace details object.
+ */
+marketplaceItems: string[]
+clientProfileData: ClientProfileData
+/**
+ * Information about gift list, when it applies.
+ */
+giftRegistryData: string
+/**
+ * Information about promotions and marketing. For example, coupon tracking information and internal or external UTMs.
+ */
+marketingData: {
+/**
+ * Object ID. The expected value is `marketingData`.
+ */
+id?: string
+/**
+ * Value of the `utm_source` parameter of the URL that led to the request.
+ */
+utmSource?: string
+/**
+ * UTM Source Parameters.
+ */
+utmPartner?: string
+/**
+ * Value of the `utm_medium` parameter of the URL that led to the request.
+ */
+utmMedium?: string
+/**
+ * Value of the `utm_campaign` parameter of the URL that led to the request.
+ */
+utmCampaign?: string
+/**
+ * Coupon code.
+ */
+coupon?: string
+/**
+ * Internal UTM value `utmi_cp`.
+ */
+utmiCampaign?: string
+/**
+ * Internal UTM value `utmi_p`.
+ */
+utmipage?: string
+/**
+ * Internal UTM value `utmi_pc`.
+ */
+utmiPart?: string
+/**
+ * Marketing tags information. This field can be used to register campaign data or informative tags regarding promotions.
+ */
+marketingTags?: string[]
+}
+ratesAndBenefitsData: RatesAndBenefitsData
+shippingData: ShippingData
+paymentData: PaymentData
+packageAttachment: PackageAttachment
+/**
+ * List of all sellers associated with the order.
+ */
+sellers: Seller[]
+/**
+ * Call center operator responsible for the order.
+ */
+callCenterOperatorData: string
+/**
+ * Email of the store's employee responsible for managing the order.
+ */
+followUpEmail: string
+/**
+ * Last sent transactional message.
+ */
+lastMessage: string
+/**
+ * Account Hostname registered in License Manager.
+ */
+hostname: string
+/**
+ * Information pertinent to the order's invoice.
+ */
+invoiceData: {
+
+}
+changesAttachment: ChangesAttachment
+/**
+ * Optional field with order's additional information. This field must be filled in using the following format: 
+ * 
+```
+ * 
+{
+ *     "fieldExample": "ValueExample"
+ *   }
+ * 
+```
+ * 
+.
+ */
+openTextField: string
+/**
+ * Rounding error total amount, if it applies. For example, in orders with a discount over non-integer multiplier items, the rounding price is performed per item, not after the sum of all items. That can cause a difference in the total discount amount, which is informed in this field.
+ */
+roundingError: number
+/**
+ * [Order form](https://developers.vtex.com/docs/guides/orderform-fields) ID.
+ */
+orderFormId: string
+/**
+ * Information about commercial conditions.
+ */
+commercialConditionData: string
+/**
+ * When set as `true`, the order's payment has been settled, and when set as `false`, it has not been settled yet.
+ */
+isCompleted: boolean
+/**
+ * Custom information in the order. This field is useful for storing data not included in other fields, for example, a message for a gift or a name to be printed in a shirt.
+ */
+customData: string
+storePreferencesData: StorePreferencesData
+/**
+ * When set as `true`, the order can be canceled, and when set as `false`, it is no longer possible to cancel the order.
+ */
+allowCancellation: boolean
+/**
+ * When set as `true`, the order can be edited, and when set as `false`, it is no longer possible to edit the order.
+ */
+allowEdition: boolean
+/**
+ * This field is set `true` when the order was made via inStore and `false` when it was not.
+ */
+isCheckedIn: boolean
+marketplace: Marketplace
+/**
+ * Authorized order date.
+ */
+authorizedDate: string
+/**
+ * Order's invoice date.
+ */
+invoicedDate: string
+/**
+ * Reason for order cancellation.
+ */
+cancelReason: string
+itemMetadata: ItemMetadata
+subscriptionData: SubscriptionData
+taxData: TaxData
+/**
+ * If the field `isCheckedIn` is set as `true`, the `checkedInPickupPointId` will retrieve the ID of the physical store where the order was made.
+ */
+checkedInPickupPointId: string
+cancellationData: CancellationData
+clientPreferencesData: ClientPreferencesData
+/**
+ * Details of cancellation requests made for the order.
+ */
+cancellationRequests: {
+/**
+ * ID of the cancellation request.
+ */
+id?: string
+/**
+ * Reason for the cancellation request.
+ */
+reason?: string
+/**
+ * Date when the cancellation was requested.
+ */
+cancellationRequestDate?: string
+/**
+ * Indicates if the request was made by the user.
+ */
+requestedByUser?: boolean
+/**
+ * Indicates if the cancellation request was denied by the seller.
+ */
+deniedBySeller?: boolean
+/**
+ * Reason for denial by the seller.
+ */
+deniedBySellerReason?: string
+/**
+ * Date when the cancellation request was denied.
+ */
+cancellationRequestDenyDate?: string
+}[]
+minItems?: 0
+}
+/**
+ * Object about order's totals.
+ */
+export interface Total {
+/**
+ * Code that identifies if the information is about `Items`, `Discounts`, `Shipping`, `Tax` or `Change`.
+ */
+id: string
+/**
+ * Name of `Items`, `Discounts`, `Shipping`, `Tax` or `Change`.
+ */
+name: string
+/**
+ * Total amount of `Items`, `Discounts`, `Shipping`, `Tax` or `Change`.
+ */
+value: number
+}
+/**
+ * Information about an individual item in the order.
+ */
+export interface OrderItem {
+/**
+ * Unique identifier for the item in the order.
+ */
+uniqueId: string
+/**
+ * SKU identifier of the item.
+ */
+id: string
+/**
+ * Product ID associated with the item.
+ */
+productId: string
+/**
+ * European Article Number (EAN) for the item, if applicable.
+ */
+ean: string
+/**
+ * Identifier to lock the item in the order.
+ */
+lockId: string
+/**
+ * Attachment details associated with the item.
+ */
+itemAttachment: {
+/**
+ * Content of the attachment.
+ */
+content?: {
+
+}
+/**
+ * Name of the attachment, if applicable.
+ */
+name?: string
+}
+/**
+ * Additional attachments for the item.
+ */
+attachments: {
+
+}[]
+/**
+ * Quantity of the item in the order.
+ */
+quantity: number
+/**
+ * Identifier of the seller providing the item.
+ */
+seller: string
+/**
+ * Name of the item as displayed to the customer.
+ */
+name: string
+/**
+ * Reference ID for the item.
+ */
+refId: string
+/**
+ * Price of the item.
+ */
+price: number
+/**
+ * List price of the item.
+ */
+listPrice: number
+/**
+ * Manually defined price for the item, if applicable.
+ */
+manualPrice: number
+/**
+ * Tags associated with the pricing of the item.
+ */
+priceTags: {
+
+}[]
+/**
+ * URL of the item's image.
+ */
+imageUrl: string
+/**
+ * URL for more details about the item.
+ */
+detailUrl: string
+/**
+ * List of components included with the item.
+ */
+components: {
+
+}[]
+/**
+ * Items bundled with this item.
+ */
+bundleItems: {
+
+}[]
+/**
+ * Parameters associated with the item.
+ */
+params: {
+
+}[]
+/**
+ * List of offerings related to the item.
+ */
+offerings: {
+
+}[]
+/**
+ * Offerings attached to the item.
+ */
+attachmentOfferings: {
+name?: string
+required?: boolean
+schema?: {
+
+}
+}[]
+/**
+ * SKU identifier as defined by the seller.
+ */
+sellerSku: string
+/**
+ * Date until the price is valid.
+ */
+priceValidUntil: string
+/**
+ * Commission on the item, if applicable.
+ */
+commission: number
+/**
+ * Tax applied to the item.
+ */
+tax: number
+/**
+ * Date when the item will be available for sale.
+ */
+preSaleDate: string
+/**
+ * Additional information about the item.
+ */
+additionalInfo: {
+/**
+ * Name of the brand associated with the item.
+ */
+brandName?: string
+/**
+ * ID of the brand associated with the item.
+ */
+brandId?: string
+/**
+ * String of category IDs associated with the item.
+ */
+categoriesIds?: string
+/**
+ * Product cluster ID for the item.
+ */
+productClusterId?: string
+/**
+ * ID of the commercial condition associated with the item.
+ */
+commercialConditionId?: string
+/**
+ * Dimensions of the item.
+ */
+dimension?: {
+/**
+ * Cubic weight of the item.
+ */
+cubicweight?: number
+/**
+ * Height of the item.
+ */
+height?: number
+/**
+ * Length of the item.
+ */
+length?: number
+/**
+ * Weight of the item.
+ */
+weight?: number
+/**
+ * Width of the item.
+ */
+width?: number
+}
+/**
+ * List of categories associated with the item.
+ */
+categories?: {
+/**
+ * ID of the category.
+ */
+id: number
+/**
+ * Name of the category.
+ */
+name: string
+}[]
+}
+/**
+ * Unit of measurement for the item.
+ */
+measurementUnit: string
+/**
+ * Multiplier for the measurement unit.
+ */
+unitMultiplier: number
+/**
+ * Final selling price of the item.
+ */
+sellingPrice: number
+/**
+ * Indicates if the item is a gift.
+ */
+isGift: boolean
+/**
+ * Shipping cost for the item, if applicable.
+ */
+shippingPrice: number
+/**
+ * Reward value associated with the item.
+ */
+rewardValue: number
+/**
+ * Freight commission on the item.
+ */
+freightCommission: number
+/**
+ * Detailed information about the item's price structure.
+ */
+priceDefinitions: {
+sellingPrices?: {
+value?: number
+quantity?: number
+}[]
+calculatedSellingPrice?: number
+total?: number
+}
+/**
+ * Tax code associated with the item.
+ */
+taxCode: string
+/**
+ * Index of the parent item, if this item is part of a bundle.
+ */
+parentItemIndex: number
+/**
+ * Assembly binding of the parent item, if applicable.
+ */
+parentAssemblyBinding: string
+/**
+ * ID of the call center operator handling the item.
+ */
+callCenterOperator: string
+/**
+ * Serial numbers associated with the item.
+ */
+serialNumbers: string
+/**
+ * List of assemblies related to the item.
+ */
+assemblies: {
+
+}[]
+/**
+ * Cost price of the item.
+ */
+costPrice: number
+}
+/**
+ * Object with information on the client's profile.
+ */
+export interface ClientProfileData {
+/**
+ * Object ID, the expected value is `clientProfileData`.
+ */
+id: string
+/**
+ * Customer's email.
+ */
+email: string
+/**
+ * Customer's first name.
+ */
+firstName: string
+/**
+ * Customer's last name.
+ */
+lastName: string
+/**
+ * Type of the document informed by the customer.
+ */
+documentType: string
+/**
+ * Document identification code informed by the customer.
+ */
+document: string
+/**
+ * Customers's phone number.
+ */
+phone: string
+/**
+ * If the customer is a legal entity, here goes the corporate name.
+ */
+corporateName: string
+/**
+ * If the customer is a legal entity, here goes the trade name.
+ */
+tradeName: string
+/**
+ * If the customer is a legal entity, here goes the corporate document.
+ */
+corporateDocument: string
+/**
+ * If the customer is a legal entity, here goes the state inscription.
+ */
+stateInscription: string
+/**
+ * If the customer is a legal entity, here goes the corpany's phone number.
+ */
+corporatePhone: string
+/**
+ * The value is `true` when the customer is a legal entity and `false` when not.
+ */
+isCorporate: boolean
+/**
+ * Customer user profile ID.
+ */
+userProfileId: string
+/**
+ * Identification of the class the customer belongs to.
+ */
+customerClass: string
+}
+/**
+ * Information on promotions and taxes that apply to the order.
+ */
+export interface RatesAndBenefitsData {
+/**
+ * ID of the rate or benefit.
+ */
+id: string
+/**
+ * Information about order's promotions and taxes identifiers.
+ */
+rateAndBenefitsIdentifiers: string[]
+}
+/**
+ * Object containing shipping data.
+ */
+export interface ShippingData {
+/**
+ * Object ID, the expected value is `shippingData`.
+ */
+id: string
+address: Address
+/**
+ * Array of objects containing item's logistics information.
+ */
+logisticsInfo: LogisticsInfo[]
+trackingHints: string
+/**
+ * Information about selected adresses.
+ */
+selectedAddresses: SelectedAddress[]
+}
+/**
+ * Shipping address details.
+ */
+export interface Address {
+/**
+ * Type of address. For example, `Residential` or `Pickup`, among others.
+ */
+addressType: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName: string
+/**
+ * Shipping address ID.
+ */
+addressId: string
+/**
+ * Shipping address version ID.
+ */
+versionId: string
+/**
+ * Shipping address entity ID.
+ */
+entityId: string
+/**
+ * Postal code of the shipping address.
+ */
+postalCode: string
+/**
+ * City of the shipping address.
+ */
+city: string
+/**
+ * State of the shipping address.
+ */
+state: string
+/**
+ * Three letters ISO code of the country of the shipping address (ISO 3166 ALPHA-3).
+ */
+country: string
+/**
+ * Street of the shipping address.
+ */
+street: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood: string
+/**
+ * Complement to the shipping address when it applies.
+ */
+complement: string
+/**
+ * Complement to help locate the shipping address, in case of delivery.
+ */
+reference: string
+/**
+ * Array with two numbers with geocoordinates, first longitude then latitude.
+ */
+geoCoordinates: number[]
+}
+export interface LogisticsInfo {
+/**
+ * Index of the item starting from 0.
+ */
+itemIndex: number
+/**
+ * Selected shipping option.
+ */
+selectedSla: string
+/**
+ * Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time.
+ */
+lockTTL: string
+/**
+ * Shipping price for the item in cents. Does not account for the whole order's shipping price.
+ */
+price: number
+/**
+ * SKU's optional price for a specific trade policy.
+ */
+listPrice: number
+/**
+ * Item's selling price.
+ */
+sellingPrice: number
+/**
+ * [Scheduled delivery](https://help.vtex.com/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) window information, if it applies to the item.
+ */
+deliveryWindow: string
+/**
+ * [Carrier](https://help.vtex.com/en/tutorial/transportadoras-na-vtex--7u9duMD5UQa2QQwukAWMcE) company's name.
+ */
+deliveryCompany: string
+/**
+ * Total shipping estimate time in days. For instance, three business days is represented `3bd`.
+ */
+shippingEstimate: string
+/**
+ * Shipping estimate date. It is defined only after the confirmation of the order.
+ */
+shippingEstimateDate: string
+/**
+ * Information on Service Level Agreement (SLA), corresponding to [shipping policies](https://help.vtex.com/tutorial/shipping-policy--tutorials_140).
+ */
+slas: Sla[]
+/**
+ * Three letters ISO code of the country of the shipping address (ISO 3166 ALPHA-3).
+ */
+shipsTo: string[]
+/**
+ * Information about delivery IDs.
+ */
+deliveryIds: DeliveryId[]
+/**
+ * List of delivery channels associated with the trade policy.
+ */
+deliveryChannels: {
+/**
+ * Delivery channel's shipping type, which can be `delivery` or `pickup-in-point`.
+ */
+id: string
+/**
+ * Stock check for an SKU availability.
+ */
+stockBalance: number
+}[]
+/**
+ * If the delivery channel is `delivery` or `pickup-in-point`.
+ */
+deliveryChannel: string
+pickupStoreInfo: PickupStoreInfo
+/**
+ * Address ID.
+ */
+addressId: string
+/**
+ * Shipping address version ID.
+ */
+versionId: string
+/**
+ * Shipping address entity ID.
+ */
+entityId: string
+/**
+ * Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.
+ */
+polygonName: string
+/**
+ * [Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R)'s ID.
+ */
+pickupPointId: string
+/**
+ * Duration in business days of the time the carrier takes in transit to fulfill the order. For example, three business days is represented `3bd`.
+ */
+transitTime: string
+}
+export interface Sla {
+/**
+ * ID of the shipping method used in the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).
+ */
+id: string
+/**
+ * Name of the shipping policy.
+ */
+name: string
+/**
+ * Total shipping estimate time in days. For instance, three business days is represented `3bd`.
+ */
+shippingEstimate: string
+/**
+ * [Scheduled delivery window](https://help.vtex.com/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, if it applies to the item.
+ */
+deliveryWindow: string
+/**
+ * Shipping price for the item in cents. Does not account for the whole order's shipping price.
+ */
+price: number
+/**
+ * If the delivery channel is `delivery` or `pickup-in-point`.
+ */
+deliveryChannel: string
+pickupStoreInfo: PickupStoreInfo
+/**
+ * Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.
+ */
+polygonName: string
+/**
+ * Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time of the SLA.
+ */
+lockTTL: string
+/**
+ * [Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID related to the SLA.
+ */
+pickupPointId: string
+/**
+ * Duration in business days of the time the carrier takes in transit to fulfill the order. For example, three business days is represented `3bd`.
+ */
+transitTime: string
+/**
+ * Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line.
+ */
+pickupDistance: number
+}
+/**
+ * Detailed information about a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).
+ */
+export interface PickupStoreInfo {
+/**
+ * Additional information about the pickup point.
+ */
+additionalInfo: string
+/**
+ * Pickup point's address.
+ */
+address: string
+/**
+ * ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj) related to the delivery or the pickup point.
+ */
+dockId: string
+/**
+ * Name of the pickup point displayed at checkout.
+ */
+friendlyName: string
+/**
+ * If this field is set `true`, it means the type of shipping is pickup, and if set as `false`, it is not.
+ */
+isPickupStore: boolean
+}
+/**
+ * Information about delivery IDs.
+ */
+export interface DeliveryId {
+/**
+ * [Carrier](https://help.vtex.com/en/tutorial/transportadoras-na-vtex--7u9duMD5UQa2QQwukAWMcE)'s ID.
+ */
+courierId: string
+/**
+ * Carrier's name.
+ */
+courierName: string
+/**
+ * ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj).
+ */
+dockId: string
+/**
+ * Quantity of items.
+ */
+quantity: number
+/**
+ * ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).
+ */
+warehouseId: string
+/**
+ * Name of the account's [carrier](https://help.vtex.com/en/tutorial/transportadoras-na-vtex--7u9duMD5UQa2QQwukAWMcE).
+ */
+accountCarrierName: string
+/**
+ * Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28), if there are any.
+ */
+kitItemDetails: string[]
+}
+export interface SelectedAddress {
+/**
+ * Selected address ID.
+ */
+addressId: string
+/**
+ * Shipping address version ID of the selected address.
+ */
+versionId: string
+/**
+ * Shipping address entity ID  of the selected address.
+ */
+entityId: string
+/**
+ * Selected adress's shipping type, which can be `pickup`, `residential`, `invoice`, `search`, `inStore`, `commercial` or `giftRegistry`.
+ */
+addressType: string
+/**
+ * Name of the person who is going to receive the order in the selected address.
+ */
+receiverName: string
+/**
+ * Street of the selected address.
+ */
+street: string
+/**
+ * Number of the building, house or apartment of the selected address.
+ */
+number: string
+/**
+ * Complement to the selected address if it applies.
+ */
+complement: string
+/**
+ * Neighborhood of the selected address.
+ */
+neighborhood: string
+/**
+ * Postal code of the selected address.
+ */
+postalCode: string
+/**
+ * City of the selected address.
+ */
+city: string
+/**
+ * State of the selected address.
+ */
+state: string
+/**
+ * Three letters ISO code of the country of the selected address (ISO 3166 ALPHA-3).
+ */
+country: string
+/**
+ * Complement to help locate the selected address.
+ */
+reference: string
+/**
+ * Array with two numbers with the selected address's geocoordinates, first longitude then latitude.
+ */
+geoCoordinates: number[]
+}
+/**
+ * Object with information about the payment.
+ */
+export interface PaymentData {
+/**
+ * Array with information about Gift Cards.
+ */
+giftCards?: string[]
+/**
+ * Information about financial transactions.
+ */
+transactions: Transaction[]
+}
+/**
+ * Financial transaction details.
+ */
+export interface Transaction {
+/**
+ * When this field is set as `true`, the payment is active, and when it is `false`, the payment is inactive.
+ */
+isActive: boolean
+/**
+ * ID of the transaction.
+ */
+transactionId: string
+/**
+ * Name of the merchant that will receive the payment.
+ */
+merchantName: string
+/**
+ * Detailed information about payment.
+ */
+payments: Payment[]
+}
+/**
+ * Payment details.
+ */
+export interface Payment {
+/**
+ * VTEX payment ID that can be used as unique identifier.
+ */
+id: string
+/**
+ * Payment system's ID.
+ */
+paymentSystem: string
+/**
+ * Payment system's name.
+ */
+paymentSystemName: string
+/**
+ * Payment's final amount in cents.
+ */
+value: number
+/**
+ * Number of payment installments.
+ */
+installments: number
+/**
+ * Payment's reference value in cents.
+ */
+referenceValue: number
+/**
+ * Name of the person who owns the card.
+ */
+cardHolder: string
+/**
+ * Numeric sequence of the card used in the transaction.
+ */
+cardNumber: string
+/**
+ * Fist digits of the card used in the transaction.
+ */
+firstDigits: string
+/**
+ * Last digits of the card used in the transaction.
+ */
+lastDigits: string
+/**
+ * Card Verification Value (CVV2) is a security code used by payment processors to reduce fraudulent credit and debit card transactions.
+ */
+cvv2: string
+/**
+ * Expire month of the card used in the transaction (2-digits).
+ */
+expireMonth: string
+/**
+ * Expire year of the card used in the transaction (4-digits).
+ */
+expireYear: string
+/**
+ * Payment's URL.
+ */
+url: string
+/**
+ * Gift Card's ID.
+ */
+giftCardId: string
+/**
+ * Gift Card's name.
+ */
+giftCardName: string
+/**
+ * Gift Card's caption.
+ */
+giftCardCaption: string
+/**
+ * Code for the customer to use the Gift Card.
+ */
+redemptionCode: string
+/**
+ * Name of the collection the Gift Card belongs to.
+ */
+group: string
+/**
+ * Provider's unique identifier for the transaction.
+ */
+tid: string
+/**
+ * Payment due date, with the format `yyyy-mm-dd`.
+ */
+dueDate: string
+/**
+ * Information about the connector responses.
+ */
+connectorResponses: {
+/**
+ * Provider's unique identifier for the transaction.
+ */
+Tid: string
+/**
+ * Provider's operation/error code to be logged.
+ */
+ReturnCode: string
+/**
+ * Provider's operation/error message to be logged.
+ */
+Message: string
+/**
+ * Connector's authorization ID.
+ */
+authId: string
+}
+/**
+ * Gift Card provider's ID.
+ */
+giftCardProvider: string
+/**
+ * When this field is set as `true`, the Gift Card is a discount over the price, and when set as `false`, it is not a discount.
+ */
+giftCardAsDiscount: boolean
+/**
+ * Payment's account ID.
+ */
+koinUrl: string
+/**
+ * Payment's account ID.
+ */
+accountId: string
+/**
+ * This field retrieves the main account if the payment was made in a subaccount.
+ */
+parentAccountId: string
+/**
+ * Numeric sequence that identifies the bank issued invoice.
+ */
+bankIssuedInvoiceIdentificationNumber: string
+/**
+ * Bank issued invoice ID formatted.
+ */
+bankIssuedInvoiceIdentificationNumberFormatted: string
+/**
+ * Number of the bank issued invoice bar code.
+ */
+bankIssuedInvoiceBarCodeNumber: string
+/**
+ * Type of the bank issued invoice bar code.
+ */
+bankIssuedInvoiceBarCodeType: string
+/**
+ * Billing address information.
+ */
+billingAddress: {
+
+}
+}
+/**
+ * Package object populated after order invoiced.
+ */
+export interface PackageAttachment {
+/**
+ * Details of each package in the order.
+ */
+packages: Package[]
+}
+/**
+ * Details of an individual package in the order.
+ */
+export interface Package {
+/**
+ * Fiscal operation code for the package.
+ */
+cfop: string
+/**
+ * Invoice number associated with the package.
+ */
+invoiceNumber: string
+/**
+ * Total value of the invoice.
+ */
+invoiceValue: number
+/**
+ * URL for the invoice, if available.
+ */
+invoiceUrl: string
+/**
+ * Date when the invoice was issued.
+ */
+issuanceDate: string
+/**
+ * Tracking number for the package, if available.
+ */
+trackingNumber: string
+/**
+ * Unique key for the invoice.
+ */
+invoiceKey: string
+/**
+ * URL for tracking the package, if available.
+ */
+trackingUrl: string
+/**
+ * Embedded invoice data.
+ */
+embeddedInvoice: string
+/**
+ * Current status of the courier handling the package.
+ */
+courierStatus: {
+/**
+ * Status of the courier, if available.
+ */
+status: string
+/**
+ * Indicates if the delivery process is finished.
+ */
+finished: boolean
+/**
+ * Date the package was delivered, if applicable.
+ */
+deliveredDate: string
+}
+/**
+ * Type of package, either 'Input' or 'Output'.
+ */
+type: ("Input" | "Output")
+}
+/**
+ * Information about the seller associated with the order.
+ */
+export interface Seller {
+/**
+ * Seller ID that identifies the seller.
+ */
+id: string
+/**
+ * Seller's name.
+ */
+name: string
+/**
+ * URL of the seller's logo.
+ */
+logo: string
+/**
+ * URL of the endpoint for fulfillment of seller's orders.
+ */
+fulfillmentEndpoint: string
+}
+/**
+ * Information about changes in the order.
+ */
+export interface ChangesAttachment {
+/**
+ * Object ID, the expect value is `changeAttachment`.
+ */
+id: string
+/**
+ * Order change details.
+ */
+changesData: ChangesDatum[]
+}
+export interface ChangesDatum {
+/**
+ * Text explaining why there was a change in the order. This information may be shown to the customer in the UI or transactional emails.
+ */
+reason: string
+/**
+ * Order change discount value.
+ */
+discountValue: number
+/**
+ * Order change increment value.
+ */
+incrementValue: number
+/**
+ * List of items added to the order.
+ */
+itemsAdded: string[]
+/**
+ * List of items removed from the order.
+ */
+itemsRemoved: ItemsRemoved[]
+receipt: Receipt
+}
+export interface ItemsRemoved {
+/**
+ * SKU ID of the item removed from the order.
+ */
+id: string
+/**
+ * Name of the item removed from the order.
+ */
+name: string
+/**
+ * Quantity of items removed from the order.
+ */
+quantity: number
+/**
+ * Total amount of items removed from the order.
+ */
+price: number
+/**
+ * Unit multiplier of the item removed from the order.
+ */
+unitMultiplier: string
+}
+/**
+ * Information about the receipt for changed orders.
+ */
+export interface Receipt {
+/**
+ * Date when the receipt was created.
+ */
+date: string
+/**
+ * ID of the order.
+ */
+orderId: string
+/**
+ * Receipt's unique identifier code.
+ */
+receipt: string
+}
+/**
+ * Object with data from the store's configuration - stored in VTEX's License Manager.
+ */
+export interface StorePreferencesData {
+/**
+ * Three letters ISO code of the country (ISO 3166 ALPHA-3).
+ */
+countryCode: string
+/**
+ * Currency code in ISO 4217. For example, `BRL`.
+ */
+currencyCode: string
+currencyFormatInfo: CurrencyFormatInfo
+/**
+ * Currency Locale Code in LCID in decimal.
+ */
+currencyLocale: number
+/**
+ * Currency symbol.
+ */
+currencySymbol: string
+/**
+ * Time zone from where the order was made.
+ */
+timeZone: string
+}
+/**
+ * Object with currency format details.
+ */
+export interface CurrencyFormatInfo {
+/**
+ * Quantity of currency decimal digits.
+ */
+CurrencyDecimalDigits: number
+/**
+ * Defines what currency decimal separator will be applied.
+ */
+CurrencyDecimalSeparator: string
+/**
+ * Defines what currency group separator will be applied.
+ */
+CurrencyGroupSeparator: string
+/**
+ * Defines how many characters will be grouped.
+ */
+CurrencyGroupSize: number
+/**
+ * Defines if all prices will be initiated with the currency symbol (`true`) or not (`false`).
+ */
+StartsWithCurrencySymbol: boolean
+}
+/**
+ * Details about the marketplace related to the order.
+ */
+export interface Marketplace {
+/**
+ * Marketplace base URL.
+ */
+baseURL: string
+/**
+ * If is a certified marketplace.
+ */
+isCertified: string
+/**
+ * Name of the marketplace.
+ */
+name: string
+}
+/**
+ * Metadata information about the order's items.
+ */
+export interface ItemMetadata {
+/**
+ * Metadata items.
+ */
+Items: {
+/**
+ * Item's SKU ID, which is a unique numerical identifier.
+ */
+Id: string
+/**
+ * Seller ID that identifies the seller the item belongs to.
+ */
+Seller: string
+/**
+ * Name of the item as displayed to customers in the storefront.
+ */
+Name: string
+/**
+ * Name of the SKU corresponding to the item.
+ */
+SkuName: string
+/**
+ * ID of the Product associated with the item.
+ */
+ProductId: string
+/**
+ * Item's reference ID.
+ */
+RefId: string
+/**
+ * EAN of the item.
+ */
+Ean: string
+/**
+ * Item's SKU image URL.
+ */
+ImageUrl: string
+/**
+ * URL slug of the item.
+ */
+DetailUrl: string
+/**
+ * Displays information about assembly options related to the item, if there are any.
+ */
+AssemblyOptions: {
+/**
+ * ID of the attachment related to the order.
+ */
+Id: string
+/**
+ * Name of the attachment related to the order.
+ */
+Name: string
+/**
+ * Indicates if sending the attachment is required.
+ */
+Required: boolean
+/**
+ * Displays the attachment's content.
+ */
+InputValues: {
+
+}
+/**
+ * Displays the attachment's composition.
+ */
+Composition: {
+
+}
+}[]
+}[]
+}
+/**
+ * Information about subscriptions.
+ */
+export interface SubscriptionData {
+/**
+ * ID of the subscription's group. If this field returns `null` and the `executionCount` is `0`, the order is the first one with subscriptions.
+ */
+SubscriptionGroupId: string
+/**
+ * List with subscriptions and their details.
+ */
+Subscriptions: {
+/**
+ * Position of the order in the subscription cycle.
+ */
+ExecutionCount: number
+/**
+ * Price of the order at the subscription start date.
+ */
+PriceAtSubscriptionDate: number
+/**
+ * Each item in the subscriptions' order is identified by an index.
+ */
+ItemIndex: number
+/**
+ * Information about the subscription's validity and frequency.
+ */
+Plan: {
+/**
+ * Type of plan.
+ */
+type: string
+/**
+ * Information about subscriptions' recurrence.
+ */
+frequency: {
+/**
+ * Defines the subscriptions recurrence period.
+ */
+periodicity: string
+/**
+ * Interval between subscription orders, depending on the periodicity.
+ */
+interval: number
+}
+/**
+ * Information about the period during which the subscription will be valid.
+ */
+validity: {
+/**
+ * Subscription's start date in ISO 8601 format.
+ */
+begin: string
+/**
+ * Subscription's end date in ISO 8601 format.
+ */
+end: string
+}
+}
+}[]
+}
+/**
+ * Order's tax information.
+ */
+export interface TaxData {
+/**
+ * Indicates if the taxes were designated by the marketplace (`true`) or not (`false`).
+ */
+areTaxesDesignatedByMarketplace: boolean
+/**
+ * Array with detailed tax information for each item.
+ */
+taxInfoCollection: {
+/**
+ * Index number of the item in the order.
+ */
+itemIndex: number
+/**
+ * Alphanumeric sequence that identifies the item's SKU.
+ */
+sku: string
+/**
+ * List of price tags associated with taxes for the item.
+ */
+priceTags: {
+/**
+ * Indicates if the tax is a percentage (`true`) or a fixed amount (`false`).
+ */
+isPercentual: boolean
+/**
+ * Name of the tax.
+ */
+name: string
+/**
+ * Amount associated with the tax, in raw format.
+ */
+rawValue: string
+}[]
+}[]
+}
+/**
+ * Information about order cancellation, when it applies.
+ */
+export interface CancellationData {
+/**
+ * Indicates if the order cancellation was requested by the customer (`true`) or not (`false`).
+ */
+RequestedByUser: boolean
+/**
+ * Indicates if the order cancellation was made by the system (`true`) or not (`false`).
+ */
+RequestedBySystem: boolean
+/**
+ * Indicates if the order cancellation was requested by the seller (`true`) or not (`false`).
+ */
+RequestedBySellerNotification: boolean
+/**
+ * Indicates if the order cancellation was requested by the payment gateway (`true`) or not (`false`).
+ */
+RequestedByPaymentNotification: boolean
+/**
+ * The reason provided for the cancellation of the order.
+ */
+Reason: string
+/**
+ * The date and time when the order was canceled, in ISO 8601 format.
+ */
+CancellationDate: string
+}
+/**
+ * Information about the customer's preferences.
+ */
+export interface ClientPreferencesData {
+/**
+ * Customer's preferred language in the store, typically represented by a locale code (e.g., 'en-US').
+ */
+locale: string
+/**
+ * Indicates if the customer opted to receive newsletters (`true` for yes, `false` for no).
+ */
+optinNewsLetter: boolean
+}
diff --git a/vtex/utils/openapi/vcs.openapi.json b/vtex/utils/openapi/vcs.openapi.json
index e8a08bafa..b8b013298 100644
--- a/vtex/utils/openapi/vcs.openapi.json
+++ b/vtex/utils/openapi/vcs.openapi.json
@@ -1052,6 +1052,204 @@
         }
       }
     },
+    "/api/dataentities/{acronym}/documents/{id}": {
+      "get": {
+        "tags": [
+          "Documents"
+        ],
+        "summary": "Get document",
+        "description": "Retrieves a document.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Read only documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "Getdocument",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/Content-Type"
+          },
+          {
+            "$ref": "#/components/parameters/Accept"
+          },
+          {
+            "$ref": "#/components/parameters/acronym"
+          },
+          {
+            "$ref": "#/components/parameters/id"
+          },
+          {
+            "$ref": "#/components/parameters/fields"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Document"
+                },
+                "example": {
+                  "id": "2f5dde81-1613-11ea-82ee-12f868feb457",
+                  "accountId": "a8b27fb4-6516-4cc0-82b6-a5f2b011e6e2",
+                  "accountName": "apiexamples",
+                  "dataEntityId": "AS"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Forbidden",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "description": "Error response body.",
+                  "type": "object",
+                  "properties": {
+                    "Message": {
+                      "description": "Error message.",
+                      "type": "string"
+                    }
+                  }
+                },
+                "example": {
+                  "Message": "Cannot read private fields"
+                }
+              }
+            }
+          }
+        }
+      },
+      "put": {
+        "tags": [
+          "Documents"
+        ],
+        "summary": "Create document with custom ID or update entire document",
+        "description": "Creates a new document with a custom ID, or updates an entire document if there is already a document with the informed ID.\r\n\r\n>ℹ️ You can use this request to create or update documents in any given data entity. Because of this, you are not restricted to using the fields exemplified below in your requests. But you should be aware of the fields allowed or required for each document you wish to update.\r\n\r\n## Custom field types\r\n\r\nThe table below presents the types of custom fields you can use when creating or updating documents in Master Data v1 and example values.\r\n\r\n| Field Type| Example value |\r\n| - | - |\r\n| Boolean | `true` |\r\n| Currency | `2.5` |\r\n| Date | `1992-11-17` |\r\n| Date_Time | `2016-09-14T19:21:01.3163733Z` |\r\n| Decimal | `2.5` |\r\n| Email | `meu@email.com` |\r\n| Integer | `1000000` |\r\n| Long | `1000000000` |\r\n| Percent | `85.42` |\r\n| Time | `23:50` |\r\n| URL | `https://www.vtex.com` |\r\n| Varchar10 | `Lorem ipsu` |\r\n| Varchar50 | `Lorem ipsum dolor sit amet, consectetur adipiscing` |\r\n| Varchar750  | `Lorem ipsum dolor sit amet, consectetur adipiscing elit...` |\r\n| Varchar100  | `Lorem ipsum dolor sit amet, consectetur adipiscing elit...` |\r\n| Relationship | `5eb31afb-7ab0-11e6-94b4-0a44686e393f` |\r\n| Text | `Lorem ipsum dolor sit amet, consectetur adipiscing elit...` |\r\n \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "Updateentiredocument",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/Content-Type"
+          },
+          {
+            "$ref": "#/components/parameters/Accept"
+          },
+          {
+            "$ref": "#/components/parameters/acronym"
+          },
+          {
+            "$ref": "#/components/parameters/id"
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "description": "Object with document fields and their respective values.",
+                "additionalProperties": true,
+                "properties": {
+                  "{fieldName}": {
+                    "type": "string",
+                    "description": "Field name and value.",
+                    "example": "{fieldValue}"
+                  }
+                }
+              },
+              "example": {
+                "Boolean": true,
+                "Currency": 2.5,
+                "Date": "1992-11-17",
+                "Date_Time": "2016-09-14T19:21:01.3163733Z",
+                "Decimal": 2.5,
+                "Email": "meu@email.com",
+                "Integer": 1000000,
+                "Long": 1000000000,
+                "Percent": 85.42,
+                "Time": "23:50",
+                "URL": "http://www.vtex.com",
+                "Varchar10": "Lorem ipsu",
+                "Varchar50": "Lorem ipsum dolor sit amet, consectetur adipiscing",
+                "Varchar750": "Lorem ipsum dolor sit amet, consectetur adipiscing elit...",
+                "Varchar100": "Lorem ipsum dolor sit amet, consectetur adipiscing elit...",
+                "Relationship": "5eb31afb-7ab0-11e6-94b4-0a44686e393f",
+                "Text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit..."
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "204": {
+            "description": "No Content"
+          }
+        }
+      },
+      "patch": {
+        "tags": [
+          "Documents"
+        ],
+        "summary": "Update partial document",
+        "description": "Updates a subset of fields of a document, without impacting the other fields.\r\n\r\n>ℹ️ You can use this request to update documents in any given data entity. Because of this, you are not restricted to using the fields exemplified below in your requests. But you should be aware of the fields allowed or required for each document you wish to update. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Insert or update document (not remove)** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "Updatepartialdocument",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/Content-Type"
+          },
+          {
+            "$ref": "#/components/parameters/Accept"
+          },
+          {
+            "$ref": "#/components/parameters/acronym"
+          },
+          {
+            "$ref": "#/components/parameters/id"
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "description": "Object with the fields to be updated and their respective values."
+              },
+              "example": {
+                "addressName": "4726026151253"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "204": {
+            "description": "No Content"
+          }
+        }
+      },
+      "delete": {
+        "tags": [
+          "Documents"
+        ],
+        "summary": "Delete document",
+        "description": "Deletes a document. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Dynamic Storage | Dynamic storage generic resources | **Full access to all documents** |\r\n| Dynamic Storage | Dynamic storage generic resources | **Master Data administrator** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>\u2757 To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "Deletedocument",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/Content-Type"
+          },
+          {
+            "$ref": "#/components/parameters/Accept"
+          },
+          {
+            "$ref": "#/components/parameters/acronym"
+          },
+          {
+            "$ref": "#/components/parameters/id"
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "No Content"
+          }
+        }
+      }
+    },
     "/api/logistics/pvt/inventory/skus/{skuId}": {
       "get": {
         "parameters": [
@@ -38533,7 +38731,9 @@
     },
     "/api/oms/user/orders": {
       "get": {
-        "tags": ["User orders"],
+        "tags": [
+          "User orders"
+        ],
         "summary": "Retrieve user's orders",
         "description": "Lists all orders from a given customer, filtering by their email. \r\n\r\n> You can only access information from orders created in the last two years, and that same period is valid for customers through [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh). \r\n\r\n> Note that this request should be made by an [user](https://developers.vtex.com/docs/guides/user-authentication-and-login) or [an appKey / appToken pair](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) that is associated with the [Call center operator](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy#call-center-operator) role. Otherwise, it will return only orders from the same email informed in the `clientEmail` query parameter. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **View order** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Call center operator | View order |\r\n| OMS - Read only | View order |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). \r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
         "operationId": "Userorderslist",
@@ -39045,6 +39245,636 @@
           }
         }
       }
+    },
+    "/api/oms/user/orders/{orderId}": {
+      "get": {
+        "tags": [
+          "User orders"
+        ],
+        "summary": "Retrieve user order details",
+        "description": "Lists all details from an order, through the perspective of the customer who placed the order. \r\n\r\n> You can only access information from orders created in the last two years, and that same period is valid for customers through [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh). \r\n\r\n> Note that this request should be made by an [user](https://developers.vtex.com/docs/guides/user-authentication-and-login) or [an appKey / appToken pair](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) that is associated with the [Call center operator](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy#call-center-operator) role. Otherwise, it will return only orders from the same email informed in the `clientEmail` query parameter. \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **View order** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Call center operator | View order |\r\n| OMS - Read only | View order |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). \r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "Userorderdetails",
+        "parameters": [
+          {
+            "name": "clientEmail",
+            "in": "query",
+            "description": "Customer email.",
+            "required": true,
+            "style": "form",
+            "explode": true,
+            "schema": {
+              "type": "string",
+              "example": "customer@mail.com"
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "orderId",
+            "in": "path",
+            "description": "Order ID is a unique code that identifies an order.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "1172452900788-01"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Userorderdetails"
+                },
+                "example": {
+                  "orderId": "1172452900788-01",
+                  "sequence": "502556",
+                  "marketplaceOrderId": "",
+                  "marketplaceServicesEndpoint": "http://oms.vtexinternal.com.br/api/oms?an=luxstore",
+                  "sellerOrderId": "00-v502556llux-01",
+                  "origin": "Marketplace",
+                  "affiliateId": "GHB",
+                  "salesChannel": "1",
+                  "merchantName": "luxstore",
+                  "status": "handling",
+                  "statusDescription": "Preparando Entrega",
+                  "value": 1160,
+                  "creationDate": "2019-01-28T20:09:43.899958+00:00",
+                  "lastChange": "2019-02-06T20:46:11.7010747+00:00",
+                  "orderGroup": "v502556lspt",
+                  "totals": [
+                    {
+                      "id": "Items",
+                      "name": "Total dos Itens",
+                      "value": 3290
+                    },
+                    {
+                      "id": "Discounts",
+                      "name": "Total dos Descontos",
+                      "value": 0
+                    },
+                    {
+                      "id": "Shipping",
+                      "name": "Total do Frete",
+                      "value": 1160
+                    },
+                    {
+                      "id": "Tax",
+                      "name": "Total da Taxa",
+                      "value": 0
+                    },
+                    {
+                      "id": "Change",
+                      "name": "Total das mudanças",
+                      "value": -3290
+                    }
+                  ],
+                  "items": [
+                    {
+                      "uniqueId": "87F0945396994B349158C7D9C9941442",
+                      "id": "256",
+                      "productId": "9429485",
+                      "ean": "3256873",
+                      "lockId": "00-v502556llux-01",
+                      "itemAttachment": {
+                        "content": {},
+                        "name": null
+                      },
+                      "attachments": [],
+                      "quantity": 1,
+                      "seller": "1",
+                      "name": "Bay Max L",
+                      "refId": "BIGHEROBML",
+                      "price": 3290,
+                      "listPrice": 3290,
+                      "manualPrice": null,
+                      "priceTags": [],
+                      "imageUrl": "http://luxstore.vteximg.com.br/arquivos/ids/159263-55-55/image-cc1aed75cbfa424a85a94900be3eacec.jpg?v=636795432619830000",
+                      "detailUrl": "/bay-max-9429485/p",
+                      "components": [],
+                      "bundleItems": [],
+                      "params": [],
+                      "offerings": [],
+                      "attachmentOfferings": [
+                        {
+                          "name": "vtex.subscription.weekly",
+                          "required": false,
+                          "schema": {
+                            "vtex.subscription.key.frequency": {
+                              "MaximumNumberOfCharacters": 7,
+                              "Domain": [
+                                "1 week",
+                                " 2 week",
+                                " 3 week",
+                                " 4 week"
+                              ]
+                            }
+                          }
+                        }
+                      ],
+                      "sellerSku": "1234568358",
+                      "priceValidUntil": null,
+                      "commission": 0,
+                      "tax": 0,
+                      "preSaleDate": null,
+                      "additionalInfo": {
+                        "brandName": "VTEX",
+                        "brandId": "2000023",
+                        "categoriesIds": "/1/",
+                        "categories": [
+                          {
+                            "id": 12770,
+                            "name": "Backpacks"
+                          },
+                          {
+                            "id": 2000126,
+                            "name": "Packs & Duffel Bags"
+                          },
+                          {
+                            "id": 2000003,
+                            "name": "Accessories"
+                          }
+                        ],
+                        "productClusterId": "135,142",
+                        "commercialConditionId": "5",
+                        "dimension": {
+                          "cubicweight": 0.7031,
+                          "height": 15,
+                          "length": 15,
+                          "weight": 15,
+                          "width": 15
+                        },
+                        "offeringInfo": null,
+                        "offeringType": null,
+                        "offeringTypeId": null
+                      },
+                      "measurementUnit": "un",
+                      "unitMultiplier": 1,
+                      "sellingPrice": 3290,
+                      "isGift": false,
+                      "shippingPrice": null,
+                      "rewardValue": 0,
+                      "freightCommission": 0,
+                      "priceDefinitions": {
+                        "sellingPrices": [
+                          {
+                            "value": 99,
+                            "quantity": 1
+                          }
+                        ],
+                        "calculatedSellingPrice": 99,
+                        "total": 99
+                      },
+                      "taxCode": null,
+                      "parentItemIndex": null,
+                      "parentAssemblyBinding": null,
+                      "callCenterOperator": "callCenterOp5473869",
+                      "serialNumbers": "3",
+                      "assemblies": [],
+                      "costPrice": 52
+                    }
+                  ],
+                  "marketplaceItems": [],
+                  "clientProfileData": {
+                    "id": "clientProfileData",
+                    "email": "rodrigo.cunha@vtex.com.br",
+                    "firstName": "Rodrigo",
+                    "lastName": "Cunha",
+                    "documentType": "cpf",
+                    "document": "11047867702",
+                    "phone": "+5521972321094",
+                    "corporateName": null,
+                    "tradeName": null,
+                    "corporateDocument": null,
+                    "stateInscription": null,
+                    "corporatePhone": null,
+                    "isCorporate": false,
+                    "userProfileId": "5a3692de-358a-4bea-8885-044bce33bb93",
+                    "customerClass": null
+                  },
+                  "giftRegistryData": null,
+                  "marketingData": {
+                    "id": "marketingData",
+                    "utmSource": "fb",
+                    "utmPartner": "utm partner name",
+                    "utmMedium": "utm medium name",
+                    "utmCampaign": "christmas",
+                    "coupon": "sale",
+                    "utmiCampaign": " ",
+                    "utmipage": " ",
+                    "utmiPart": " ",
+                    "marketingTags": [
+                      "vtex-subscription"
+                    ]
+                  },
+                  "ratesAndBenefitsData": {
+                    "id": "ratesAndBenefitsData",
+                    "rateAndBenefitsIdentifiers": []
+                  },
+                  "shippingData": {
+                    "id": "shippingData",
+                    "address": {
+                      "addressType": "residential",
+                      "receiverName": "Rodrigo Cunha",
+                      "addressId": "-1425945657910",
+                      "versionId": "e9c3bec2-125d-4b96-a021-316c3aa9f14f",
+                      "entityId": "eabfb564-99d6-40d8-bd6c-bddbd4990aad",
+                      "postalCode": "22250-040",
+                      "city": "Rio de Janeiro",
+                      "state": "RJ",
+                      "country": "BRA",
+                      "street": "Praia de Botafogo",
+                      "number": "518",
+                      "neighborhood": "Botafogo",
+                      "complement": "10",
+                      "reference": null,
+                      "geoCoordinates": []
+                    },
+                    "logisticsInfo": [
+                      {
+                        "itemIndex": 0,
+                        "selectedSla": "Normal",
+                        "lockTTL": "10d",
+                        "price": 1160,
+                        "listPrice": 1160,
+                        "sellingPrice": 1160,
+                        "deliveryWindow": null,
+                        "deliveryCompany": "Todos os CEPS",
+                        "shippingEstimate": "5bd",
+                        "shippingEstimateDate": "2019-02-04T20:33:46.4595004+00:00",
+                        "slas": [
+                          {
+                            "id": "Normal",
+                            "name": "Normal",
+                            "shippingEstimate": "5bd",
+                            "deliveryWindow": null,
+                            "price": 1160,
+                            "deliveryChannel": "delivery",
+                            "pickupStoreInfo": {
+                              "additionalInfo": null,
+                              "address": null,
+                              "dockId": null,
+                              "friendlyName": null,
+                              "isPickupStore": false
+                            },
+                            "polygonName": "region196",
+                            "lockTTL": "12d",
+                            "pickupPointId": "1_VTEX-RJ",
+                            "transitTime": "3d",
+                            "pickupDistance": 0.0
+                          },
+                          {
+                            "id": "Expressa",
+                            "name": "Expressa",
+                            "shippingEstimate": "5bd",
+                            "deliveryWindow": null,
+                            "price": 1160,
+                            "deliveryChannel": "delivery",
+                            "pickupStoreInfo": {
+                              "additionalInfo": null,
+                              "address": null,
+                              "dockId": null,
+                              "friendlyName": null,
+                              "isPickupStore": false
+                            },
+                            "polygonName": null,
+                            "lockTTL": "12d",
+                            "pickupPointId": "1_VTEX-RJ",
+                            "transitTime": "3d",
+                            "pickupDistance": 0.0
+                          },
+                          {
+                            "id": "Quebra Kit",
+                            "name": "Quebra Kit",
+                            "shippingEstimate": "2bd",
+                            "deliveryWindow": null,
+                            "price": 1392,
+                            "deliveryChannel": "delivery",
+                            "pickupStoreInfo": {
+                              "additionalInfo": null,
+                              "address": null,
+                              "dockId": null,
+                              "friendlyName": null,
+                              "isPickupStore": false
+                            },
+                            "polygonName": null,
+                            "lockTTL": "12d",
+                            "pickupPointId": "1_VTEX-RJ",
+                            "transitTime": "3d",
+                            "pickupDistance": 0.0
+                          },
+                          {
+                            "id": "Sob Encomenda",
+                            "name": "Sob Encomenda",
+                            "shippingEstimate": "32bd",
+                            "deliveryWindow": null,
+                            "price": 1392,
+                            "deliveryChannel": "delivery",
+                            "pickupStoreInfo": {
+                              "additionalInfo": null,
+                              "address": null,
+                              "dockId": null,
+                              "friendlyName": null,
+                              "isPickupStore": false
+                            },
+                            "polygonName": null,
+                            "lockTTL": "12d",
+                            "pickupPointId": "1_VTEX-RJ",
+                            "transitTime": "3d",
+                            "pickupDistance": 0.0
+                          }
+                        ],
+                        "shipsTo": [
+                          "BRA"
+                        ],
+                        "deliveryIds": [
+                          {
+                            "courierId": "197a56f",
+                            "courierName": "Todos os CEPS",
+                            "dockId": "1",
+                            "quantity": 1,
+                            "warehouseId": "1_1",
+                            "accountCarrierName": "recorrenciaqa",
+                            "kitItemDetails": []
+                          }
+                        ],
+                        "deliveryChannels": [
+                          {
+                            "id": "delivery",
+                            "stockBalance": 0
+                          }
+                        ],
+                        "deliveryChannel": "delivery",
+                        "pickupStoreInfo": {
+                          "additionalInfo": null,
+                          "address": null,
+                          "dockId": null,
+                          "friendlyName": null,
+                          "isPickupStore": false
+                        },
+                        "addressId": "-1425945657910",
+                        "versionId": "e9c3bec2-125d-4b96-a021-316c3aa9f14f",
+                        "entityId": "eabfb564-99d6-40d8-bd6c-bddbd4990aad",
+                        "polygonName": null,
+                        "pickupPointId": "1_VTEX-RJ",
+                        "transitTime": "3d"
+                      }
+                    ],
+                    "trackingHints": null,
+                    "selectedAddresses": [
+                      {
+                        "addressId": "-1425945657910",
+                        "versionId": "e9c3bec2-125d-4b96-a021-316c3aa9f14f",
+                        "entityId": "eabfb564-99d6-40d8-bd6c-bddbd4990aad",
+                        "addressType": "residential",
+                        "receiverName": "Rodrigo Cunha",
+                        "street": "Praia de Botafogo",
+                        "number": "518",
+                        "complement": "10",
+                        "neighborhood": "Botafogo",
+                        "postalCode": "22250-040",
+                        "city": "Rio de Janeiro",
+                        "state": "RJ",
+                        "country": "BRA",
+                        "reference": null,
+                        "geoCoordinates": []
+                      }
+                    ]
+                  },
+                  "paymentData": {
+                    "giftCards": [],
+                    "transactions": [
+                      {
+                        "isActive": true,
+                        "transactionId": "418213DE29634837A63DD693A937A696",
+                        "merchantName": "luxstore",
+                        "payments": [
+                          {
+                            "id": "D3DEECAB3C6C4B9EAF8EF4C1FE062FF3",
+                            "paymentSystem": "6",
+                            "paymentSystemName": "Boleto Bancário",
+                            "value": 4450,
+                            "installments": 1,
+                            "referenceValue": 4450,
+                            "cardHolder": null,
+                            "cardNumber": null,
+                            "firstDigits": null,
+                            "lastDigits": null,
+                            "cvv2": null,
+                            "expireMonth": null,
+                            "expireYear": null,
+                            "url": "https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment}",
+                            "giftCardId": null,
+                            "giftCardName": null,
+                            "giftCardCaption": null,
+                            "redemptionCode": null,
+                            "group": "bankInvoice",
+                            "tid": null,
+                            "dueDate": "2019-02-02",
+                            "connectorResponses": {
+                              "Tid": "94857956",
+                              "ReturnCode": "200",
+                              "Message": "logMessage",
+                              "authId": "857956"
+                            },
+                            "giftCardProvider": "presentCard",
+                            "giftCardAsDiscount": false,
+                            "koinUrl": "koinURL",
+                            "accountId": "5BC5C6B417FE432AB971B1D399F190C9",
+                            "parentAccountId": "5BC5C6B417FE432AB971B1D399F190C9",
+                            "bankIssuedInvoiceIdentificationNumber": "23797770100000019003099260100022107500729050",
+                            "bankIssuedInvoiceIdentificationNumberFormatted": "32534.95739 75945.24534 54395.734214 5",
+                            "bankIssuedInvoiceBarCodeNumber": "325349573975945245345439573421443986734065",
+                            "bankIssuedInvoiceBarCodeType": "i25",
+                            "billingAddress": {}
+                          }
+                        ]
+                      }
+                    ]
+                  },
+                  "packageAttachment": {
+                    "packages": []
+                  },
+                  "sellers": [
+                    {
+                      "id": "1",
+                      "name": "Lux Store",
+                      "logo": "https://sellersLogo/images.png",
+                      "fulfillmentEndpoint": "http://fulfillment.vtexcommerce.com.br/api/fulfillment?an=accountName"
+                    }
+                  ],
+                  "callCenterOperatorData": null,
+                  "followUpEmail": "7bf3a59bbc56402c810bda9521ba449e@ct.vtex.com.br",
+                  "lastMessage": null,
+                  "hostname": "luxstore",
+                  "invoiceData": null,
+                  "changesAttachment": {
+                    "id": "changeAttachment",
+                    "changesData": [
+                      {
+                        "reason": "Blah",
+                        "discountValue": 3290,
+                        "incrementValue": 0,
+                        "itemsAdded": [],
+                        "itemsRemoved": [
+                          {
+                            "id": "1234568358",
+                            "name": "Bay Max L",
+                            "quantity": 1,
+                            "price": 3290,
+                            "unitMultiplier": null
+                          }
+                        ],
+                        "receipt": {
+                          "date": "2019-02-06T20:46:04.4003606+00:00",
+                          "orderId": "v502556llux-01",
+                          "receipt": "029f9ab8-751a-4b1e-bf81-7dd25d14b49b"
+                        }
+                      }
+                    ]
+                  },
+                  "openTextField": null,
+                  "roundingError": 0,
+                  "orderFormId": "caae7471333e403f959fa5fd66951340",
+                  "commercialConditionData": null,
+                  "isCompleted": true,
+                  "customData": null,
+                  "storePreferencesData": {
+                    "countryCode": "BRA",
+                    "currencyCode": "BRL",
+                    "currencyFormatInfo": {
+                      "CurrencyDecimalDigits": 2,
+                      "CurrencyDecimalSeparator": ",",
+                      "CurrencyGroupSeparator": ".",
+                      "CurrencyGroupSize": 3,
+                      "StartsWithCurrencySymbol": true
+                    },
+                    "currencyLocale": 1046,
+                    "currencySymbol": "R$",
+                    "timeZone": "E. South America Standard Time"
+                  },
+                  "allowCancellation": true,
+                  "allowEdition": false,
+                  "isCheckedIn": false,
+                  "marketplace": {
+                    "baseURL": "http://oms.vtexinternal.com.br/api/oms?an=luxstore",
+                    "isCertified": null,
+                    "name": "luxstore"
+                  },
+                  "authorizedDate": "2019-01-28T20:33:04+00:00",
+                  "invoicedDate": null,
+                  "cancelReason": "The size was too big.",
+                  "itemMetadata": {
+                    "Items": [
+                      {
+                        "Id": "18",
+                        "Seller": "1",
+                        "Name": "Cat food",
+                        "SkuName": "Cat food",
+                        "ProductId": "6",
+                        "RefId": "105",
+                        "Ean": "43673557",
+                        "ImageUrl": "http://store.vteximg.com.br/ids/155392-55-55/AlconKOI.jpg?v=635918402228600000",
+                        "DetailUrl": "/catfood/p",
+                        "AssemblyOptions": [
+                          {
+                            "Id": "vtex.subscription.plan-ana",
+                            "Name": "vtex.subscription.plan-ana",
+                            "Required": false,
+                            "InputValues": {
+                              "vtex.subscription.key.frequency": {
+                                "MaximumNumberOfCharacters": 8,
+                                "Domain": [
+                                  "4 month",
+                                  "1 month"
+                                ]
+                              }
+                            },
+                            "Composition": {}
+                          }
+                        ]
+                      }
+                    ]
+                  },
+                  "subscriptionData": {
+                    "SubscriptionGroupId": "A64AC73C0FB8693A7ADB4AC69CA4FD5F",
+                    "Subscriptions": [
+                      {
+                        "ExecutionCount": 724,
+                        "PriceAtSubscriptionDate": 100.0,
+                        "ItemIndex": 0,
+                        "Plan": {
+                          "type": "RECURRING_PAYMENT",
+                          "frequency": {
+                            "periodicity": "DAILY",
+                            "interval": 1
+                          },
+                          "validity": {
+                            "begin": "2022-01-10T00:00:00.0000000+00:00",
+                            "end": "2024-02-03T00:00:00.0000000+00:00"
+                          }
+                        }
+                      }
+                    ]
+                  },
+                  "taxData": {
+                    "areTaxesDesignatedByMarketplace": true,
+                    "taxInfoCollection": [
+                      {
+                        "itemIndex": 0,
+                        "sku": "COLOCAR_O_SKUID",
+                        "priceTags": [
+                          {
+                            "isPercentual": false,
+                            "name": "Taxes (Magazine Luisa)",
+                            "rawValue": "COLOCAR_O_VALOR_SEM_DECIMAL"
+                          }
+                        ]
+                      }
+                    ]
+                  },
+                  "checkedInPickupPointId": "storeNameExample_901",
+                  "cancellationData": {
+                    "RequestedByUser": true,
+                    "RequestedBySystem": false,
+                    "RequestedBySellerNotification": false,
+                    "RequestedByPaymentNotification": false,
+                    "Reason": "Item was too big in the client.",
+                    "CancellationDate": "2022-10--05T15:40:33"
+                  },
+                  "clientPreferencesData": {
+                    "locale": "en-US",
+                    "optinNewsLetter": false
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "components": {
@@ -39128,6 +39958,39 @@
       }
     },
     "schemas": {
+      "Document": {
+        "title": "Document",
+        "required": [
+          "id",
+          "dataEntityId",
+          "accountId",
+          "accountName"
+        ],
+        "type": "object",
+        "description": "Object representing each document.",
+        "properties": {
+          "{customProperty}": {
+            "type": "string",
+            "description": "Custom property."
+          },
+          "id": {
+            "type": "string",
+            "description": "Unique identifier of the document."
+          },
+          "accountId": {
+            "type": "string",
+            "description": "Unique identifier of the account."
+          },
+          "accountName": {
+            "type": "string",
+            "description": "Account name."
+          },
+          "dataEntityId": {
+            "type": "string",
+            "description": "Two-letter string that identifies the data entity."
+          }
+        }
+      },
       "PickupPoint": {
         "type": "object",
         "description": "Pickup point information.",
@@ -43114,7 +43977,12 @@
       },
       "Userorderslist": {
         "title": "Userorderslist",
-        "required": ["list", "facets", "paging", "stats"],
+        "required": [
+          "list",
+          "facets",
+          "paging",
+          "stats"
+        ],
         "type": "object",
         "description": "Order list object.",
         "properties": {
@@ -43442,7 +44310,9 @@
       },
       "Stats2": {
         "title": "Stats2",
-        "required": ["stats"],
+        "required": [
+          "stats"
+        ],
         "type": "object",
         "properties": {
           "stats": {
@@ -43478,7 +44348,10 @@
       },
       "Stats3": {
         "title": "Stats3",
-        "required": ["totalValue", "totalItems"],
+        "required": [
+          "totalValue",
+          "totalItems"
+        ],
         "type": "object",
         "properties": {
           "totalValue": {
@@ -43622,6 +44495,7885 @@
           "SumOfSquares": 0,
           "Facets": {}
         }
+      },
+      "Total": {
+        "required": [
+          "id",
+          "name",
+          "value"
+        ],
+        "type": "object",
+        "description": "Object about order's totals.",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Code that identifies if the information is about `Items`, `Discounts`, `Shipping`, `Tax` or `Change`."
+          },
+          "name": {
+            "type": "string",
+            "description": "Name of `Items`, `Discounts`, `Shipping`, `Tax` or `Change`."
+          },
+          "value": {
+            "type": "integer",
+            "description": "Total amount of `Items`, `Discounts`, `Shipping`, `Tax` or `Change`."
+          }
+        }
+      },
+      "ClientProfileData": {
+        "title": "ClientProfileData",
+        "description": "Object with information on the client's profile.",
+        "required": [
+          "id",
+          "email",
+          "firstName",
+          "lastName",
+          "documentType",
+          "document",
+          "phone",
+          "corporateName",
+          "tradeName",
+          "corporateDocument",
+          "stateInscription",
+          "corporatePhone",
+          "isCorporate",
+          "userProfileId",
+          "customerClass"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Object ID, the expected value is `clientProfileData`."
+          },
+          "email": {
+            "type": "string",
+            "description": "Customer's email."
+          },
+          "firstName": {
+            "type": "string",
+            "description": "Customer's first name."
+          },
+          "lastName": {
+            "type": "string",
+            "description": "Customer's last name."
+          },
+          "documentType": {
+            "type": "string",
+            "description": "Type of the document informed by the customer."
+          },
+          "document": {
+            "type": "string",
+            "description": "Document identification code informed by the customer."
+          },
+          "phone": {
+            "type": "string",
+            "description": "Customers's phone number."
+          },
+          "corporateName": {
+            "type": "string",
+            "nullable": true,
+            "description": "If the customer is a legal entity, here goes the corporate name."
+          },
+          "tradeName": {
+            "type": "string",
+            "nullable": true,
+            "description": "If the customer is a legal entity, here goes the trade name."
+          },
+          "corporateDocument": {
+            "type": "string",
+            "nullable": true,
+            "description": "If the customer is a legal entity, here goes the corporate document."
+          },
+          "stateInscription": {
+            "type": "string",
+            "nullable": true,
+            "description": "If the customer is a legal entity, here goes the state inscription."
+          },
+          "corporatePhone": {
+            "type": "string",
+            "nullable": true,
+            "description": "If the customer is a legal entity, here goes the corpany's phone number."
+          },
+          "isCorporate": {
+            "type": "boolean",
+            "description": "The value is `true` when the customer is a legal entity and `false` when not."
+          },
+          "userProfileId": {
+            "type": "string",
+            "description": "Customer user profile ID."
+          },
+          "customerClass": {
+            "type": "string",
+            "nullable": true,
+            "description": "Identification of the class the customer belongs to."
+          }
+        },
+        "example": {
+          "id": "clientProfileData",
+          "email": "rodrigo.cunha@vtex.com.br",
+          "firstName": "Rodrigo",
+          "lastName": "VTEX",
+          "documentType": "cpf",
+          "document": "11047867702",
+          "phone": "+5521972321094",
+          "corporateName": null,
+          "tradeName": null,
+          "corporateDocument": null,
+          "stateInscription": null,
+          "corporatePhone": null,
+          "isCorporate": false,
+          "userProfileId": "5a3692de-358a-4bea-8885-044bce33bb93",
+          "customerClass": null
+        }
+      },
+      "RatesAndBenefitsDataUpdated": {
+        "type": "object",
+        "description": "Information on promotions and taxes that apply to the order.",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Object ID. The expected value is `ratesAndBenefitsData`."
+          },
+          "rateAndBenefitsIdentifiers": {
+            "type": "array",
+            "description": "Information about order's promotions and taxes identifiers.",
+            "items": {
+              "type": "object",
+              "description": "Information about a given promotion or tax.",
+              "properties": {
+                "description": {
+                  "type": "string",
+                  "description": "Promotion or tax description.",
+                  "nullable": true
+                },
+                "featured": {
+                  "type": "boolean",
+                  "description": "Defines if the [target audience](https://help.vtex.com/en/tutorial/creating-a-campaign-audience--6cnuDZJzIkIeocewAQQK4K) is featured (`true`) or not (`false`)."
+                },
+                "id": {
+                  "type": "string",
+                  "description": "Promotion or tax ID."
+                },
+                "name": {
+                  "type": "string",
+                  "description": "Promotion or tax name."
+                },
+                "matchedParameters": {
+                  "type": "object",
+                  "description": "Informs the criteria and conditions fulfilled so the promotion became valid.",
+                  "additionalProperties": {
+                    "type": "string",
+                    "description": "Promotion or tax criteria content."
+                  }
+                },
+                "additionalInfo": {
+                  "type": "object",
+                  "description": "Object containing the promotion or tax additional information.",
+                  "nullable": true,
+                  "additionalProperties": {
+                    "type": "string",
+                    "description": "Additional information."
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
+      "RatesAndBenefitsData": {
+        "title": "RatesAndBenefitsData",
+        "description": "Information on promotions and taxes that apply to the order.",
+        "required": [
+          "id",
+          "rateAndBenefitsIdentifiers"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "ID of the rate or benefit."
+          },
+          "rateAndBenefitsIdentifiers": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Information about order's promotions and taxes identifiers."
+          }
+        },
+        "example": {
+          "id": "ratesAndBenefitsData",
+          "rateAndBenefitsIdentifiers": []
+        }
+      },
+      "ShippingData": {
+        "title": "ShippingData",
+        "description": "Object containing shipping data.",
+        "required": [
+          "id",
+          "address",
+          "logisticsInfo",
+          "trackingHints",
+          "selectedAddresses"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Object ID, the expected value is `shippingData`."
+          },
+          "address": {
+            "$ref": "#/components/schemas/Address"
+          },
+          "logisticsInfo": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/LogisticsInfo"
+            },
+            "description": "Array of objects containing item's logistics information."
+          },
+          "trackingHints": {
+            "type": "string",
+            "nullable": true
+          },
+          "selectedAddresses": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/SelectedAddress"
+            },
+            "description": "Information about selected adresses."
+          }
+        },
+        "example": {
+          "id": "shippingData",
+          "address": {
+            "addressType": "residential",
+            "receiverName": "Rodrigo Cunha",
+            "addressId": "-1425945657910",
+            "versionId": "e9c3bec2-125d-4b96-a021-316c3aa9f14f",
+            "entityId": "eabfb564-99d6-40d8-bd6c-bddbd4990aad",
+            "postalCode": "22250-040",
+            "city": "Rio de Janeiro",
+            "state": "RJ",
+            "country": "BRA",
+            "street": "Praia de Botafogo",
+            "number": "300",
+            "neighborhood": "Botafogo",
+            "complement": "3",
+            "reference": null,
+            "geoCoordinates": []
+          },
+          "logisticsInfo": [
+            {
+              "itemIndex": 0,
+              "selectedSla": "Normal",
+              "lockTTL": "10d",
+              "price": 1160,
+              "listPrice": 1160,
+              "sellingPrice": 1160,
+              "deliveryWindow": null,
+              "deliveryCompany": "Todos os CEPS",
+              "shippingEstimate": "5bd",
+              "shippingEstimateDate": "2019-02-04T20:33:46.4595004+00:00",
+              "slas": [
+                {
+                  "id": "Normal",
+                  "name": "Normal",
+                  "shippingEstimate": "5bd",
+                  "deliveryWindow": null,
+                  "price": 1160,
+                  "deliveryChannel": "delivery",
+                  "pickupStoreInfo": {
+                    "additionalInfo": null,
+                    "address": null,
+                    "dockId": null,
+                    "friendlyName": null,
+                    "isPickupStore": false
+                  },
+                  "polygonName": "",
+                  "lockTTL": "12d",
+                  "pickupPointId": "store35",
+                  "transitTime": "3d",
+                  "pickupDistance": 0.0
+                },
+                {
+                  "id": "Expressa",
+                  "name": "Expressa",
+                  "shippingEstimate": "5bd",
+                  "deliveryWindow": null,
+                  "price": 1160,
+                  "deliveryChannel": "delivery",
+                  "pickupStoreInfo": {
+                    "additionalInfo": null,
+                    "address": null,
+                    "dockId": null,
+                    "friendlyName": null,
+                    "isPickupStore": false
+                  },
+                  "polygonName": "",
+                  "lockTTL": "12d",
+                  "pickupPointId": "store45",
+                  "transitTime": "3d",
+                  "pickupDistance": 0.0
+                },
+                {
+                  "id": "Quebra Kit",
+                  "name": "Quebra Kit",
+                  "shippingEstimate": "2bd",
+                  "deliveryWindow": null,
+                  "price": 1392,
+                  "deliveryChannel": "delivery",
+                  "pickupStoreInfo": {
+                    "additionalInfo": null,
+                    "address": null,
+                    "dockId": null,
+                    "friendlyName": null,
+                    "isPickupStore": false
+                  },
+                  "polygonName": "",
+                  "lockTTL": "12d",
+                  "pickupPointId": "store45",
+                  "transitTime": "3d",
+                  "pickupDistance": 0.0
+                },
+                {
+                  "id": "Sob Encomenda",
+                  "name": "Sob Encomenda",
+                  "shippingEstimate": "32bd",
+                  "deliveryWindow": null,
+                  "price": 1392,
+                  "deliveryChannel": "delivery",
+                  "pickupStoreInfo": {
+                    "additionalInfo": null,
+                    "address": null,
+                    "dockId": null,
+                    "friendlyName": null,
+                    "isPickupStore": false
+                  },
+                  "polygonName": "",
+                  "lockTTL": "12d",
+                  "pickupPointId": "store46",
+                  "transitTime": "3d",
+                  "pickupDistance": 0.0
+                }
+              ],
+              "shipsTo": [
+                "BRA"
+              ],
+              "deliveryIds": [
+                {
+                  "courierId": "197a56f",
+                  "courierName": "Todos os CEPS",
+                  "dockId": "1",
+                  "quantity": 1,
+                  "warehouseId": "1_1",
+                  "accountCarrierName": "recorrenciaqa",
+                  "kitItemDetails": []
+                }
+              ],
+              "deliveryChannels": [
+                {
+                  "id": "delivery",
+                  "stockBalance": 0
+                }
+              ],
+              "deliveryChannel": "delivery",
+              "pickupStoreInfo": {
+                "additionalInfo": null,
+                "address": null,
+                "dockId": null,
+                "friendlyName": null,
+                "isPickupStore": false
+              },
+              "addressId": "4791759472332",
+              "versionId": "e9c3bec2-125d-4b96-a021-316c3aa9f14f",
+              "entityId": "eabfb564-99d6-40d8-bd6c-bddbd4990aad",
+              "polygonName": "",
+              "pickupPointId": "store67",
+              "transitTime": "3d"
+            }
+          ],
+          "trackingHints": null,
+          "selectedAddresses": [
+            {
+              "addressId": "-1425945657910",
+              "versionId": "e9c3bec2-125d-4b96-a021-316c3aa9f14f",
+              "entityId": "eabfb564-99d6-40d8-bd6c-bddbd4990aad",
+              "addressType": "residential",
+              "receiverName": "Rodrigo Cunha",
+              "street": "Praia de Botafogo",
+              "number": "518",
+              "complement": "10",
+              "neighborhood": "Botafogo",
+              "postalCode": "22250-040",
+              "city": "Rio de Janeiro",
+              "state": "RJ",
+              "country": "BRA",
+              "reference": null,
+              "geoCoordinates": []
+            }
+          ]
+        }
+      },
+      "Address": {
+        "title": "Address",
+        "description": "Shipping address details.",
+        "required": [
+          "addressType",
+          "receiverName",
+          "addressId",
+          "versionId",
+          "entityId",
+          "postalCode",
+          "city",
+          "state",
+          "country",
+          "street",
+          "number",
+          "neighborhood",
+          "complement",
+          "reference",
+          "geoCoordinates"
+        ],
+        "type": "object",
+        "properties": {
+          "addressType": {
+            "type": "string",
+            "description": "Type of address. For example, `Residential` or `Pickup`, among others."
+          },
+          "receiverName": {
+            "type": "string",
+            "description": "Name of the person who is going to receive the order."
+          },
+          "addressId": {
+            "type": "string",
+            "description": "Shipping address ID."
+          },
+          "versionId": {
+            "type": "string",
+            "description": "Shipping address version ID.",
+            "nullable": true
+          },
+          "entityId": {
+            "type": "string",
+            "description": "Shipping address entity ID.",
+            "nullable": true
+          },
+          "postalCode": {
+            "type": "string",
+            "description": "Postal code of the shipping address."
+          },
+          "city": {
+            "type": "string",
+            "description": "City of the shipping address."
+          },
+          "state": {
+            "type": "string",
+            "description": "State of the shipping address."
+          },
+          "country": {
+            "type": "string",
+            "description": "Three letters ISO code of the country of the shipping address (ISO 3166 ALPHA-3)."
+          },
+          "street": {
+            "type": "string",
+            "description": "Street of the shipping address."
+          },
+          "number": {
+            "type": "string",
+            "description": "Number of the building, house or apartment in the shipping address."
+          },
+          "neighborhood": {
+            "type": "string",
+            "description": "Neighborhood of the shipping address."
+          },
+          "complement": {
+            "type": "string",
+            "description": "Complement to the shipping address when it applies."
+          },
+          "reference": {
+            "type": "string",
+            "nullable": true,
+            "description": "Complement to help locate the shipping address, in case of delivery."
+          },
+          "geoCoordinates": {
+            "type": "array",
+            "items": {
+              "type": "number"
+            },
+            "description": "Array with two numbers with geocoordinates, first longitude then latitude."
+          }
+        },
+        "example": {
+          "addressType": "residential",
+          "receiverName": "Rodrigo Cunha",
+          "addressId": "-1425945657910",
+          "versionId": "e9c3bec2-125d-4b96-a021-316c3aa9f14f",
+          "entityId": "eabfb564-99d6-40d8-bd6c-bddbd4990aad",
+          "postalCode": "22250-040",
+          "city": "Rio de Janeiro",
+          "state": "RJ",
+          "country": "BRA",
+          "street": "Praia de Botafogo",
+          "number": "300",
+          "neighborhood": "Botafogo",
+          "complement": "3",
+          "reference": null,
+          "geoCoordinates": []
+        }
+      },
+      "LogisticsInfo": {
+        "title": "LogisticsInfo",
+        "required": [
+          "itemIndex",
+          "selectedSla",
+          "lockTTL",
+          "price",
+          "listPrice",
+          "sellingPrice",
+          "deliveryWindow",
+          "deliveryCompany",
+          "shippingEstimate",
+          "shippingEstimateDate",
+          "slas",
+          "shipsTo",
+          "deliveryIds",
+          "deliveryChannels",
+          "deliveryChannel",
+          "pickupStoreInfo",
+          "addressId",
+          "versionId",
+          "entityId",
+          "polygonName",
+          "pickupPointId",
+          "transitTime"
+        ],
+        "type": "object",
+        "properties": {
+          "itemIndex": {
+            "type": "integer",
+            "description": "Index of the item starting from 0."
+          },
+          "selectedSla": {
+            "type": "string",
+            "description": "Selected shipping option."
+          },
+          "lockTTL": {
+            "type": "string",
+            "description": "Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time."
+          },
+          "price": {
+            "type": "integer",
+            "description": "Shipping price for the item in cents. Does not account for the whole order's shipping price."
+          },
+          "listPrice": {
+            "type": "integer",
+            "description": "SKU's optional price for a specific trade policy."
+          },
+          "sellingPrice": {
+            "type": "integer",
+            "description": "Item's selling price."
+          },
+          "deliveryWindow": {
+            "type": "string",
+            "nullable": true,
+            "description": "[Scheduled delivery](https://help.vtex.com/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) window information, if it applies to the item."
+          },
+          "deliveryCompany": {
+            "type": "string",
+            "description": "[Carrier](https://help.vtex.com/en/tutorial/transportadoras-na-vtex--7u9duMD5UQa2QQwukAWMcE) company's name."
+          },
+          "shippingEstimate": {
+            "type": "string",
+            "description": "Total shipping estimate time in days. For instance, three business days is represented `3bd`."
+          },
+          "shippingEstimateDate": {
+            "type": "string",
+            "description": "Shipping estimate date. It is defined only after the confirmation of the order."
+          },
+          "slas": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Sla"
+            },
+            "description": "Information on Service Level Agreement (SLA), corresponding to [shipping policies](https://help.vtex.com/tutorial/shipping-policy--tutorials_140)."
+          },
+          "shipsTo": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Three letters ISO code of the country of the shipping address (ISO 3166 ALPHA-3)."
+          },
+          "deliveryIds": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/DeliveryId"
+            },
+            "description": "Information about delivery IDs."
+          },
+          "deliveryChannels": {
+            "type": "array",
+            "description": "List of delivery channels associated with the trade policy.",
+            "items": {
+              "type": "object",
+              "required": [
+                "id",
+                "stockBalance"
+              ],
+              "properties": {
+                "id": {
+                  "type": "string",
+                  "description": "Delivery channel's shipping type, which can be `delivery` or `pickup-in-point`."
+                },
+                "stockBalance": {
+                  "type": "integer",
+                  "description": "Stock check for an SKU availability."
+                }
+              }
+            }
+          },
+          "deliveryChannel": {
+            "type": "string",
+            "description": "If the delivery channel is `delivery` or `pickup-in-point`."
+          },
+          "pickupStoreInfo": {
+            "$ref": "#/components/schemas/PickupStoreInfo"
+          },
+          "addressId": {
+            "type": "string",
+            "description": "Address ID."
+          },
+          "versionId": {
+            "type": "string",
+            "description": "Shipping address version ID.",
+            "nullable": true
+          },
+          "entityId": {
+            "type": "string",
+            "description": "Shipping address entity ID."
+          },
+          "polygonName": {
+            "type": "string",
+            "nullable": true,
+            "description": "Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy."
+          },
+          "pickupPointId": {
+            "type": "string",
+            "description": "[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R)'s ID."
+          },
+          "transitTime": {
+            "type": "string",
+            "description": "Duration in business days of the time the carrier takes in transit to fulfill the order. For example, three business days is represented `3bd`."
+          }
+        },
+        "example": {
+          "itemIndex": 0,
+          "selectedSla": "Normal",
+          "lockTTL": "10d",
+          "price": 1160,
+          "listPrice": 1160,
+          "sellingPrice": 1160,
+          "deliveryWindow": null,
+          "deliveryCompany": "Todos os CEPS",
+          "shippingEstimate": "5bd",
+          "shippingEstimateDate": "2019-02-04T20:33:46.4595004+00:00",
+          "slas": [
+            {
+              "id": "Normal",
+              "name": "Normal",
+              "shippingEstimate": "5bd",
+              "deliveryWindow": null,
+              "price": 1160,
+              "deliveryChannel": "delivery",
+              "pickupStoreInfo": {
+                "additionalInfo": null,
+                "address": null,
+                "dockId": null,
+                "friendlyName": null,
+                "isPickupStore": false
+              },
+              "polygonName": "region196",
+              "lockTTL": "12d",
+              "pickupPointId": "1_VTEX-RJ",
+              "transitTime": "3d",
+              "pickupDistance": 0.0
+            },
+            {
+              "id": "Expressa",
+              "name": "Expressa",
+              "shippingEstimate": "5bd",
+              "deliveryWindow": null,
+              "price": 1160,
+              "deliveryChannel": "delivery",
+              "pickupStoreInfo": {
+                "additionalInfo": null,
+                "address": null,
+                "dockId": null,
+                "friendlyName": null,
+                "isPickupStore": false
+              },
+              "polygonName": "region196",
+              "lockTTL": "12d",
+              "pickupPointId": "1_VTEX-RJ",
+              "transitTime": "3d",
+              "pickupDistance": 0.0
+            },
+            {
+              "id": "Quebra Kit",
+              "name": "Quebra Kit",
+              "shippingEstimate": "2bd",
+              "deliveryWindow": null,
+              "price": 1392,
+              "deliveryChannel": "delivery",
+              "pickupStoreInfo": {
+                "additionalInfo": null,
+                "address": null,
+                "dockId": null,
+                "friendlyName": null,
+                "isPickupStore": false
+              },
+              "polygonName": "region196",
+              "lockTTL": "12d",
+              "pickupPointId": "1_VTEX-RJ",
+              "transitTime": "3d",
+              "pickupDistance": 0.0
+            },
+            {
+              "id": "Sob Encomenda",
+              "name": "Sob Encomenda",
+              "shippingEstimate": "32bd",
+              "deliveryWindow": null,
+              "price": 1392,
+              "deliveryChannel": "delivery",
+              "pickupStoreInfo": {
+                "additionalInfo": null,
+                "address": null,
+                "dockId": null,
+                "friendlyName": null,
+                "isPickupStore": false
+              },
+              "polygonName": "region196",
+              "lockTTL": "12d",
+              "pickupPointId": "1_VTEX-RJ",
+              "transitTime": "3d",
+              "pickupDistance": 0.0
+            }
+          ],
+          "shipsTo": [
+            "BRA"
+          ],
+          "deliveryIds": [
+            {
+              "courierId": "197a56f",
+              "courierName": "Todos os CEPS",
+              "dockId": "1",
+              "quantity": 1,
+              "warehouseId": "1_1",
+              "accountCarrierName": "recorrenciaqa",
+              "kitItemDetails": []
+            }
+          ],
+          "deliveryChannels": [
+            {
+              "id": "delivery",
+              "stockBalance": 0
+            }
+          ],
+          "deliveryChannel": "delivery",
+          "pickupStoreInfo": {
+            "additionalInfo": null,
+            "address": null,
+            "dockId": null,
+            "friendlyName": null,
+            "isPickupStore": false
+          },
+          "addressId": "-1425945657910",
+          "versionId": "e9c3bec2-125d-4b96-a021-316c3aa9f14f",
+          "entityId": "eabfb564-99d6-40d8-bd6c-bddbd4990aad",
+          "polygonName": null,
+          "pickupPointId": "1_VTEX-RJ",
+          "transitTime": "3d"
+        }
+      },
+      "Sla": {
+        "title": "Sla",
+        "required": [
+          "id",
+          "name",
+          "shippingEstimate",
+          "deliveryWindow",
+          "price",
+          "deliveryChannel",
+          "pickupStoreInfo",
+          "polygonName",
+          "lockTTL",
+          "pickupPointId",
+          "transitTime",
+          "pickupDistance"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "ID of the shipping method used in the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140)."
+          },
+          "name": {
+            "type": "string",
+            "description": "Name of the shipping policy."
+          },
+          "shippingEstimate": {
+            "type": "string",
+            "description": "Total shipping estimate time in days. For instance, three business days is represented `3bd`."
+          },
+          "deliveryWindow": {
+            "type": "string",
+            "nullable": true,
+            "description": "[Scheduled delivery window](https://help.vtex.com/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, if it applies to the item."
+          },
+          "price": {
+            "type": "integer",
+            "description": "Shipping price for the item in cents. Does not account for the whole order's shipping price."
+          },
+          "deliveryChannel": {
+            "type": "string",
+            "description": "If the delivery channel is `delivery` or `pickup-in-point`."
+          },
+          "pickupStoreInfo": {
+            "$ref": "#/components/schemas/PickupStoreInfo"
+          },
+          "polygonName": {
+            "type": "string",
+            "nullable": true,
+            "description": "Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy."
+          },
+          "lockTTL": {
+            "type": "string",
+            "description": "Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time of the SLA."
+          },
+          "pickupPointId": {
+            "type": "string",
+            "description": "[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID related to the SLA."
+          },
+          "transitTime": {
+            "type": "string",
+            "description": "Duration in business days of the time the carrier takes in transit to fulfill the order. For example, three business days is represented `3bd`."
+          },
+          "pickupDistance": {
+            "type": "number",
+            "description": "Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line."
+          }
+        },
+        "example": {
+          "id": "Normal",
+          "name": "Normal",
+          "shippingEstimate": "5bd",
+          "deliveryWindow": null,
+          "price": 1160,
+          "deliveryChannel": "delivery",
+          "pickupStoreInfo": {
+            "additionalInfo": null,
+            "address": null,
+            "dockId": null,
+            "friendlyName": null,
+            "isPickupStore": false
+          },
+          "polygonName": null,
+          "lockTTL": "12d",
+          "pickupPointId": "1_VTEX-RJ",
+          "transitTime": "3d",
+          "pickupDistance": 0.0
+        }
+      },
+      "PickupStoreInfo": {
+        "title": "PickupStoreInfo",
+        "description": "Detailed information about a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).",
+        "required": [
+          "additionalInfo",
+          "address",
+          "dockId",
+          "friendlyName",
+          "isPickupStore"
+        ],
+        "type": "object",
+        "properties": {
+          "additionalInfo": {
+            "type": "string",
+            "nullable": true,
+            "description": "Additional information about the pickup point."
+          },
+          "address": {
+            "type": "string",
+            "nullable": true,
+            "description": "Pickup point's address."
+          },
+          "dockId": {
+            "type": "string",
+            "nullable": true,
+            "description": "ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj) related to the delivery or the pickup point."
+          },
+          "friendlyName": {
+            "type": "string",
+            "nullable": true,
+            "description": "Name of the pickup point displayed at checkout."
+          },
+          "isPickupStore": {
+            "type": "boolean",
+            "description": "If this field is set `true`, it means the type of shipping is pickup, and if set as `false`, it is not."
+          }
+        },
+        "example": {
+          "additionalInfo": null,
+          "address": null,
+          "dockId": null,
+          "friendlyName": null,
+          "isPickupStore": false
+        }
+      },
+      "DeliveryId": {
+        "title": "DeliveryId",
+        "description": "Information about delivery IDs.",
+        "required": [
+          "courierId",
+          "courierName",
+          "dockId",
+          "quantity",
+          "warehouseId",
+          "accountCarrierName",
+          "kitItemDetails"
+        ],
+        "type": "object",
+        "properties": {
+          "courierId": {
+            "type": "string",
+            "description": "[Carrier](https://help.vtex.com/en/tutorial/transportadoras-na-vtex--7u9duMD5UQa2QQwukAWMcE)'s ID."
+          },
+          "courierName": {
+            "type": "string",
+            "description": "Carrier's name."
+          },
+          "dockId": {
+            "type": "string",
+            "description": "ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj)."
+          },
+          "quantity": {
+            "type": "integer",
+            "description": "Quantity of items."
+          },
+          "warehouseId": {
+            "type": "string",
+            "description": "ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb)."
+          },
+          "accountCarrierName": {
+            "type": "string",
+            "description": "Name of the account's [carrier](https://help.vtex.com/en/tutorial/transportadoras-na-vtex--7u9duMD5UQa2QQwukAWMcE)."
+          },
+          "kitItemDetails": {
+            "type": "array",
+            "description": "Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28), if there are any.",
+            "nullable": true,
+            "items": {
+              "type": "string"
+            }
+          }
+        },
+        "example": {
+          "courierId": "197a56f",
+          "courierName": "Todos os CEPS",
+          "dockId": "1",
+          "quantity": 1,
+          "warehouseId": "1_1",
+          "accountCarrierName": "recorrenciaqa",
+          "kitItemDetails": []
+        }
+      },
+      "SelectedAddress": {
+        "title": "SelectedAddress",
+        "required": [
+          "addressId",
+          "versionId",
+          "entityId",
+          "addressType",
+          "receiverName",
+          "street",
+          "number",
+          "complement",
+          "neighborhood",
+          "postalCode",
+          "city",
+          "state",
+          "country",
+          "reference",
+          "geoCoordinates"
+        ],
+        "type": "object",
+        "properties": {
+          "addressId": {
+            "type": "string",
+            "description": "Selected address ID."
+          },
+          "versionId": {
+            "type": "string",
+            "description": "Shipping address version ID of the selected address.",
+            "nullable": true
+          },
+          "entityId": {
+            "type": "string",
+            "description": "Shipping address entity ID  of the selected address.",
+            "nullable": true
+          },
+          "addressType": {
+            "type": "string",
+            "description": "Selected adress's shipping type, which can be `pickup`, `residential`, `invoice`, `search`, `inStore`, `commercial` or `giftRegistry`."
+          },
+          "receiverName": {
+            "type": "string",
+            "description": "Name of the person who is going to receive the order in the selected address."
+          },
+          "street": {
+            "type": "string",
+            "description": "Street of the selected address."
+          },
+          "number": {
+            "type": "string",
+            "description": "Number of the building, house or apartment of the selected address."
+          },
+          "complement": {
+            "type": "string",
+            "description": "Complement to the selected address if it applies."
+          },
+          "neighborhood": {
+            "type": "string",
+            "description": "Neighborhood of the selected address."
+          },
+          "postalCode": {
+            "type": "string",
+            "description": "Postal code of the selected address."
+          },
+          "city": {
+            "type": "string",
+            "description": "City of the selected address."
+          },
+          "state": {
+            "type": "string",
+            "description": "State of the selected address."
+          },
+          "country": {
+            "type": "string",
+            "description": "Three letters ISO code of the country of the selected address (ISO 3166 ALPHA-3)."
+          },
+          "reference": {
+            "type": "string",
+            "nullable": true,
+            "description": "Complement to help locate the selected address."
+          },
+          "geoCoordinates": {
+            "type": "array",
+            "items": {
+              "type": "number"
+            },
+            "description": "Array with two numbers with the selected address's geocoordinates, first longitude then latitude."
+          }
+        },
+        "example": {
+          "addressId": "-1425945657910",
+          "versionId": "e9c3bec2-125d-4b96-a021-316c3aa9f14f",
+          "entityId": "eabfb564-99d6-40d8-bd6c-bddbd4990aad",
+          "addressType": "residential",
+          "receiverName": "Rodrigo Cunha",
+          "street": "Praia de Botafogo",
+          "number": "518",
+          "complement": "10",
+          "neighborhood": "Botafogo",
+          "postalCode": "22250-040",
+          "city": "Rio de Janeiro",
+          "state": "RJ",
+          "country": "BRA",
+          "reference": null,
+          "geoCoordinates": []
+        }
+      },
+      "PaymentData": {
+        "title": "PaymentData",
+        "description": "Object with information about the payment.",
+        "required": [
+          "transactions"
+        ],
+        "type": "object",
+        "properties": {
+          "giftCards": {
+            "type": "array",
+            "description": "Array with information about Gift Cards.",
+            "items": {
+              "type": "string"
+            }
+          },
+          "transactions": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Transaction"
+            },
+            "description": "Information about financial transactions."
+          }
+        },
+        "example": {
+          "giftCards": [],
+          "transactions": [
+            {
+              "isActive": true,
+              "transactionId": "418213DE29634837A63DD693A937A696",
+              "merchantName": "luxstore",
+              "payments": [
+                {
+                  "id": "D3DEECAB3C6C4B9EAF8EF4C1FE062FF3",
+                  "paymentSystem": "6",
+                  "paymentSystemName": "Boleto Bancário",
+                  "value": 4450,
+                  "installments": 1,
+                  "referenceValue": 4450,
+                  "cardHolder": null,
+                  "cardNumber": null,
+                  "firstDigits": null,
+                  "lastDigits": null,
+                  "cvv2": null,
+                  "expireMonth": null,
+                  "expireYear": null,
+                  "url": "https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment}",
+                  "giftCardId": null,
+                  "giftCardName": null,
+                  "giftCardCaption": null,
+                  "redemptionCode": null,
+                  "group": "bankInvoice",
+                  "tid": null,
+                  "dueDate": "2019-02-02",
+                  "connectorResponses": {
+                    "Tid": "94857956",
+                    "ReturnCode": "200",
+                    "Message": "logMessage",
+                    "authId": "857956"
+                  },
+                  "giftCardProvider": "presentCard",
+                  "giftCardAsDiscount": false,
+                  "koinUrl": "koinURL",
+                  "accountId": "5BC5C6B417FE432AB971B1D399F190C9",
+                  "parentAccountId": "5BC5C6B417FE432AB971B1D399F190C9",
+                  "bankIssuedInvoiceIdentificationNumber": "23797770100000019003099260100022107500729050",
+                  "bankIssuedInvoiceIdentificationNumberFormatted": "32534.95739 75945.24534 54395.734214 5",
+                  "bankIssuedInvoiceBarCodeNumber": "325349573975945245345439573421443986734065",
+                  "bankIssuedInvoiceBarCodeType": "i25",
+                  "billingAddress": {}
+                }
+              ]
+            }
+          ]
+        }
+      },
+      "Transaction": {
+        "title": "Transaction",
+        "description": "Financial transaction details.",
+        "required": [
+          "isActive",
+          "transactionId",
+          "merchantName",
+          "payments"
+        ],
+        "type": "object",
+        "properties": {
+          "isActive": {
+            "type": "boolean",
+            "description": "When this field is set as `true`, the payment is active, and when it is `false`, the payment is inactive."
+          },
+          "transactionId": {
+            "type": "string",
+            "description": "ID of the transaction."
+          },
+          "merchantName": {
+            "type": "string",
+            "description": "Name of the merchant that will receive the payment."
+          },
+          "payments": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Payment"
+            },
+            "description": "Detailed information about payment."
+          }
+        },
+        "example": {
+          "isActive": true,
+          "transactionId": "418213DE29634837A63DD693A937A696",
+          "merchantName": "luxstore",
+          "payments": [
+            {
+              "id": "D3DEECAB3C6C4B9EAF8EF4C1FE062FF3",
+              "paymentSystem": "6",
+              "paymentSystemName": "Boleto Bancário",
+              "value": 4450,
+              "installments": 1,
+              "referenceValue": 4450,
+              "cardHolder": null,
+              "cardNumber": null,
+              "firstDigits": null,
+              "lastDigits": null,
+              "cvv2": null,
+              "expireMonth": null,
+              "expireYear": null,
+              "url": "https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment}",
+              "giftCardId": null,
+              "giftCardName": null,
+              "giftCardCaption": null,
+              "redemptionCode": null,
+              "group": "bankInvoice",
+              "tid": null,
+              "dueDate": "2019-02-02",
+              "connectorResponses": {
+                "Tid": "94857956",
+                "ReturnCode": "200",
+                "Message": "logMessage",
+                "authId": "857956"
+              },
+              "giftCardProvider": "presentCard",
+              "giftCardAsDiscount": false,
+              "koinUrl": "koinURL",
+              "accountId": "5BC5C6B417FE432AB971B1D399F190C9",
+              "parentAccountId": "5BC5C6B417FE432AB971B1D399F190C9",
+              "bankIssuedInvoiceIdentificationNumber": "23797770100000019003099260100022107500729050",
+              "bankIssuedInvoiceIdentificationNumberFormatted": "32534.95739 75945.24534 54395.734214 5",
+              "bankIssuedInvoiceBarCodeNumber": "325349573975945245345439573421443986734065",
+              "bankIssuedInvoiceBarCodeType": "i25",
+              "billingAddress": {}
+            }
+          ]
+        }
+      },
+      "Payment": {
+        "title": "Payment",
+        "description": "Payment details.",
+        "required": [
+          "id",
+          "paymentSystem",
+          "paymentSystemName",
+          "value",
+          "installments",
+          "referenceValue",
+          "cardHolder",
+          "cardNumber",
+          "firstDigits",
+          "lastDigits",
+          "cvv2",
+          "expireMonth",
+          "expireYear",
+          "url",
+          "giftCardId",
+          "giftCardName",
+          "giftCardCaption",
+          "redemptionCode",
+          "group",
+          "tid",
+          "dueDate",
+          "connectorResponses",
+          "giftCardProvider",
+          "giftCardAsDiscount",
+          "koinUrl",
+          "accountId",
+          "parentAccountId",
+          "bankIssuedInvoiceIdentificationNumber",
+          "bankIssuedInvoiceIdentificationNumberFormatted",
+          "bankIssuedInvoiceBarCodeNumber",
+          "bankIssuedInvoiceBarCodeType",
+          "billingAddress"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "VTEX payment ID that can be used as unique identifier."
+          },
+          "paymentSystem": {
+            "type": "string",
+            "description": "Payment system's ID."
+          },
+          "paymentSystemName": {
+            "type": "string",
+            "description": "Payment system's name."
+          },
+          "value": {
+            "type": "integer",
+            "description": "Payment's final amount in cents."
+          },
+          "installments": {
+            "type": "integer",
+            "description": "Number of payment installments."
+          },
+          "referenceValue": {
+            "type": "integer",
+            "description": "Payment's reference value in cents."
+          },
+          "cardHolder": {
+            "type": "string",
+            "nullable": true,
+            "description": "Name of the person who owns the card."
+          },
+          "cardNumber": {
+            "type": "string",
+            "nullable": true,
+            "description": "Numeric sequence of the card used in the transaction."
+          },
+          "firstDigits": {
+            "type": "string",
+            "nullable": true,
+            "description": "Fist digits of the card used in the transaction."
+          },
+          "lastDigits": {
+            "type": "string",
+            "nullable": true,
+            "description": "Last digits of the card used in the transaction."
+          },
+          "cvv2": {
+            "type": "string",
+            "nullable": true,
+            "description": "Card Verification Value (CVV2) is a security code used by payment processors to reduce fraudulent credit and debit card transactions."
+          },
+          "expireMonth": {
+            "type": "string",
+            "nullable": true,
+            "description": "Expire month of the card used in the transaction (2-digits)."
+          },
+          "expireYear": {
+            "type": "string",
+            "nullable": true,
+            "description": "Expire year of the card used in the transaction (4-digits)."
+          },
+          "url": {
+            "type": "string",
+            "description": "Payment's URL."
+          },
+          "giftCardId": {
+            "type": "string",
+            "nullable": true,
+            "description": "Gift Card's ID."
+          },
+          "giftCardName": {
+            "type": "string",
+            "nullable": true,
+            "description": "Gift Card's name."
+          },
+          "giftCardCaption": {
+            "type": "string",
+            "nullable": true,
+            "description": "Gift Card's caption."
+          },
+          "redemptionCode": {
+            "type": "string",
+            "nullable": true,
+            "description": "Code for the customer to use the Gift Card."
+          },
+          "group": {
+            "type": "string",
+            "description": "Name of the collection the Gift Card belongs to."
+          },
+          "tid": {
+            "type": "string",
+            "nullable": true,
+            "description": "Provider's unique identifier for the transaction."
+          },
+          "dueDate": {
+            "type": "string",
+            "description": "Payment due date, with the format `yyyy-mm-dd`."
+          },
+          "connectorResponses": {
+            "type": "object",
+            "description": "Information about the connector responses.",
+            "required": [
+              "Tid",
+              "ReturnCode",
+              "Message",
+              "authId"
+            ],
+            "properties": {
+              "Tid": {
+                "type": "string",
+                "description": "Provider's unique identifier for the transaction."
+              },
+              "ReturnCode": {
+                "type": "string",
+                "description": "Provider's operation/error code to be logged."
+              },
+              "Message": {
+                "type": "string",
+                "description": "Provider's operation/error message to be logged."
+              },
+              "authId": {
+                "type": "string",
+                "description": "Connector's authorization ID."
+              }
+            }
+          },
+          "giftCardProvider": {
+            "type": "string",
+            "description": "Gift Card provider's ID."
+          },
+          "giftCardAsDiscount": {
+            "type": "boolean",
+            "description": "When this field is set as `true`, the Gift Card is a discount over the price, and when set as `false`, it is not a discount."
+          },
+          "koinUrl": {
+            "type": "string",
+            "description": "Payment's account ID."
+          },
+          "accountId": {
+            "type": "string",
+            "description": "Payment's account ID."
+          },
+          "parentAccountId": {
+            "type": "string",
+            "description": "This field retrieves the main account if the payment was made in a subaccount."
+          },
+          "bankIssuedInvoiceIdentificationNumber": {
+            "type": "string",
+            "description": "Numeric sequence that identifies the bank issued invoice."
+          },
+          "bankIssuedInvoiceIdentificationNumberFormatted": {
+            "type": "string",
+            "description": "Bank issued invoice ID formatted."
+          },
+          "bankIssuedInvoiceBarCodeNumber": {
+            "type": "string",
+            "description": "Number of the bank issued invoice bar code."
+          },
+          "bankIssuedInvoiceBarCodeType": {
+            "type": "string",
+            "description": "Type of the bank issued invoice bar code."
+          },
+          "billingAddress": {
+            "type": "object",
+            "description": "Billing address information."
+          }
+        },
+        "example": {
+          "id": "D3DEECAB3C6C4B9EAF8EF4C1FE062FF3",
+          "paymentSystem": "6",
+          "paymentSystemName": "Boleto Bancário",
+          "value": 4450,
+          "installments": 1,
+          "referenceValue": 4450,
+          "cardHolder": null,
+          "cardNumber": null,
+          "firstDigits": null,
+          "lastDigits": null,
+          "cvv2": null,
+          "expireMonth": null,
+          "expireYear": null,
+          "url": "https://luxstore.vtexpayments.com.br:443/BankIssuedInvoice/Transaction/418213DE29634837A63DD693A937A696/Payment/D3DEECAB3C6C4B9EAF8EF4C1FE062FF3/Installment/{Installment}",
+          "giftCardId": null,
+          "giftCardName": null,
+          "giftCardCaption": null,
+          "redemptionCode": null,
+          "group": "bankInvoice",
+          "tid": null,
+          "dueDate": "2019-02-02",
+          "connectorResponses": {
+            "Tid": "94857956",
+            "ReturnCode": "200",
+            "Message": "logMessage",
+            "authId": "857956"
+          },
+          "giftCardProvider": "presentCard",
+          "giftCardAsDiscount": false,
+          "koinUrl": "koinURL",
+          "accountId": "5BC5C6B417FE432AB971B1D399F190C9",
+          "parentAccountId": "5BC5C6B417FE432AB971B1D399F190C9",
+          "bankIssuedInvoiceIdentificationNumber": "23797770100000019003099260100022107500729050",
+          "bankIssuedInvoiceIdentificationNumberFormatted": "32534.95739 75945.24534 54395.734214 5",
+          "bankIssuedInvoiceBarCodeNumber": "325349573975945245345439573421443986734065",
+          "bankIssuedInvoiceBarCodeType": "i25",
+          "billingAddress": {}
+        }
+      },
+      "PackageAttachment": {
+        "title": "PackageAttachment",
+        "description": "Package object populated after order invoiced.",
+        "required": [
+          "packages"
+        ],
+        "type": "object",
+        "properties": {
+          "packages": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Package"
+            },
+            "description": "Details of each package in the order."
+          }
+        },
+        "example": {
+          "packages": []
+        }
+      },
+      "Package": {
+        "title": "Package",
+        "description": "Details of an individual package in the order.",
+        "type": "object",
+        "required": [
+          "cfop",
+          "invoiceNumber",
+          "invoiceValue",
+          "invoiceUrl",
+          "issuanceDate",
+          "trackingNumber",
+          "invoiceKey",
+          "trackingUrl",
+          "embeddedInvoice",
+          "courierStatus",
+          "type"
+        ],
+        "properties": {
+          "cfop": {
+            "type": "string",
+            "nullable": true,
+            "description": "Fiscal operation code for the package."
+          },
+          "invoiceNumber": {
+            "type": "string",
+            "description": "Invoice number associated with the package."
+          },
+          "invoiceValue": {
+            "type": "number",
+            "description": "Total value of the invoice."
+          },
+          "invoiceUrl": {
+            "type": "string",
+            "nullable": true,
+            "description": "URL for the invoice, if available."
+          },
+          "issuanceDate": {
+            "type": "string",
+            "description": "Date when the invoice was issued."
+          },
+          "trackingNumber": {
+            "type": "string",
+            "nullable": true,
+            "description": "Tracking number for the package, if available."
+          },
+          "invoiceKey": {
+            "type": "string",
+            "description": "Unique key for the invoice."
+          },
+          "trackingUrl": {
+            "type": "string",
+            "nullable": true,
+            "description": "URL for tracking the package, if available."
+          },
+          "embeddedInvoice": {
+            "type": "string",
+            "description": "Embedded invoice data."
+          },
+          "courierStatus": {
+            "type": "object",
+            "description": "Current status of the courier handling the package.",
+            "properties": {
+              "status": {
+                "type": "string",
+                "nullable": true,
+                "description": "Status of the courier, if available."
+              },
+              "finished": {
+                "type": "boolean",
+                "description": "Indicates if the delivery process is finished."
+              },
+              "deliveredDate": {
+                "type": "string",
+                "description": "Date the package was delivered, if applicable."
+              }
+            },
+            "required": [
+              "status",
+              "finished",
+              "deliveredDate"
+            ]
+          },
+          "type": {
+            "type": "string",
+            "enum": [
+              "Input",
+              "Output"
+            ],
+            "description": "Type of package, either 'Input' or 'Output'."
+          }
+        }
+      },
+      "Seller": {
+        "title": "Seller",
+        "description": "Information about the seller associated with the order.",
+        "required": [
+          "id",
+          "name",
+          "logo",
+          "fulfillmentEndpoint"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Seller ID that identifies the seller."
+          },
+          "name": {
+            "type": "string",
+            "description": "Seller's name."
+          },
+          "logo": {
+            "type": "string",
+            "description": "URL of the seller's logo."
+          },
+          "fulfillmentEndpoint": {
+            "type": "string",
+            "description": "URL of the endpoint for fulfillment of seller's orders."
+          }
+        },
+        "example": {
+          "id": "1",
+          "name": "Loja do Suporte",
+          "logo": "https://sellersLogo/images.png",
+          "fulfillmentEndpoint": "http://fulfillment.vtexcommerce.com.br/api/fulfillment?an=accountName"
+        }
+      },
+      "ChangesAttachment": {
+        "title": "ChangesAttachment",
+        "description": "Information about changes in the order.",
+        "required": [
+          "id",
+          "changesData"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Object ID, the expect value is `changeAttachment`."
+          },
+          "changesData": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ChangesDatum"
+            },
+            "description": "Order change details."
+          }
+        },
+        "example": {
+          "id": "changeAttachment",
+          "changesData": [
+            {
+              "reason": "Blah",
+              "discountValue": 3290,
+              "incrementValue": 0,
+              "itemsAdded": [],
+              "itemsRemoved": [
+                {
+                  "id": "1234568358",
+                  "name": "Bay Max L",
+                  "quantity": 1,
+                  "price": 3290,
+                  "unitMultiplier": null
+                }
+              ],
+              "receipt": {
+                "date": "2019-02-06T20:46:04.4003606+00:00",
+                "orderId": "v5195004lux-01",
+                "receipt": "029f9ab8-751a-4b1e-bf81-7dd25d14b49b"
+              }
+            }
+          ]
+        }
+      },
+      "ChangesDatum": {
+        "title": "ChangesDatum",
+        "required": [
+          "reason",
+          "discountValue",
+          "incrementValue",
+          "itemsAdded",
+          "itemsRemoved",
+          "receipt"
+        ],
+        "type": "object",
+        "properties": {
+          "reason": {
+            "type": "string",
+            "description": "Text explaining why there was a change in the order. This information may be shown to the customer in the UI or transactional emails."
+          },
+          "discountValue": {
+            "type": "integer",
+            "description": "Order change discount value."
+          },
+          "incrementValue": {
+            "type": "integer",
+            "description": "Order change increment value."
+          },
+          "itemsAdded": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "List of items added to the order."
+          },
+          "itemsRemoved": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/ItemsRemoved"
+            },
+            "description": "List of items removed from the order."
+          },
+          "receipt": {
+            "$ref": "#/components/schemas/Receipt"
+          }
+        },
+        "example": {
+          "reason": "Blah",
+          "discountValue": 3290,
+          "incrementValue": 0,
+          "itemsAdded": [],
+          "itemsRemoved": [
+            {
+              "id": "1234568358",
+              "name": "Bay Max L",
+              "quantity": 1,
+              "price": 3290,
+              "unitMultiplier": null
+            }
+          ],
+          "receipt": {
+            "date": "2019-02-06T20:46:04.4003606+00:00",
+            "orderId": "v5195004lux-01",
+            "receipt": "029f9ab8-751a-4b1e-bf81-7dd25d14b49b"
+          }
+        }
+      },
+      "ItemsRemoved": {
+        "title": "ItemsRemoved",
+        "required": [
+          "id",
+          "name",
+          "quantity",
+          "price",
+          "unitMultiplier"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "SKU ID of the item removed from the order."
+          },
+          "name": {
+            "type": "string",
+            "description": "Name of the item removed from the order."
+          },
+          "quantity": {
+            "type": "integer",
+            "description": "Quantity of items removed from the order."
+          },
+          "price": {
+            "type": "integer",
+            "description": "Total amount of items removed from the order."
+          },
+          "unitMultiplier": {
+            "type": "string",
+            "nullable": true,
+            "description": "Unit multiplier of the item removed from the order."
+          }
+        },
+        "example": {
+          "id": "1234568358",
+          "name": "Bay Max L",
+          "quantity": 1,
+          "price": 3290,
+          "unitMultiplier": null
+        }
+      },
+      "Receipt": {
+        "title": "Receipt",
+        "description": "Information about the receipt for changed orders.",
+        "required": [
+          "date",
+          "orderId",
+          "receipt"
+        ],
+        "type": "object",
+        "properties": {
+          "date": {
+            "type": "string",
+            "description": "Date when the receipt was created."
+          },
+          "orderId": {
+            "type": "string",
+            "description": "ID of the order."
+          },
+          "receipt": {
+            "type": "string",
+            "description": "Receipt's unique identifier code."
+          }
+        },
+        "example": {
+          "date": "2019-02-06T20:46:04.4003606+00:00",
+          "orderId": "v5195004lux-01",
+          "receipt": "029f9ab8-751a-4b1e-bf81-7dd25d14b49b"
+        }
+      },
+      "StorePreferencesData": {
+        "title": "StorePreferencesData",
+        "description": "Object with data from the store's configuration - stored in VTEX's License Manager.",
+        "required": [
+          "countryCode",
+          "currencyCode",
+          "currencyFormatInfo",
+          "currencyLocale",
+          "currencySymbol",
+          "timeZone"
+        ],
+        "type": "object",
+        "properties": {
+          "countryCode": {
+            "type": "string",
+            "description": "Three letters ISO code of the country (ISO 3166 ALPHA-3)."
+          },
+          "currencyCode": {
+            "type": "string",
+            "description": "Currency code in ISO 4217. For example, `BRL`."
+          },
+          "currencyFormatInfo": {
+            "$ref": "#/components/schemas/CurrencyFormatInfo"
+          },
+          "currencyLocale": {
+            "type": "integer",
+            "description": "Currency Locale Code in LCID in decimal."
+          },
+          "currencySymbol": {
+            "type": "string",
+            "description": "Currency symbol."
+          },
+          "timeZone": {
+            "type": "string",
+            "description": "Time zone from where the order was made."
+          }
+        },
+        "example": {
+          "countryCode": "BRA",
+          "currencyCode": "BRL",
+          "currencyFormatInfo": {
+            "CurrencyDecimalDigits": 2,
+            "CurrencyDecimalSeparator": ",",
+            "CurrencyGroupSeparator": ".",
+            "CurrencyGroupSize": 3,
+            "StartsWithCurrencySymbol": true
+          },
+          "currencyLocale": 1046,
+          "currencySymbol": "R$",
+          "timeZone": "E. South America Standard Time"
+        }
+      },
+      "CurrencyFormatInfo": {
+        "title": "CurrencyFormatInfo",
+        "description": "Object with currency format details.",
+        "required": [
+          "CurrencyDecimalDigits",
+          "CurrencyDecimalSeparator",
+          "CurrencyGroupSeparator",
+          "CurrencyGroupSize",
+          "StartsWithCurrencySymbol"
+        ],
+        "type": "object",
+        "properties": {
+          "CurrencyDecimalDigits": {
+            "type": "integer",
+            "description": "Quantity of currency decimal digits."
+          },
+          "CurrencyDecimalSeparator": {
+            "type": "string",
+            "description": "Defines what currency decimal separator will be applied."
+          },
+          "CurrencyGroupSeparator": {
+            "type": "string",
+            "description": "Defines what currency group separator will be applied."
+          },
+          "CurrencyGroupSize": {
+            "type": "integer",
+            "description": "Defines how many characters will be grouped."
+          },
+          "StartsWithCurrencySymbol": {
+            "type": "boolean",
+            "description": "Defines if all prices will be initiated with the currency symbol (`true`) or not (`false`)."
+          }
+        },
+        "example": {
+          "CurrencyDecimalDigits": 2,
+          "CurrencyDecimalSeparator": ",",
+          "CurrencyGroupSeparator": ".",
+          "CurrencyGroupSize": 3,
+          "StartsWithCurrencySymbol": true
+        }
+      },
+      "Marketplace": {
+        "title": "Marketplace",
+        "description": "Details about the marketplace related to the order.",
+        "required": [
+          "baseURL",
+          "isCertified",
+          "name"
+        ],
+        "type": "object",
+        "properties": {
+          "baseURL": {
+            "type": "string",
+            "description": "Marketplace base URL."
+          },
+          "isCertified": {
+            "type": "string",
+            "nullable": true,
+            "description": "If is a certified marketplace."
+          },
+          "name": {
+            "type": "string",
+            "description": "Name of the marketplace."
+          }
+        },
+        "example": {
+          "baseURL": "http://oms.vtexinternal.com.br/api/oms?an=luxstore",
+          "isCertified": null,
+          "name": "luxstore"
+        }
+      },
+      "ListOrders": {
+        "title": "ListOrders",
+        "required": [
+          "list",
+          "facets",
+          "paging",
+          "stats"
+        ],
+        "type": "object",
+        "properties": {
+          "list": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/List"
+            },
+            "description": "Array containing list information."
+          },
+          "facets": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Array containing facets information."
+          },
+          "paging": {
+            "$ref": "#/components/schemas/Paging"
+          },
+          "stats": {
+            "$ref": "#/components/schemas/Stats"
+          }
+        },
+        "example": {
+          "list": [
+            {
+              "orderId": "v502559llux-01",
+              "creationDate": "2019-02-04T10:29:11+00:00",
+              "clientName": "J C",
+              "items": null,
+              "totalValue": 7453,
+              "paymentNames": "Boleto Bancário",
+              "status": "invoiced",
+              "statusDescription": "Faturado",
+              "marketPlaceOrderId": null,
+              "sequence": "502559",
+              "salesChannel": "1",
+              "affiliateId": "",
+              "origin": "Marketplace",
+              "workflowInErrorState": false,
+              "workflowInRetry": false,
+              "lastMessageUnread": " Lux Store 96 Sua Nota Fiscal foi emitida. Referente ao Pedido #v502559llux-01 Olá, J. Estamos empacotando seu produto para providenci",
+              "ShippingEstimatedDate": null,
+              "ShippingEstimatedDateMax": null,
+              "ShippingEstimatedDateMin": null,
+              "orderIsComplete": true,
+              "listId": null,
+              "listType": null,
+              "authorizedDate": "2019-02-07T21:29:54+00:00",
+              "callCenterOperatorName": null,
+              "totalItems": 1,
+              "currencyCode": "BRL"
+            },
+            {
+              "orderId": "v502556llux-01",
+              "creationDate": "2019-01-28T20:09:43+00:00",
+              "clientName": "Rodrigo VTEX",
+              "items": null,
+              "totalValue": 1160,
+              "paymentNames": "Boleto Bancário",
+              "status": "handling",
+              "statusDescription": "Preparando Entrega",
+              "marketPlaceOrderId": null,
+              "sequence": "502556",
+              "salesChannel": "1",
+              "affiliateId": "",
+              "origin": "Marketplace",
+              "workflowInErrorState": false,
+              "workflowInRetry": false,
+              "lastMessageUnread": " Lux Store Seu pedido foi alterado! Pedido realizado em: 28/01/2019 Olá, Rodrigo. Seu pedido foi alterado. Seguem informações abaixo: ",
+              "ShippingEstimatedDate": "2019-02-04T20:33:46+00:00",
+              "ShippingEstimatedDateMax": null,
+              "ShippingEstimatedDateMin": null,
+              "orderIsComplete": true,
+              "listId": null,
+              "listType": null,
+              "authorizedDate": "2019-01-28T20:33:04+00:00",
+              "callCenterOperatorName": null,
+              "totalItems": 1,
+              "currencyCode": "BRL"
+            },
+            {
+              "orderId": "v502553llux-01",
+              "creationDate": "2019-01-24T12:35:19+00:00",
+              "clientName": "test test",
+              "items": null,
+              "totalValue": 10150,
+              "paymentNames": "Mastercard",
+              "status": "ready-for-handling",
+              "statusDescription": "Pronto para o manuseio",
+              "marketPlaceOrderId": null,
+              "sequence": "502554",
+              "salesChannel": "1",
+              "affiliateId": "",
+              "origin": "Marketplace",
+              "workflowInErrorState": false,
+              "workflowInRetry": false,
+              "lastMessageUnread": " Lux Store 96 Sua Nota Fiscal foi emitida. Referente ao Pedido #v502553llux-01 Olá, test. Estamos empacotando seu produto para provide",
+              "ShippingEstimatedDate": "2019-01-31T12:36:30+00:00",
+              "ShippingEstimatedDateMax": null,
+              "ShippingEstimatedDateMin": null,
+              "orderIsComplete": true,
+              "listId": null,
+              "listType": null,
+              "authorizedDate": "2019-01-24T12:36:01+00:00",
+              "callCenterOperatorName": null,
+              "totalItems": 1,
+              "currencyCode": "BRL"
+            },
+            {
+              "orderId": "v502550llux-01",
+              "creationDate": "2019-01-23T16:39:45+00:00",
+              "clientName": "test test",
+              "items": null,
+              "totalValue": 10150,
+              "paymentNames": "Mastercard",
+              "status": "ready-for-handling",
+              "statusDescription": "Pronto para o manuseio",
+              "marketPlaceOrderId": null,
+              "sequence": "502551",
+              "salesChannel": "1",
+              "affiliateId": "",
+              "origin": "Marketplace",
+              "workflowInErrorState": false,
+              "workflowInRetry": false,
+              "lastMessageUnread": " Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502550llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc",
+              "ShippingEstimatedDate": "2019-01-30T16:40:55+00:00",
+              "ShippingEstimatedDateMax": null,
+              "ShippingEstimatedDateMin": null,
+              "orderIsComplete": true,
+              "listId": null,
+              "listType": null,
+              "authorizedDate": "2019-01-23T16:40:27+00:00",
+              "callCenterOperatorName": null,
+              "totalItems": 1,
+              "currencyCode": "BRL"
+            },
+            {
+              "orderId": "v502547llux-01",
+              "creationDate": "2019-01-23T16:34:20+00:00",
+              "clientName": "test test",
+              "items": null,
+              "totalValue": 10150,
+              "paymentNames": "Mastercard",
+              "status": "ready-for-handling",
+              "statusDescription": "Pronto para o manuseio",
+              "marketPlaceOrderId": null,
+              "sequence": "502548",
+              "salesChannel": "1",
+              "affiliateId": "",
+              "origin": "Marketplace",
+              "workflowInErrorState": false,
+              "workflowInRetry": false,
+              "lastMessageUnread": " Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502547llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc",
+              "ShippingEstimatedDate": "2019-01-30T16:35:30+00:00",
+              "ShippingEstimatedDateMax": null,
+              "ShippingEstimatedDateMin": null,
+              "orderIsComplete": true,
+              "listId": null,
+              "listType": null,
+              "authorizedDate": "2019-01-23T16:35:04+00:00",
+              "callCenterOperatorName": null,
+              "totalItems": 1,
+              "currencyCode": "BRL"
+            },
+            {
+              "orderId": "v502544llux-01",
+              "creationDate": "2018-12-28T18:15:28+00:00",
+              "clientName": "test test",
+              "items": null,
+              "totalValue": 8990,
+              "paymentNames": "Boleto Bancário",
+              "status": "canceled",
+              "statusDescription": "Cancelado",
+              "marketPlaceOrderId": null,
+              "sequence": "502544",
+              "salesChannel": "1",
+              "affiliateId": "",
+              "origin": "Marketplace",
+              "workflowInErrorState": false,
+              "workflowInRetry": false,
+              "lastMessageUnread": " Lux Store 96 Seu pedido foi cancelado. Referente ao Pedido #v502544llux-01 Resumo Itens R$ 89,90 Total R$ 89,90 Produto Alavanca De M",
+              "ShippingEstimatedDate": null,
+              "ShippingEstimatedDateMax": null,
+              "ShippingEstimatedDateMin": null,
+              "orderIsComplete": true,
+              "listId": null,
+              "listType": null,
+              "authorizedDate": null,
+              "callCenterOperatorName": null,
+              "totalItems": 1,
+              "currencyCode": "BRL"
+            },
+            {
+              "orderId": "v502541llux-01",
+              "creationDate": "2018-12-18T18:48:17+00:00",
+              "clientName": "Douglas Rodrigues",
+              "items": null,
+              "totalValue": 3290,
+              "paymentNames": "Boleto Bancário",
+              "status": "canceled",
+              "statusDescription": "Cancelado",
+              "marketPlaceOrderId": null,
+              "sequence": "502541",
+              "salesChannel": "1",
+              "affiliateId": "",
+              "origin": "Marketplace",
+              "workflowInErrorState": false,
+              "workflowInRetry": false,
+              "lastMessageUnread": " Lux Store 96 Seu pedido foi cancelado. Referente ao Pedido #v502541llux-01 Resumo Itens R$ 32,90 Total R$ 32,90 Produto Bay Max L 1 u",
+              "ShippingEstimatedDate": null,
+              "ShippingEstimatedDateMax": null,
+              "ShippingEstimatedDateMin": null,
+              "orderIsComplete": true,
+              "listId": null,
+              "listType": null,
+              "authorizedDate": null,
+              "callCenterOperatorName": null,
+              "totalItems": 1,
+              "currencyCode": "BRL"
+            },
+            {
+              "orderId": "v502538llux-01",
+              "creationDate": "2018-12-12T18:21:47+00:00",
+              "clientName": "test test",
+              "items": null,
+              "totalValue": 8990,
+              "paymentNames": "Mastercard",
+              "status": "ready-for-handling",
+              "statusDescription": "Pronto para o manuseio",
+              "marketPlaceOrderId": null,
+              "sequence": "502538",
+              "salesChannel": "1",
+              "affiliateId": "",
+              "origin": "Marketplace",
+              "workflowInErrorState": false,
+              "workflowInRetry": false,
+              "lastMessageUnread": " Lux Store 96 Seu pagamento foi aprovado. Referente ao Pedido #v502538llux-01 Olá, test. Estamos providenciando a emissão da Nota Fisc",
+              "ShippingEstimatedDate": "2018-12-19T18:22:26+00:00",
+              "ShippingEstimatedDateMax": null,
+              "ShippingEstimatedDateMin": null,
+              "orderIsComplete": true,
+              "listId": null,
+              "listType": null,
+              "authorizedDate": "2018-12-12T18:22:22+00:00",
+              "callCenterOperatorName": null,
+              "totalItems": 1,
+              "currencyCode": "BRL"
+            },
+            {
+              "orderId": "SCP-880102018018-01",
+              "creationDate": "2018-11-30T17:34:01+00:00",
+              "clientName": "roberta grecco",
+              "items": null,
+              "totalValue": 1250,
+              "paymentNames": "",
+              "status": "canceled",
+              "statusDescription": "Cancelado",
+              "marketPlaceOrderId": "880102018018-01",
+              "sequence": "502537",
+              "salesChannel": "1",
+              "affiliateId": "SCP",
+              "origin": "Fulfillment",
+              "workflowInErrorState": false,
+              "workflowInRetry": false,
+              "lastMessageUnread": "cancelamento teste shp ",
+              "ShippingEstimatedDate": null,
+              "ShippingEstimatedDateMax": null,
+              "ShippingEstimatedDateMin": null,
+              "orderIsComplete": true,
+              "listId": null,
+              "listType": null,
+              "authorizedDate": "2018-11-30T17:34:42+00:00",
+              "callCenterOperatorName": null,
+              "totalItems": 1,
+              "currencyCode": "BRL"
+            },
+            {
+              "orderId": "SCP-880091692043-01",
+              "creationDate": "2018-11-30T17:28:35+00:00",
+              "clientName": "roberta grecco",
+              "items": null,
+              "totalValue": 1250,
+              "paymentNames": "",
+              "status": "invoiced",
+              "statusDescription": "Faturado",
+              "marketPlaceOrderId": "880091692043-01",
+              "sequence": "502536",
+              "salesChannel": "1",
+              "affiliateId": "SCP",
+              "origin": "Fulfillment",
+              "workflowInErrorState": false,
+              "workflowInRetry": false,
+              "lastMessageUnread": null,
+              "ShippingEstimatedDate": null,
+              "ShippingEstimatedDateMax": null,
+              "ShippingEstimatedDateMin": null,
+              "orderIsComplete": true,
+              "listId": null,
+              "listType": null,
+              "authorizedDate": "2018-11-30T17:29:22+00:00",
+              "callCenterOperatorName": null,
+              "totalItems": 1,
+              "currencyCode": "BRL"
+            },
+            {
+              "orderId": "SCP-880091058221-01",
+              "creationDate": "2018-11-30T17:18:00+00:00",
+              "clientName": "roberta grecco",
+              "items": null,
+              "totalValue": 1250,
+              "paymentNames": "",
+              "status": "canceled",
+              "statusDescription": "Cancelado",
+              "marketPlaceOrderId": "880091058221-01",
+              "sequence": "502535",
+              "salesChannel": "1",
+              "affiliateId": "SCP",
+              "origin": "Fulfillment",
+              "workflowInErrorState": false,
+              "workflowInRetry": false,
+              "lastMessageUnread": "Teste de cancelamento do ShopFácil ",
+              "ShippingEstimatedDate": null,
+              "ShippingEstimatedDateMax": null,
+              "ShippingEstimatedDateMin": null,
+              "orderIsComplete": true,
+              "listId": null,
+              "listType": null,
+              "authorizedDate": "2018-11-30T17:18:44+00:00",
+              "callCenterOperatorName": null,
+              "totalItems": 1,
+              "currencyCode": "BRL"
+            },
+            {
+              "orderId": "SCP-880090643370-01",
+              "creationDate": "2018-11-30T17:10:59+00:00",
+              "clientName": "roberta grecco",
+              "items": null,
+              "totalValue": 1250,
+              "paymentNames": "",
+              "status": "ready-for-handling",
+              "statusDescription": "Pronto para o manuseio",
+              "marketPlaceOrderId": "880090643370-01",
+              "sequence": "502534",
+              "salesChannel": "1",
+              "affiliateId": "SCP",
+              "origin": "Fulfillment",
+              "workflowInErrorState": false,
+              "workflowInRetry": false,
+              "lastMessageUnread": null,
+              "ShippingEstimatedDate": "2018-12-07T17:11:39+00:00",
+              "ShippingEstimatedDateMax": null,
+              "ShippingEstimatedDateMin": null,
+              "orderIsComplete": true,
+              "listId": null,
+              "listType": null,
+              "authorizedDate": "2018-11-30T17:11:42+00:00",
+              "callCenterOperatorName": null,
+              "totalItems": 1,
+              "currencyCode": "BRL"
+            },
+            {
+              "orderId": "SCP-880090622238-01",
+              "creationDate": "2018-11-30T17:10:45+00:00",
+              "clientName": "roberta grecco",
+              "items": null,
+              "totalValue": 1250,
+              "paymentNames": "",
+              "status": "canceled",
+              "statusDescription": "Cancelado",
+              "marketPlaceOrderId": "880090622238-01",
+              "sequence": "502533",
+              "salesChannel": "1",
+              "affiliateId": "SCP",
+              "origin": "Fulfillment",
+              "workflowInErrorState": false,
+              "workflowInRetry": false,
+              "lastMessageUnread": null,
+              "ShippingEstimatedDate": null,
+              "ShippingEstimatedDateMax": null,
+              "ShippingEstimatedDateMin": null,
+              "orderIsComplete": true,
+              "listId": null,
+              "listType": null,
+              "authorizedDate": null,
+              "callCenterOperatorName": null,
+              "totalItems": 1,
+              "currencyCode": "BRL"
+            },
+            {
+              "orderId": "MNC-877730530419-01",
+              "creationDate": "2018-11-20T21:09:01+00:00",
+              "clientName": "Carlos VTEX",
+              "items": null,
+              "totalValue": 11150,
+              "paymentNames": "",
+              "status": "canceled",
+              "statusDescription": "Cancelado",
+              "marketPlaceOrderId": "877730530419-01",
+              "sequence": "502532",
+              "salesChannel": "1",
+              "affiliateId": "MNC",
+              "origin": "Fulfillment",
+              "workflowInErrorState": false,
+              "workflowInRetry": false,
+              "lastMessageUnread": null,
+              "ShippingEstimatedDate": null,
+              "ShippingEstimatedDateMax": null,
+              "ShippingEstimatedDateMin": null,
+              "orderIsComplete": true,
+              "listId": null,
+              "listType": null,
+              "authorizedDate": "2018-11-20T21:13:06+00:00",
+              "callCenterOperatorName": null,
+              "totalItems": 1,
+              "currencyCode": "BRL"
+            },
+            {
+              "orderId": "SCP-876733475998-01",
+              "creationDate": "2018-11-16T16:58:18+00:00",
+              "clientName": "roberta grecco",
+              "items": null,
+              "totalValue": 1250,
+              "paymentNames": "",
+              "status": "ready-for-handling",
+              "statusDescription": "Pronto para o manuseio",
+              "marketPlaceOrderId": "876733475998-01",
+              "sequence": "502531",
+              "salesChannel": "1",
+              "affiliateId": "SCP",
+              "origin": "Fulfillment",
+              "workflowInErrorState": false,
+              "workflowInRetry": false,
+              "lastMessageUnread": null,
+              "ShippingEstimatedDate": "2018-11-23T16:58:48+00:00",
+              "ShippingEstimatedDateMax": null,
+              "ShippingEstimatedDateMin": null,
+              "orderIsComplete": true,
+              "listId": null,
+              "listType": null,
+              "authorizedDate": "2018-11-16T16:58:53+00:00",
+              "callCenterOperatorName": null,
+              "totalItems": 1,
+              "currencyCode": "BRL"
+            }
+          ],
+          "facets": [],
+          "paging": {
+            "total": 84,
+            "pages": 6,
+            "currentPage": 1,
+            "perPage": 15
+          },
+          "stats": {
+            "stats": {
+              "totalValue": {
+                "Count": 84,
+                "Max": 21526180,
+                "Mean": 262672.75,
+                "Min": 1160,
+                "Missing": 0,
+                "StdDev": 2348087.3869179883,
+                "Sum": 22064511,
+                "SumOfSquares": 463417439039853,
+                "Facets": {
+                  "origin": {
+                    "Fulfillment": {
+                      "Count": 68,
+                      "Max": 11150,
+                      "Mean": 1395.5882352941176,
+                      "Min": 1250,
+                      "Missing": 0,
+                      "StdDev": 1200.5513439298484,
+                      "Sum": 94900,
+                      "SumOfSquares": 229010000,
+                      "Facets": null
+                    },
+                    "Marketplace": {
+                      "Count": 16,
+                      "Max": 21526180,
+                      "Mean": 1373100.6875,
+                      "Min": 1160,
+                      "Missing": 0,
+                      "StdDev": 5374326.141087491,
+                      "Sum": 21969611,
+                      "SumOfSquares": 463417210029853,
+                      "Facets": null
+                    }
+                  },
+                  "currencyCode": {
+                    "BRL": {
+                      "Count": 84,
+                      "Max": 21526180,
+                      "Mean": 262672.75,
+                      "Min": 1160,
+                      "Missing": 0,
+                      "StdDev": 2348087.3869179883,
+                      "Sum": 22064511,
+                      "SumOfSquares": 463417439039853,
+                      "Facets": null
+                    }
+                  }
+                }
+              },
+              "totalItems": {
+                "Count": 84,
+                "Max": 89,
+                "Mean": 2.2261904761904763,
+                "Min": 1,
+                "Missing": 0,
+                "StdDev": 9.660940100525016,
+                "Sum": 187,
+                "SumOfSquares": 8163,
+                "Facets": {
+                  "origin": {
+                    "Fulfillment": {
+                      "Count": 68,
+                      "Max": 1,
+                      "Mean": 1,
+                      "Min": 1,
+                      "Missing": 0,
+                      "StdDev": 0,
+                      "Sum": 68,
+                      "SumOfSquares": 68,
+                      "Facets": null
+                    },
+                    "Marketplace": {
+                      "Count": 16,
+                      "Max": 89,
+                      "Mean": 7.4375,
+                      "Min": 1,
+                      "Missing": 0,
+                      "StdDev": 21.92401651157926,
+                      "Sum": 119,
+                      "SumOfSquares": 8095,
+                      "Facets": null
+                    }
+                  },
+                  "currencyCode": {
+                    "BRL": {
+                      "Count": 84,
+                      "Max": 89,
+                      "Mean": 2.2261904761904763,
+                      "Min": 1,
+                      "Missing": 0,
+                      "StdDev": 9.660940100525016,
+                      "Sum": 187,
+                      "SumOfSquares": 8163,
+                      "Facets": null
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
+      "List": {
+        "title": "List",
+        "required": [
+          "orderId",
+          "creationDate",
+          "clientName",
+          "items",
+          "totalValue",
+          "paymentNames",
+          "status",
+          "statusDescription",
+          "marketPlaceOrderId",
+          "sequence",
+          "salesChannel",
+          "affiliateId",
+          "origin",
+          "workflowInErrorState",
+          "workflowInRetry",
+          "lastMessageUnread",
+          "ShippingEstimatedDate",
+          "ShippingEstimatedDateMax",
+          "ShippingEstimatedDateMin",
+          "orderIsComplete",
+          "listId",
+          "listType",
+          "authorizedDate",
+          "callCenterOperatorName",
+          "totalItems",
+          "currencyCode"
+        ],
+        "type": "object",
+        "properties": {
+          "orderId": {
+            "type": "string"
+          },
+          "creationDate": {
+            "type": "string"
+          },
+          "clientName": {
+            "type": "string"
+          },
+          "items": {
+            "type": "string",
+            "nullable": true
+          },
+          "totalValue": {
+            "type": "integer"
+          },
+          "paymentNames": {
+            "type": "string"
+          },
+          "status": {
+            "type": "string"
+          },
+          "statusDescription": {
+            "type": "string",
+            "description": "`Deprecated`. Status description which is displayed on the Admin panel. This field is obsolete and may not return any value."
+          },
+          "marketPlaceOrderId": {
+            "type": "string",
+            "nullable": true
+          },
+          "sequence": {
+            "type": "string"
+          },
+          "salesChannel": {
+            "type": "string"
+          },
+          "affiliateId": {
+            "type": "string"
+          },
+          "origin": {
+            "type": "string"
+          },
+          "workflowInErrorState": {
+            "type": "boolean"
+          },
+          "workflowInRetry": {
+            "type": "boolean"
+          },
+          "lastMessageUnread": {
+            "type": "string",
+            "nullable": true
+          },
+          "ShippingEstimatedDate": {
+            "type": "string",
+            "nullable": true
+          },
+          "ShippingEstimatedDateMax": {
+            "type": "string",
+            "nullable": true
+          },
+          "ShippingEstimatedDateMin": {
+            "type": "string",
+            "nullable": true
+          },
+          "orderIsComplete": {
+            "type": "boolean"
+          },
+          "listId": {
+            "type": "string",
+            "nullable": true
+          },
+          "listType": {
+            "type": "string",
+            "nullable": true
+          },
+          "authorizedDate": {
+            "type": "string",
+            "nullable": true
+          },
+          "callCenterOperatorName": {
+            "type": "string",
+            "nullable": true
+          },
+          "totalItems": {
+            "type": "integer"
+          },
+          "currencyCode": {
+            "type": "string"
+          }
+        },
+        "example": {
+          "orderId": "v502559llux-01",
+          "creationDate": "2019-02-04T10:29:11+00:00",
+          "clientName": "J C",
+          "items": null,
+          "totalValue": 7453,
+          "paymentNames": "Boleto Bancário",
+          "status": "invoiced",
+          "statusDescription": "Faturado",
+          "marketPlaceOrderId": null,
+          "sequence": "502559",
+          "salesChannel": "1",
+          "affiliateId": "",
+          "origin": "Marketplace",
+          "workflowInErrorState": false,
+          "workflowInRetry": false,
+          "lastMessageUnread": " Lux Store 96 Sua Nota Fiscal foi emitida. Referente ao Pedido #v502559llux-01 Olá, J. Estamos empacotando seu produto para providenci",
+          "ShippingEstimatedDate": null,
+          "ShippingEstimatedDateMax": null,
+          "ShippingEstimatedDateMin": null,
+          "orderIsComplete": true,
+          "listId": null,
+          "listType": null,
+          "authorizedDate": "2019-02-07T21:29:54+00:00",
+          "callCenterOperatorName": null,
+          "totalItems": 1,
+          "currencyCode": "BRL"
+        }
+      },
+      "Paging": {
+        "type": "object",
+        "description": "Pagination information.",
+        "required": [
+          "total",
+          "pages",
+          "currentPage",
+          "perPage"
+        ],
+        "properties": {
+          "total": {
+            "type": "integer",
+            "description": "Total number of orders."
+          },
+          "pages": {
+            "type": "integer",
+            "description": "Total number of pages."
+          },
+          "currentPage": {
+            "type": "integer",
+            "description": "Number of the current page."
+          },
+          "perPage": {
+            "type": "integer",
+            "description": "Number of orders per page."
+          }
+        }
+      },
+      "Stats": {
+        "title": "Stats",
+        "required": [
+          "stats"
+        ],
+        "type": "object",
+        "properties": {
+          "stats": {
+            "$ref": "#/components/schemas/Stats1"
+          }
+        },
+        "example": {
+          "stats": {
+            "totalValue": {
+              "Count": 84,
+              "Max": 21526180,
+              "Mean": 262672.75,
+              "Min": 1160,
+              "Missing": 0,
+              "StdDev": 2348087.3869179883,
+              "Sum": 22064511,
+              "SumOfSquares": 463417439039853,
+              "Facets": {
+                "origin": {
+                  "Fulfillment": {
+                    "Count": 68,
+                    "Max": 11150,
+                    "Mean": 1395.5882352941176,
+                    "Min": 1250,
+                    "Missing": 0,
+                    "StdDev": 1200.5513439298484,
+                    "Sum": 94900,
+                    "SumOfSquares": 229010000,
+                    "Facets": null
+                  },
+                  "Marketplace": {
+                    "Count": 16,
+                    "Max": 21526180,
+                    "Mean": 1373100.6875,
+                    "Min": 1160,
+                    "Missing": 0,
+                    "StdDev": 5374326.141087491,
+                    "Sum": 21969611,
+                    "SumOfSquares": 463417210029853,
+                    "Facets": null
+                  }
+                },
+                "currencyCode": {
+                  "BRL": {
+                    "Count": 84,
+                    "Max": 21526180,
+                    "Mean": 262672.75,
+                    "Min": 1160,
+                    "Missing": 0,
+                    "StdDev": 2348087.3869179883,
+                    "Sum": 22064511,
+                    "SumOfSquares": 463417439039853,
+                    "Facets": null
+                  }
+                }
+              }
+            },
+            "totalItems": {
+              "Count": 84,
+              "Max": 89,
+              "Mean": 2.2261904761904763,
+              "Min": 1,
+              "Missing": 0,
+              "StdDev": 9.660940100525016,
+              "Sum": 187,
+              "SumOfSquares": 8163,
+              "Facets": {
+                "origin": {
+                  "Fulfillment": {
+                    "Count": 68,
+                    "Max": 1,
+                    "Mean": 1,
+                    "Min": 1,
+                    "Missing": 0,
+                    "StdDev": 0,
+                    "Sum": 68,
+                    "SumOfSquares": 68,
+                    "Facets": null
+                  },
+                  "Marketplace": {
+                    "Count": 16,
+                    "Max": 89,
+                    "Mean": 7.4375,
+                    "Min": 1,
+                    "Missing": 0,
+                    "StdDev": 21.92401651157926,
+                    "Sum": 119,
+                    "SumOfSquares": 8095,
+                    "Facets": null
+                  }
+                },
+                "currencyCode": {
+                  "BRL": {
+                    "Count": 84,
+                    "Max": 89,
+                    "Mean": 2.2261904761904763,
+                    "Min": 1,
+                    "Missing": 0,
+                    "StdDev": 9.660940100525016,
+                    "Sum": 187,
+                    "SumOfSquares": 8163,
+                    "Facets": null
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
+      "Stats1": {
+        "title": "Stats1",
+        "required": [
+          "totalValue",
+          "totalItems"
+        ],
+        "type": "object",
+        "properties": {
+          "totalValue": {
+            "$ref": "#/components/schemas/TotalValue"
+          },
+          "totalItems": {
+            "$ref": "#/components/schemas/TotalItems"
+          }
+        },
+        "example": {
+          "totalValue": {
+            "Count": 84,
+            "Max": 21526180,
+            "Mean": 262672.75,
+            "Min": 1160,
+            "Missing": 0,
+            "StdDev": 2348087.3869179883,
+            "Sum": 22064511,
+            "SumOfSquares": 463417439039853,
+            "Facets": {
+              "origin": {
+                "Fulfillment": {
+                  "Count": 68,
+                  "Max": 11150,
+                  "Mean": 1395.5882352941176,
+                  "Min": 1250,
+                  "Missing": 0,
+                  "StdDev": 1200.5513439298484,
+                  "Sum": 94900,
+                  "SumOfSquares": 229010000,
+                  "Facets": null
+                },
+                "Marketplace": {
+                  "Count": 16,
+                  "Max": 21526180,
+                  "Mean": 1373100.6875,
+                  "Min": 1160,
+                  "Missing": 0,
+                  "StdDev": 5374326.141087491,
+                  "Sum": 21969611,
+                  "SumOfSquares": 463417210029853,
+                  "Facets": null
+                }
+              },
+              "currencyCode": {
+                "BRL": {
+                  "Count": 84,
+                  "Max": 21526180,
+                  "Mean": 262672.75,
+                  "Min": 1160,
+                  "Missing": 0,
+                  "StdDev": 2348087.3869179883,
+                  "Sum": 22064511,
+                  "SumOfSquares": 463417439039853,
+                  "Facets": null
+                }
+              }
+            }
+          },
+          "totalItems": {
+            "Count": 84,
+            "Max": 89,
+            "Mean": 2.2261904761904763,
+            "Min": 1,
+            "Missing": 0,
+            "StdDev": 9.660940100525016,
+            "Sum": 187,
+            "SumOfSquares": 8163,
+            "Facets": {
+              "origin": {
+                "Fulfillment": {
+                  "Count": 68,
+                  "Max": 1,
+                  "Mean": 1,
+                  "Min": 1,
+                  "Missing": 0,
+                  "StdDev": 0,
+                  "Sum": 68,
+                  "SumOfSquares": 68,
+                  "Facets": null
+                },
+                "Marketplace": {
+                  "Count": 16,
+                  "Max": 89,
+                  "Mean": 7.4375,
+                  "Min": 1,
+                  "Missing": 0,
+                  "StdDev": 21.92401651157926,
+                  "Sum": 119,
+                  "SumOfSquares": 8095,
+                  "Facets": null
+                }
+              },
+              "currencyCode": {
+                "BRL": {
+                  "Count": 84,
+                  "Max": 89,
+                  "Mean": 2.2261904761904763,
+                  "Min": 1,
+                  "Missing": 0,
+                  "StdDev": 9.660940100525016,
+                  "Sum": 187,
+                  "SumOfSquares": 8163,
+                  "Facets": null
+                }
+              }
+            }
+          }
+        }
+      },
+      "TotalValue": {
+        "title": "TotalValue",
+        "required": [
+          "Count",
+          "Max",
+          "Mean",
+          "Min",
+          "Missing",
+          "StdDev",
+          "Sum",
+          "SumOfSquares",
+          "Facets"
+        ],
+        "type": "object",
+        "properties": {
+          "Count": {
+            "type": "integer"
+          },
+          "Max": {
+            "type": "integer"
+          },
+          "Mean": {
+            "type": "number"
+          },
+          "Min": {
+            "type": "integer"
+          },
+          "Missing": {
+            "type": "integer"
+          },
+          "StdDev": {
+            "type": "number"
+          },
+          "Sum": {
+            "type": "integer"
+          },
+          "SumOfSquares": {
+            "type": "integer"
+          },
+          "Facets": {
+            "$ref": "#/components/schemas/Facets"
+          }
+        },
+        "example": {
+          "Count": 84,
+          "Max": 21526180,
+          "Mean": 262672.75,
+          "Min": 1160,
+          "Missing": 0,
+          "StdDev": 2348087.3869179883,
+          "Sum": 22064511,
+          "SumOfSquares": 463417439039853,
+          "Facets": {
+            "origin": {
+              "Fulfillment": {
+                "Count": 68,
+                "Max": 11150,
+                "Mean": 1395.5882352941176,
+                "Min": 1250,
+                "Missing": 0,
+                "StdDev": 1200.5513439298484,
+                "Sum": 94900,
+                "SumOfSquares": 229010000,
+                "Facets": null
+              },
+              "Marketplace": {
+                "Count": 16,
+                "Max": 21526180,
+                "Mean": 1373100.6875,
+                "Min": 1160,
+                "Missing": 0,
+                "StdDev": 5374326.141087491,
+                "Sum": 21969611,
+                "SumOfSquares": 463417210029853,
+                "Facets": null
+              }
+            },
+            "currencyCode": {
+              "BRL": {
+                "Count": 84,
+                "Max": 21526180,
+                "Mean": 262672.75,
+                "Min": 1160,
+                "Missing": 0,
+                "StdDev": 2348087.3869179883,
+                "Sum": 22064511,
+                "SumOfSquares": 463417439039853,
+                "Facets": null
+              }
+            }
+          }
+        }
+      },
+      "Facets": {
+        "title": "Facets",
+        "required": [
+          "origin",
+          "currencyCode"
+        ],
+        "type": "object",
+        "properties": {
+          "origin": {
+            "$ref": "#/components/schemas/Origin"
+          },
+          "currencyCode": {
+            "$ref": "#/components/schemas/CurrencyCode"
+          }
+        },
+        "example": {
+          "origin": {
+            "Fulfillment": {
+              "Count": 68,
+              "Max": 11150,
+              "Mean": 1395.5882352941176,
+              "Min": 1250,
+              "Missing": 0,
+              "StdDev": 1200.5513439298484,
+              "Sum": 94900,
+              "SumOfSquares": 229010000,
+              "Facets": null
+            },
+            "Marketplace": {
+              "Count": 16,
+              "Max": 21526180,
+              "Mean": 1373100.6875,
+              "Min": 1160,
+              "Missing": 0,
+              "StdDev": 5374326.141087491,
+              "Sum": 21969611,
+              "SumOfSquares": 463417210029853,
+              "Facets": null
+            }
+          },
+          "currencyCode": {
+            "BRL": {
+              "Count": 84,
+              "Max": 21526180,
+              "Mean": 262672.75,
+              "Min": 1160,
+              "Missing": 0,
+              "StdDev": 2348087.3869179883,
+              "Sum": 22064511,
+              "SumOfSquares": 463417439039853,
+              "Facets": null
+            }
+          }
+        }
+      },
+      "Origin": {
+        "title": "Origin",
+        "required": [
+          "Fulfillment",
+          "Marketplace"
+        ],
+        "type": "object",
+        "properties": {
+          "Fulfillment": {
+            "$ref": "#/components/schemas/Fulfillment"
+          },
+          "Marketplace": {
+            "$ref": "#/components/schemas/Marketplace1"
+          }
+        },
+        "example": {
+          "Fulfillment": {
+            "Count": 68,
+            "Max": 11150,
+            "Mean": 1395.5882352941176,
+            "Min": 1250,
+            "Missing": 0,
+            "StdDev": 1200.5513439298484,
+            "Sum": 94900,
+            "SumOfSquares": 229010000,
+            "Facets": null
+          },
+          "Marketplace": {
+            "Count": 16,
+            "Max": 21526180,
+            "Mean": 1373100.6875,
+            "Min": 1160,
+            "Missing": 0,
+            "StdDev": 5374326.141087491,
+            "Sum": 21969611,
+            "SumOfSquares": 463417210029853,
+            "Facets": null
+          }
+        }
+      },
+      "Fulfillment": {
+        "title": "Fulfillment",
+        "required": [
+          "Count",
+          "Max",
+          "Mean",
+          "Min",
+          "Missing",
+          "StdDev",
+          "Sum",
+          "SumOfSquares",
+          "Facets"
+        ],
+        "type": "object",
+        "properties": {
+          "Count": {
+            "type": "integer"
+          },
+          "Max": {
+            "type": "integer"
+          },
+          "Mean": {
+            "type": "number"
+          },
+          "Min": {
+            "type": "integer"
+          },
+          "Missing": {
+            "type": "integer"
+          },
+          "StdDev": {
+            "type": "number"
+          },
+          "Sum": {
+            "type": "integer"
+          },
+          "SumOfSquares": {
+            "type": "integer"
+          },
+          "Facets": {
+            "type": "string",
+            "nullable": true
+          }
+        },
+        "example": {
+          "Count": 68,
+          "Max": 11150,
+          "Mean": 1395.5882352941176,
+          "Min": 1250,
+          "Missing": 0,
+          "StdDev": 1200.5513439298484,
+          "Sum": 94900,
+          "SumOfSquares": 229010000,
+          "Facets": null
+        }
+      },
+      "Marketplace1": {
+        "title": "Marketplace1",
+        "required": [
+          "Count",
+          "Max",
+          "Mean",
+          "Min",
+          "Missing",
+          "StdDev",
+          "Sum",
+          "SumOfSquares",
+          "Facets"
+        ],
+        "type": "object",
+        "properties": {
+          "Count": {
+            "type": "integer"
+          },
+          "Max": {
+            "type": "integer"
+          },
+          "Mean": {
+            "type": "number"
+          },
+          "Min": {
+            "type": "integer"
+          },
+          "Missing": {
+            "type": "integer"
+          },
+          "StdDev": {
+            "type": "number"
+          },
+          "Sum": {
+            "type": "integer"
+          },
+          "SumOfSquares": {
+            "type": "integer"
+          },
+          "Facets": {
+            "type": "string",
+            "nullable": true
+          }
+        },
+        "example": {
+          "Count": 16,
+          "Max": 21526180,
+          "Mean": 1373100.6875,
+          "Min": 1160,
+          "Missing": 0,
+          "StdDev": 5374326.141087491,
+          "Sum": 21969611,
+          "SumOfSquares": 463417210029853,
+          "Facets": null
+        }
+      },
+      "CurrencyCode": {
+        "title": "CurrencyCode",
+        "required": [
+          "BRL"
+        ],
+        "type": "object",
+        "properties": {
+          "BRL": {
+            "$ref": "#/components/schemas/BRL"
+          }
+        },
+        "example": {
+          "BRL": {
+            "Count": 84,
+            "Max": 21526180,
+            "Mean": 262672.75,
+            "Min": 1160,
+            "Missing": 0,
+            "StdDev": 2348087.3869179883,
+            "Sum": 22064511,
+            "SumOfSquares": 463417439039853,
+            "Facets": null
+          }
+        }
+      },
+      "BRL": {
+        "title": "BRL",
+        "required": [
+          "Count",
+          "Max",
+          "Mean",
+          "Min",
+          "Missing",
+          "StdDev",
+          "Sum",
+          "SumOfSquares",
+          "Facets"
+        ],
+        "type": "object",
+        "properties": {
+          "Count": {
+            "type": "integer"
+          },
+          "Max": {
+            "type": "integer"
+          },
+          "Mean": {
+            "type": "number"
+          },
+          "Min": {
+            "type": "integer"
+          },
+          "Missing": {
+            "type": "integer"
+          },
+          "StdDev": {
+            "type": "number"
+          },
+          "Sum": {
+            "type": "integer"
+          },
+          "SumOfSquares": {
+            "type": "integer"
+          },
+          "Facets": {
+            "type": "string",
+            "nullable": true
+          }
+        },
+        "example": {
+          "Count": 84,
+          "Max": 21526180,
+          "Mean": 262672.75,
+          "Min": 1160,
+          "Missing": 0,
+          "StdDev": 2348087.3869179883,
+          "Sum": 22064511,
+          "SumOfSquares": 463417439039853,
+          "Facets": null
+        }
+      },
+      "TotalItems": {
+        "title": "TotalItems",
+        "required": [
+          "Count",
+          "Max",
+          "Mean",
+          "Min",
+          "Missing",
+          "StdDev",
+          "Sum",
+          "SumOfSquares",
+          "Facets"
+        ],
+        "type": "object",
+        "properties": {
+          "Count": {
+            "type": "integer"
+          },
+          "Max": {
+            "type": "integer"
+          },
+          "Mean": {
+            "type": "number"
+          },
+          "Min": {
+            "type": "integer"
+          },
+          "Missing": {
+            "type": "integer"
+          },
+          "StdDev": {
+            "type": "number"
+          },
+          "Sum": {
+            "type": "integer"
+          },
+          "SumOfSquares": {
+            "type": "integer"
+          },
+          "Facets": {
+            "$ref": "#/components/schemas/Facets1"
+          }
+        },
+        "example": {
+          "Count": 84,
+          "Max": 89,
+          "Mean": 2.2261904761904763,
+          "Min": 1,
+          "Missing": 0,
+          "StdDev": 9.660940100525016,
+          "Sum": 187,
+          "SumOfSquares": 8163,
+          "Facets": {
+            "origin": {
+              "Fulfillment": {
+                "Count": 68,
+                "Max": 1,
+                "Mean": 1,
+                "Min": 1,
+                "Missing": 0,
+                "StdDev": 0,
+                "Sum": 68,
+                "SumOfSquares": 68,
+                "Facets": null
+              },
+              "Marketplace": {
+                "Count": 16,
+                "Max": 89,
+                "Mean": 7.4375,
+                "Min": 1,
+                "Missing": 0,
+                "StdDev": 21.92401651157926,
+                "Sum": 119,
+                "SumOfSquares": 8095,
+                "Facets": null
+              }
+            },
+            "currencyCode": {
+              "BRL": {
+                "Count": 84,
+                "Max": 89,
+                "Mean": 2.2261904761904763,
+                "Min": 1,
+                "Missing": 0,
+                "StdDev": 9.660940100525016,
+                "Sum": 187,
+                "SumOfSquares": 8163,
+                "Facets": null
+              }
+            }
+          }
+        }
+      },
+      "Facets1": {
+        "title": "Facets1",
+        "required": [
+          "origin",
+          "currencyCode"
+        ],
+        "type": "object",
+        "properties": {
+          "origin": {
+            "$ref": "#/components/schemas/Origin1"
+          },
+          "currencyCode": {
+            "$ref": "#/components/schemas/CurrencyCode1"
+          }
+        },
+        "example": {
+          "origin": {
+            "Fulfillment": {
+              "Count": 68,
+              "Max": 1,
+              "Mean": 1,
+              "Min": 1,
+              "Missing": 0,
+              "StdDev": 0,
+              "Sum": 68,
+              "SumOfSquares": 68,
+              "Facets": null
+            },
+            "Marketplace": {
+              "Count": 16,
+              "Max": 89,
+              "Mean": 7.4375,
+              "Min": 1,
+              "Missing": 0,
+              "StdDev": 21.92401651157926,
+              "Sum": 119,
+              "SumOfSquares": 8095,
+              "Facets": null
+            }
+          },
+          "currencyCode": {
+            "BRL": {
+              "Count": 84,
+              "Max": 89,
+              "Mean": 2.2261904761904763,
+              "Min": 1,
+              "Missing": 0,
+              "StdDev": 9.660940100525016,
+              "Sum": 187,
+              "SumOfSquares": 8163,
+              "Facets": null
+            }
+          }
+        }
+      },
+      "Origin1": {
+        "title": "Origin1",
+        "required": [
+          "Fulfillment",
+          "Marketplace"
+        ],
+        "type": "object",
+        "properties": {
+          "Fulfillment": {
+            "$ref": "#/components/schemas/Fulfillment1"
+          },
+          "Marketplace": {
+            "$ref": "#/components/schemas/Marketplace2"
+          }
+        },
+        "example": {
+          "Fulfillment": {
+            "Count": 68,
+            "Max": 1,
+            "Mean": 1,
+            "Min": 1,
+            "Missing": 0,
+            "StdDev": 0,
+            "Sum": 68,
+            "SumOfSquares": 68,
+            "Facets": null
+          },
+          "Marketplace": {
+            "Count": 16,
+            "Max": 89,
+            "Mean": 7.4375,
+            "Min": 1,
+            "Missing": 0,
+            "StdDev": 21.92401651157926,
+            "Sum": 119,
+            "SumOfSquares": 8095,
+            "Facets": null
+          }
+        }
+      },
+      "Fulfillment1": {
+        "title": "Fulfillment1",
+        "required": [
+          "Count",
+          "Max",
+          "Mean",
+          "Min",
+          "Missing",
+          "StdDev",
+          "Sum",
+          "SumOfSquares",
+          "Facets"
+        ],
+        "type": "object",
+        "properties": {
+          "Count": {
+            "type": "integer"
+          },
+          "Max": {
+            "type": "integer"
+          },
+          "Mean": {
+            "type": "integer"
+          },
+          "Min": {
+            "type": "integer"
+          },
+          "Missing": {
+            "type": "integer"
+          },
+          "StdDev": {
+            "type": "integer"
+          },
+          "Sum": {
+            "type": "integer"
+          },
+          "SumOfSquares": {
+            "type": "integer"
+          },
+          "Facets": {
+            "type": "string",
+            "nullable": true
+          }
+        },
+        "example": {
+          "Count": 68,
+          "Max": 1,
+          "Mean": 1,
+          "Min": 1,
+          "Missing": 0,
+          "StdDev": 0,
+          "Sum": 68,
+          "SumOfSquares": 68,
+          "Facets": null
+        }
+      },
+      "Marketplace2": {
+        "title": "Marketplace2",
+        "required": [
+          "Count",
+          "Max",
+          "Mean",
+          "Min",
+          "Missing",
+          "StdDev",
+          "Sum",
+          "SumOfSquares",
+          "Facets"
+        ],
+        "type": "object",
+        "properties": {
+          "Count": {
+            "type": "integer"
+          },
+          "Max": {
+            "type": "integer"
+          },
+          "Mean": {
+            "type": "number"
+          },
+          "Min": {
+            "type": "integer"
+          },
+          "Missing": {
+            "type": "integer"
+          },
+          "StdDev": {
+            "type": "number"
+          },
+          "Sum": {
+            "type": "integer"
+          },
+          "SumOfSquares": {
+            "type": "integer"
+          },
+          "Facets": {
+            "type": "string",
+            "nullable": true
+          }
+        },
+        "example": {
+          "Count": 16,
+          "Max": 89,
+          "Mean": 7.4375,
+          "Min": 1,
+          "Missing": 0,
+          "StdDev": 21.92401651157926,
+          "Sum": 119,
+          "SumOfSquares": 8095,
+          "Facets": null
+        }
+      },
+      "CurrencyCode1": {
+        "title": "CurrencyCode1",
+        "required": [
+          "BRL"
+        ],
+        "type": "object",
+        "properties": {
+          "BRL": {
+            "$ref": "#/components/schemas/BRL1"
+          }
+        },
+        "example": {
+          "BRL": {
+            "Count": 84,
+            "Max": 89,
+            "Mean": 2.2261904761904763,
+            "Min": 1,
+            "Missing": 0,
+            "StdDev": 9.660940100525016,
+            "Sum": 187,
+            "SumOfSquares": 8163,
+            "Facets": null
+          }
+        }
+      },
+      "BRL1": {
+        "title": "BRL1",
+        "required": [
+          "Count",
+          "Max",
+          "Mean",
+          "Min",
+          "Missing",
+          "StdDev",
+          "Sum",
+          "SumOfSquares",
+          "Facets"
+        ],
+        "type": "object",
+        "properties": {
+          "Count": {
+            "type": "integer"
+          },
+          "Max": {
+            "type": "integer"
+          },
+          "Mean": {
+            "type": "number"
+          },
+          "Min": {
+            "type": "integer"
+          },
+          "Missing": {
+            "type": "integer"
+          },
+          "StdDev": {
+            "type": "number"
+          },
+          "Sum": {
+            "type": "integer"
+          },
+          "SumOfSquares": {
+            "type": "integer"
+          },
+          "Facets": {
+            "type": "string",
+            "nullable": true
+          }
+        },
+        "example": {
+          "Count": 84,
+          "Max": 89,
+          "Mean": 2.2261904761904763,
+          "Min": 1,
+          "Missing": 0,
+          "StdDev": 9.660940100525016,
+          "Sum": 187,
+          "SumOfSquares": 8163,
+          "Facets": null
+        }
+      },
+      "Updatepartialinvoice.SendTrackingNumber.Request": {
+        "title": "Updatepartialinvoice.SendTrackingNumber.Request",
+        "required": [
+          "trackingNumber",
+          "trackingUrl",
+          "courier",
+          "dispatchedDate"
+        ],
+        "type": "object",
+        "properties": {
+          "trackingNumber": {
+            "type": "string",
+            "description": "The number code that identifies the order tracking."
+          },
+          "trackingUrl": {
+            "type": "string",
+            "nullable": true,
+            "description": "Package tracking URL."
+          },
+          "dispatchedDate": {
+            "type": "string",
+            "nullable": true,
+            "description": "Date when the package was dispatched. For example, 2023-01-08T13:16:13.4617653+00:00."
+          },
+          "courier": {
+            "type": "string",
+            "nullable": true,
+            "description": "The name of the carrier responsible for delivering the order."
+          }
+        },
+        "example": {
+          "trackingNumber": "87658",
+          "trackingUrl": "https://www.tracking.com/url",
+          "courier": "carrierOne",
+          "dispatchedDate": "2022-02-08T13:16:13.4617653+00:00"
+        }
+      },
+      "Updatepartialinvoice.SendTrackingNumber": {
+        "title": "Updatepartialinvoice.SendTrackingNumber",
+        "required": [
+          "date",
+          "orderId",
+          "receipt"
+        ],
+        "type": "object",
+        "properties": {
+          "date": {
+            "type": "string"
+          },
+          "orderId": {
+            "type": "string"
+          },
+          "receipt": {
+            "type": "string"
+          }
+        },
+        "example": {
+          "date": "2019-02-08T13:16:13.4617653+00:00",
+          "orderId": "00-v5195004lux-01",
+          "receipt": "527b1ae251264ef1b7a9b597cd8f16b9"
+        }
+      },
+      "UpdateTrackingStatusRequest": {
+        "title": "UpdateTrackingStatusRequest",
+        "required": [
+          "isDelivered",
+          "deliveredDate",
+          "events"
+        ],
+        "type": "object",
+        "properties": {
+          "isDelivered": {
+            "type": "boolean",
+            "description": "When set as `true`, it means the order got to its final shipping address, whether by delivery or pickup shipping type. When set as `false`, the order is still in transit to its shipping address.",
+            "example": false
+          },
+          "deliveredDate": {
+            "type": "string",
+            "nullable": true,
+            "description": "Date and time of when the package was delivered. Note that it is different from the tracking date parameter. The `deliveredDate` format is `yyyy-mm-dd hh:mm`.",
+            "example": "2022-10-01 21:15"
+          },
+          "events": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Event"
+            },
+            "description": "Array containing events information."
+          }
+        },
+        "example": {
+          "isDelivered": false,
+          "deliveredDate": null,
+          "events": [
+            {
+              "city": "Rio de Janeiro",
+              "state": "RJ",
+              "description": "Coletado pela transportadora",
+              "date": "2015-06-23"
+            },
+            {
+              "city": "Sao Paulo",
+              "state": "SP",
+              "description": "A caminho de Curitiba",
+              "date": "2015-06-24"
+            }
+          ]
+        }
+      },
+      "Event": {
+        "title": "Event",
+        "required": [
+          "city",
+          "state",
+          "description",
+          "date"
+        ],
+        "type": "object",
+        "properties": {
+          "city": {
+            "type": "string"
+          },
+          "state": {
+            "type": "string"
+          },
+          "description": {
+            "type": "string"
+          },
+          "date": {
+            "type": "string"
+          }
+        },
+        "example": {
+          "city": "Rio de Janeiro",
+          "state": "RJ",
+          "description": "Coletado pela transportadora",
+          "date": "2015-06-23"
+        }
+      },
+      "UpdateTrackingStatus": {
+        "title": "UpdateTrackingStatus",
+        "required": [
+          "date",
+          "orderId",
+          "receipt"
+        ],
+        "type": "object",
+        "properties": {
+          "date": {
+            "type": "string"
+          },
+          "orderId": {
+            "type": "string"
+          },
+          "receipt": {
+            "type": "string"
+          }
+        },
+        "example": {
+          "date": "2017-03-29T18:04:31.0521233+00:00",
+          "orderId": "v501245lspt-01",
+          "receipt": "f67d33a8029c42ce9a8f07fc17f54449"
+        }
+      },
+      "GetConversation": {
+        "title": "GetConversation",
+        "required": [
+          "id",
+          "from",
+          "to",
+          "subject",
+          "firstWords",
+          "body",
+          "hasAttachment",
+          "attachmentNames",
+          "date"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Conversation ID.",
+            "example": "2023-01-23t09-23-08_619a80a05aa34efb982b309c7a1910e3"
+          },
+          "from": {
+            "$ref": "#/components/schemas/From"
+          },
+          "to": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/To"
+            },
+            "description": "Conversation receiver."
+          },
+          "subject": {
+            "type": "string",
+            "description": "Conversation content subject.",
+            "example": "Your payment has been aproved."
+          },
+          "firstWords": {
+            "type": "string",
+            "description": "First words of Conversation content.",
+            "example": "Your payment has been aproved and we are waiting for..."
+          },
+          "body": {
+            "type": "string",
+            "description": "Conversation content body.",
+            "example": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional //EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\"> <html xmlns=\"http://www.w3.org/1999/xhtml\" xmlns:o=\"urn:schemas-microsoft-com:office:office\" xmlns:v=\"urn:schemas-microsoft-com:vml\" style=\"-webkit-text-size-adjust: 100%; -ms-text-size-adjust: 100%; -webkit-font-smoothing: antialiased; -moz-osx-font-smoothing: grayscale; box-sizing: border-box; width: 100%; height: 100%; margin: 0; padding: 0; background: #f1f1f1 !important;\"> <head> <meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"/> <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\"/> <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\"/> <title>recorrenciaqa</title> <!--[if gte mso 9]> <xml> <o:OfficeDocumentSettings> <o:AllowPNG/> <o:PixelsPerInch>96</o:PixelsPerInch> </o:OfficeDocumentSettings> </xml> <![endif]--> <style> a[x-apple-data-detectors] { color: inherit !important; text-decoration: none !important; font-size: inherit !important; font-family: inherit !important; font-weight: inherit !important; line-height: inherit !important; } </style> <style> @media (max-width: 600px) { img { max-width: 100% !important; height: auto !important; } } </style> <style> @media screen and (min-width: 30em) { .ph4-ns { padding-left: 2rem !important; padding-right: 2rem !important; } .mv4-ns { margin-top: 2rem !important; margin-bottom: 2rem !important; } } </style> </head> <body style=\"-webkit-text-size-adjust: 100%; -ms-text-size-adjust: 100%; -webkit-font-smoothing: antialiased; -moz-osx-font-smoothing: grayscale; box-sizing: border-box; width: 100%; height: 100%; margin: 0; padding: 0; background: #f1f1f1 !important; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;\"> <table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"box-sizing: border-box; margin: 0; padding: 0; background: #f1f1f1; border-collapse: collapse; border-spacing: 0; mso-table-lspace: 0pt; mso-table-rspace: 0pt; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif; width: 100%; height: 100%; line-height: 100% !important;\"> <tr style=\"box-sizing: border-box !important;\"> <td align=\"left\" valign=\"top\" style=\"font-size: 14px; line-height: 20px; box-sizing: border-box; border-collapse: collapse; text-align: left !important; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;\"> <table class=\"mv4-ns\" width=\"100%\" align=\"center\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"box-sizing: border-box; max-width: 40rem; width: 100%; background-color: #fff; border-collapse: collapse; border-spacing: 0; mso-table-lspace: 0pt; mso-table-rspace: 0pt !important; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;\" bgcolor=\"#fff\"> <tr style=\"box-sizing: border-box !important;\"> <td class=\"ph4-ns\" style=\"font-size: 14px; line-height: 20px; box-sizing: border-box; border-collapse: collapse; border-bottom-style: solid; border-bottom-width: 1px; border-color: #eee; width: 100%; padding-bottom: 2rem; text-align: center !important; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;\" align=\"center\"> <div style=\"box-sizing: border-box; width: 8rem; margin-bottom: 1rem; margin-top: 2rem; margin-right: auto; margin-left: auto !important;\"> <a href=\"http://.com.br\" style=\"box-sizing: border-box !important;\"> <img alt=\"\" border=\"0\" width=\"auto\" src=\"http://licensemanager.vtex.com.br/api/site/pub/accounts/9ddcfba5-3855-49ec-b61e-b2847b9314cc/logos/show\" style=\"vertical-align: top; outline: none; text-decoration: none; -ms-interpolation-mode: bicubic; max-width: 100%; border: none; max-height: 80px !important;\"> </img></a> </div> <h1 style=\"margin: 0; font-size: 50px; line-height: 58px; box-sizing: border-box !important;\">Seu pagamento foi aprovado.</h1> <div style=\"box-sizing: border-box; color: #777; margin-top: .5rem !important;\"> Referente ao Pedido <span style=\"font-weight: 700 !important;\">#1305371685465-01</span> </div> </td> </tr> <tr style=\"box-sizing: border-box !important;\"> <td class=\"ph4-ns\" style=\"font-size: 14px; line-height: 20px; box-sizing: border-box; border-collapse: collapse; text-align: left; width: 100% !important; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;\" align=\"left\"> <div style=\"box-sizing: border-box; margin-top: 2rem !important;\"> <p style=\"box-sizing: border-box !important;\">    Olá, jose.     Estamos providenciando a emissão da Nota Fiscal do seu pedido e o envio do seu produto.  </p> </div> </td> </tr> <tr style=\"box-sizing: border-box !important;\"> <td class=\"ph4-ns\" style=\"font-size: 14px; line-height: 20px; box-sizing: border-box; border-collapse: collapse; text-align: left; width: 100%; padding-bottom: 2rem; padding-top: 1rem !important; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;\" align=\"left\"> <h3 style=\"font-size: 20px; line-height: 36px; text-transform: uppercase; letter-spacing: 1.2pt; font-weight: 300; margin-top: 16px; box-sizing: border-box; margin: 0 !important;\">Pagamento</h3>    <div style=\"box-sizing: border-box; line-height: 1.5; font-size: 1.25rem !important;\"> Visa  final 1111  <br/>R$ 3,99  à vista  </div>     </td> </tr> <tr style=\"box-sizing: border-box !important;\"> <td class=\"ph4-ns\" style=\"font-size: 14px; line-height: 20px; box-sizing: border-box; border-collapse: collapse; text-align: left; border-top-style: solid; border-top-width: 1px; border-color: #eee; padding-top: 1rem; padding-bottom: 1rem !important; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;\" align=\"left\"> <p style=\"box-sizing: border-box !important;\"> Atenciosamente,<br/>Equipe recorrenciaqa </p> </td> </tr> </table> </td> </tr> </table> </body> </html>"
+          },
+          "hasAttachment": {
+            "type": "boolean",
+            "description": "When set as `true`, it means there are attachments, when set as `false`, there are not.",
+            "example": false
+          },
+          "attachmentNames": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "description": "Name of the attachment.",
+              "example": "attachments439505"
+            },
+            "description": "List with attachments' names, if there are any."
+          },
+          "date": {
+            "type": "string",
+            "description": "Conversation date.",
+            "example": "2023-01-23T09:23:31.0000000+00:00"
+          }
+        },
+        "example": {
+          "id": "2023-01-23t09-23-08_619a80a05aa34efb982b309c7a1910e3",
+          "from": {
+            "conversationRelatedTo": "1305371685465-01",
+            "conversationSubject": "oms",
+            "emailAlias": "noreply@vtexcommerce.com.br-9814872b.ct.store.com.br",
+            "aliasMaskType": 0,
+            "email": "noreply@store.com.br",
+            "name": "no reply",
+            "role": "null"
+          },
+          "to": [
+            {
+              "conversationRelatedTo": "1305371685465-01",
+              "conversationSubject": "oms",
+              "emailAlias": "64d8bd8dbe5c4e7b93b8b3c237e50be1@ct.name.com.br",
+              "aliasMaskType": 0,
+              "email": "customer.name@email.com",
+              "name": "Mary John",
+              "role": "Customer"
+            }
+          ],
+          "subject": "Your payment has been aproved.",
+          "firstWords": "Your payment has been aproved and we are waiting for...",
+          "body": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional //EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\"> <html xmlns=\"http://www.w3.org/1999/xhtml\" xmlns:o=\"urn:schemas-microsoft-com:office:office\" xmlns:v=\"urn:schemas-microsoft-com:vml\" style=\"-webkit-text-size-adjust: 100%; -ms-text-size-adjust: 100%; -webkit-font-smoothing: antialiased; -moz-osx-font-smoothing: grayscale; box-sizing: border-box; width: 100%; height: 100%; margin: 0; padding: 0; background: #f1f1f1 !important;\"> <head> <meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"/> <meta http-equiv=\"X-UA-Compatible\" content=\"IE=edge\"/> <meta name=\"viewport\" content=\"width=device-width, initial-scale=1.0\"/> <title>recorrenciaqa</title> <!--[if gte mso 9]> <xml> <o:OfficeDocumentSettings> <o:AllowPNG/> <o:PixelsPerInch>96</o:PixelsPerInch> </o:OfficeDocumentSettings> </xml> <![endif]--> <style> a[x-apple-data-detectors] { color: inherit !important; text-decoration: none !important; font-size: inherit !important; font-family: inherit !important; font-weight: inherit !important; line-height: inherit !important; } </style> <style> @media (max-width: 600px) { img { max-width: 100% !important; height: auto !important; } } </style> <style> @media screen and (min-width: 30em) { .ph4-ns { padding-left: 2rem !important; padding-right: 2rem !important; } .mv4-ns { margin-top: 2rem !important; margin-bottom: 2rem !important; } } </style> </head> <body style=\"-webkit-text-size-adjust: 100%; -ms-text-size-adjust: 100%; -webkit-font-smoothing: antialiased; -moz-osx-font-smoothing: grayscale; box-sizing: border-box; width: 100%; height: 100%; margin: 0; padding: 0; background: #f1f1f1 !important; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;\"> <table width=\"100%\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"box-sizing: border-box; margin: 0; padding: 0; background: #f1f1f1; border-collapse: collapse; border-spacing: 0; mso-table-lspace: 0pt; mso-table-rspace: 0pt; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif; width: 100%; height: 100%; line-height: 100% !important;\"> <tr style=\"box-sizing: border-box !important;\"> <td align=\"left\" valign=\"top\" style=\"font-size: 14px; line-height: 20px; box-sizing: border-box; border-collapse: collapse; text-align: left !important; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;\"> <table class=\"mv4-ns\" width=\"100%\" align=\"center\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" style=\"box-sizing: border-box; max-width: 40rem; width: 100%; background-color: #fff; border-collapse: collapse; border-spacing: 0; mso-table-lspace: 0pt; mso-table-rspace: 0pt !important; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;\" bgcolor=\"#fff\"> <tr style=\"box-sizing: border-box !important;\"> <td class=\"ph4-ns\" style=\"font-size: 14px; line-height: 20px; box-sizing: border-box; border-collapse: collapse; border-bottom-style: solid; border-bottom-width: 1px; border-color: #eee; width: 100%; padding-bottom: 2rem; text-align: center !important; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;\" align=\"center\"> <div style=\"box-sizing: border-box; width: 8rem; margin-bottom: 1rem; margin-top: 2rem; margin-right: auto; margin-left: auto !important;\"> <a href=\"http://.com.br\" style=\"box-sizing: border-box !important;\"> <img alt=\"\" border=\"0\" width=\"auto\" src=\"http://licensemanager.vtex.com.br/api/site/pub/accounts/9ddcfba5-3855-49ec-b61e-b2847b9314cc/logos/show\" style=\"vertical-align: top; outline: none; text-decoration: none; -ms-interpolation-mode: bicubic; max-width: 100%; border: none; max-height: 80px !important;\"> </img></a> </div> <h1 style=\"margin: 0; font-size: 50px; line-height: 58px; box-sizing: border-box !important;\">Seu pagamento foi aprovado.</h1> <div style=\"box-sizing: border-box; color: #777; margin-top: .5rem !important;\"> Referente ao Pedido <span style=\"font-weight: 700 !important;\">#1305371685465-01</span> </div> </td> </tr> <tr style=\"box-sizing: border-box !important;\"> <td class=\"ph4-ns\" style=\"font-size: 14px; line-height: 20px; box-sizing: border-box; border-collapse: collapse; text-align: left; width: 100% !important; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;\" align=\"left\"> <div style=\"box-sizing: border-box; margin-top: 2rem !important;\"> <p style=\"box-sizing: border-box !important;\">    Olá, jose.     Estamos providenciando a emissão da Nota Fiscal do seu pedido e o envio do seu produto.  </p> </div> </td> </tr> <tr style=\"box-sizing: border-box !important;\"> <td class=\"ph4-ns\" style=\"font-size: 14px; line-height: 20px; box-sizing: border-box; border-collapse: collapse; text-align: left; width: 100%; padding-bottom: 2rem; padding-top: 1rem !important; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;\" align=\"left\"> <h3 style=\"font-size: 20px; line-height: 36px; text-transform: uppercase; letter-spacing: 1.2pt; font-weight: 300; margin-top: 16px; box-sizing: border-box; margin: 0 !important;\">Pagamento</h3>    <div style=\"box-sizing: border-box; line-height: 1.5; font-size: 1.25rem !important;\"> Visa  final 1111  <br/>R$ 3,99  à vista  </div>     </td> </tr> <tr style=\"box-sizing: border-box !important;\"> <td class=\"ph4-ns\" style=\"font-size: 14px; line-height: 20px; box-sizing: border-box; border-collapse: collapse; text-align: left; border-top-style: solid; border-top-width: 1px; border-color: #eee; padding-top: 1rem; padding-bottom: 1rem !important; font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif;\" align=\"left\"> <p style=\"box-sizing: border-box !important;\"> Atenciosamente,<br/>Equipe recorrenciaqa </p> </td> </tr> </table> </td> </tr> </table> </body> </html>",
+          "hasAttachment": false,
+          "attachmentNames": [
+            "attachments439505"
+          ],
+          "date": "2023-01-23T09:23:31.0000000+00:00"
+        }
+      },
+      "From": {
+        "title": "From",
+        "description": "Conversation sender.",
+        "required": [
+          "conversationRelatedTo",
+          "conversationSubject",
+          "emailAlias",
+          "aliasMaskType",
+          "email",
+          "name",
+          "role"
+        ],
+        "type": "object",
+        "properties": {
+          "conversationRelatedTo": {
+            "type": "string",
+            "description": "Related order ID.",
+            "example": "1305371685465-01"
+          },
+          "conversationSubject": {
+            "type": "string",
+            "description": "Conversation subject.",
+            "example": "oms"
+          },
+          "emailAlias": {
+            "type": "string",
+            "description": "Sender transactional tracker email.",
+            "example": "64d8bd8dbe5c4e7b93b8b3c237e50be1@ct.name.com.br"
+          },
+          "aliasMaskType": {
+            "type": "integer",
+            "description": "Conversation tracker mask type.",
+            "example": 0
+          },
+          "email": {
+            "type": "string",
+            "description": "Sender's email.",
+            "example": "noreply@store.com.br"
+          },
+          "name": {
+            "type": "string",
+            "description": "Sender's name.",
+            "example": "no reply"
+          },
+          "role": {
+            "type": "string",
+            "nullable": true,
+            "description": "If it is a client or null, for transactional emails.",
+            "example": "null"
+          }
+        },
+        "example": {
+          "conversationRelatedTo": "1305371685465-01",
+          "conversationSubject": "oms",
+          "emailAlias": "noreply@vtexcommerce.com.br-9814872b.ct.store.com.br",
+          "aliasMaskType": 0,
+          "email": "noreply@store.com.br",
+          "name": "no reply",
+          "role": "null"
+        }
+      },
+      "To": {
+        "title": "To",
+        "description": "Conversation receiver.",
+        "required": [
+          "conversationRelatedTo",
+          "conversationSubject",
+          "emailAlias",
+          "aliasMaskType",
+          "email",
+          "name",
+          "role"
+        ],
+        "type": "object",
+        "properties": {
+          "conversationRelatedTo": {
+            "type": "string",
+            "description": "Related order ID.",
+            "example": "1305371685465-01"
+          },
+          "conversationSubject": {
+            "type": "string",
+            "description": "Conversation subject.",
+            "example": "oms"
+          },
+          "emailAlias": {
+            "type": "string",
+            "description": "Sender transactional tracker email.",
+            "example": "64d8bd8dbe5c4e7b93b8b3c237e50be1@ct.name.com.br"
+          },
+          "aliasMaskType": {
+            "type": "integer",
+            "description": "Conversation tracker mask type.",
+            "example": 0
+          },
+          "email": {
+            "type": "string",
+            "description": "Receiver's email.",
+            "example": "customer.name@email.com"
+          },
+          "name": {
+            "type": "string",
+            "description": "Receiver's name.",
+            "example": "Mary John"
+          },
+          "role": {
+            "type": "string",
+            "description": "If it is a customer or null, for transactional emails.",
+            "example": "Customer"
+          }
+        },
+        "example": {
+          "conversationRelatedTo": "1305371685465-01",
+          "conversationSubject": "oms",
+          "emailAlias": "64d8bd8dbe5c4e7b93b8b3c237e50be1@ct.name.com.br",
+          "aliasMaskType": 0,
+          "email": "customer.name@email.com",
+          "name": "Mary John",
+          "role": "Customer"
+        }
+      },
+      "GetPaymenttransaction": {
+        "required": [
+          "status",
+          "isActive",
+          "transactionId",
+          "merchantName",
+          "payments"
+        ],
+        "type": "object",
+        "properties": {
+          "status": {
+            "type": "string",
+            "description": "Transaction status."
+          },
+          "isActive": {
+            "type": "boolean",
+            "description": "If it is an active transaction (`true`) or not (`false`)."
+          },
+          "transactionId": {
+            "type": "string",
+            "description": "Transaction ID."
+          },
+          "merchantName": {
+            "type": "string",
+            "description": "Transaction merchant's name."
+          },
+          "payments": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Payment1"
+            },
+            "description": "Payments' details object."
+          }
+        }
+      },
+      "Payment1": {
+        "title": "Payment1",
+        "required": [
+          "id",
+          "paymentSystem",
+          "paymentSystemName",
+          "value",
+          "installments",
+          "referenceValue",
+          "cardHolder",
+          "cardNumber",
+          "firstDigits",
+          "lastDigits",
+          "cvv2",
+          "expireMonth",
+          "expireYear",
+          "url",
+          "giftCardId",
+          "giftCardName",
+          "giftCardCaption",
+          "redemptionCode",
+          "group",
+          "tid",
+          "dueDate",
+          "connectorResponses"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Payment ID."
+          },
+          "paymentSystem": {
+            "type": "string",
+            "description": "Payment system ID."
+          },
+          "paymentSystemName": {
+            "type": "string",
+            "description": "Payment system name."
+          },
+          "value": {
+            "type": "integer",
+            "description": "Payment value."
+          },
+          "installments": {
+            "type": "integer",
+            "description": "Payment Installments quantity."
+          },
+          "referenceValue": {
+            "type": "integer",
+            "description": "Payment reference Value."
+          },
+          "cardHolder": {
+            "type": "string",
+            "nullable": true,
+            "description": "Payment card holder."
+          },
+          "cardNumber": {
+            "type": "string",
+            "nullable": true,
+            "description": "Payment card number."
+          },
+          "firstDigits": {
+            "type": "string",
+            "description": "Payment card first digits."
+          },
+          "lastDigits": {
+            "type": "string",
+            "description": "Payment card last digits."
+          },
+          "cvv2": {
+            "type": "string",
+            "nullable": true,
+            "description": "Card Verification Value (CVV2) is a security code used by payment processors to reduce fraudulent credit and debit card transactions."
+          },
+          "expireMonth": {
+            "type": "string",
+            "nullable": true,
+            "description": "Payment card expire month."
+          },
+          "expireYear": {
+            "type": "string",
+            "nullable": true,
+            "description": "Payment card expire year."
+          },
+          "url": {
+            "type": "string",
+            "nullable": true,
+            "description": "Payment URL."
+          },
+          "giftCardId": {
+            "type": "string",
+            "nullable": true,
+            "description": "Gift Card ID."
+          },
+          "giftCardName": {
+            "type": "string",
+            "nullable": true,
+            "description": "Gift Card name."
+          },
+          "giftCardCaption": {
+            "type": "string",
+            "nullable": true,
+            "description": "Gift Card caption."
+          },
+          "redemptionCode": {
+            "type": "string",
+            "nullable": true,
+            "description": "Code for the customer to use the Gift Card."
+          },
+          "group": {
+            "type": "string",
+            "description": "It represents the payment method. For each method, it can have the following values: \n\r\n- **Credit card:** `creditCard` \r\n\r\n- **Debid card:** `debitCard`\r\n\r\n- **Bank invoice:** `bankInvoice`\r\n\r\n- **Promissory:** `promissory` \r\n\r\n- **Gift card:** `giftCard` \n\r\n- **Pix:** `instantPayment`."
+          },
+          "tid": {
+            "type": "string",
+            "description": "Payment transaction ID."
+          },
+          "dueDate": {
+            "type": "string",
+            "nullable": true,
+            "description": "Payment due date."
+          },
+          "connectorResponses": {
+            "$ref": "#/components/schemas/ConnectorResponses"
+          }
+        },
+        "example": {
+          "id": "721CBE1090324D12ABE301FE33DE775A",
+          "paymentSystem": "4",
+          "paymentSystemName": "Mastercard",
+          "value": 10150,
+          "installments": 1,
+          "referenceValue": 10150,
+          "cardHolder": null,
+          "cardNumber": null,
+          "firstDigits": "412341",
+          "lastDigits": "4123",
+          "cvv2": null,
+          "expireMonth": null,
+          "expireYear": null,
+          "url": null,
+          "giftCardId": null,
+          "giftCardName": null,
+          "giftCardCaption": null,
+          "redemptionCode": null,
+          "group": "creditCard",
+          "tid": "101770752",
+          "dueDate": null,
+          "connectorResponses": {
+            "Tid": "101770752",
+            "ReturnCode": "200",
+            "Message": "logMessage",
+            "authId": "170852"
+          }
+        }
+      },
+      "ConnectorResponses": {
+        "title": "ConnectorResponses",
+        "required": [
+          "Tid",
+          "ReturnCode",
+          "Message",
+          "authId"
+        ],
+        "type": "object",
+        "properties": {
+          "Tid": {
+            "type": "string",
+            "description": "Connector transaction ID."
+          },
+          "ReturnCode": {
+            "type": "string",
+            "nullable": true,
+            "description": "Connector return code."
+          },
+          "Message": {
+            "type": "string",
+            "nullable": true,
+            "description": "Information about the connector's responses."
+          },
+          "authId": {
+            "type": "string",
+            "description": "Connector authorization ID."
+          }
+        },
+        "example": {
+          "Tid": "101770752",
+          "ReturnCode": null,
+          "Message": null,
+          "authId": "170852"
+        }
+      },
+      "ConfirmitemfeedorderstatusRequest": {
+        "title": "ConfirmitemfeedorderstatusRequest",
+        "required": [
+          "commitToken"
+        ],
+        "type": "object",
+        "properties": {
+          "commitToken": {
+            "type": "string"
+          }
+        },
+        "example": {
+          "commitToken": "Marketplace##{\"Receipt\":\"+eXJYhj5rDqHa28+XUcfebDO4pve3TvMpPlW0ivc5STyE/40J6wxooXgBF8LZ9CdhZkFJnMYBVDwPwQtNEoZQrVtErDB2Yq2zs16QqsJuYxSrQtBfl9rMfmkO5orB9oDHSpvwL6DjDzcuJeQBBNxono/m4F6BloJEsk9BmuTmPaRI+7xsrN5Oeg8NPUoNSnsT983JPr1B+Y+TbbFjC1R8ZkvFHGVfti1QbhOwmYWTHPG08YMqla+Qwh7kUONLBXPqporF/CcqJo5YVTSu2uBcCuXkUo+OH9uUTn6hHkUROo=\",\"PublisheId\":\"C0111A50CEB244E59C95422870127A4F\",\"PublisheId_Item\":\"C0111A50CEB244E59C95422870127A4F\",\"EventId\":\"0dc05b6b-48a5-4f03-975a-a69fb6550aaa\",\"LastSendOverwrite\":null}"
+        }
+      },
+      "Getfeedorderstatus": {
+        "title": "Getfeedorderstatus",
+        "required": [
+          "eventId",
+          "handle",
+          "domain",
+          "state",
+          "lastState",
+          "orderId",
+          "lastChange",
+          "currentChange"
+        ],
+        "type": "object",
+        "properties": {
+          "eventId": {
+            "type": "string"
+          },
+          "handle": {
+            "type": "string"
+          },
+          "domain": {
+            "type": "string"
+          },
+          "state": {
+            "type": "string"
+          },
+          "lastState": {
+            "type": "string"
+          },
+          "orderId": {
+            "type": "string"
+          },
+          "lastChange": {
+            "type": "string"
+          },
+          "currentChange": {
+            "type": "string"
+          }
+        }
+      },
+      "HookFilter": {
+        "title": "Filter",
+        "required": [
+          "type"
+        ],
+        "type": "object",
+        "properties": {
+          "type": {
+            "type": "string",
+            "description": "Determines what orders appear in the hook and how they are filtered. As shown in the examples above, there are two ways:\r\n\r\n - `FromWorkflow`: the hook will receive order updates only when there is a change or update in the [order status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196). You must send at least one value for the `status` field to determine by which status the orders will be filtered.\r\n\r\n - `FromOrders`: the hook will receive order updates when there is a change in the order. In this case, orders can be filtered by any property, according to JSONata expressions passed in the `expression` field. You must send the request with values for the `expression` and `disableSingleFire` fields.",
+            "example": "FromWorkflow"
+          },
+          "status": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "List of order statuses that should be included in the hook. This should only be used in case `type` is `FromWorkflow`."
+          },
+          "expression": {
+            "type": "string",
+            "description": "JSONata query expression that defines what conditions must be met for an order to be included in the hook. This should only be used in case `type` is `FromOrders`."
+          },
+          "disableSingleFire": {
+            "type": "boolean",
+            "description": "Sets a limit to how many times a specific order shows on the hook, after it first meets filtering conditions. Using the `FromOrders` type configuration with JSONata filtering expressions might cause orders to appear more than once on a feed, whenever changes are made to that order. If this field is `false` orders will appear in the hook only once. Send this field if you want to filter `FromOrders`.",
+            "example": false
+          }
+        }
+      },
+      "HookConfigurationRequest": {
+        "title": "HookConfigurationRequest",
+        "required": [
+          "filter",
+          "hook"
+        ],
+        "type": "object",
+        "properties": {
+          "filter": {
+            "$ref": "#/components/schemas/HookFilter"
+          },
+          "hook": {
+            "$ref": "#/components/schemas/Hook"
+          }
+        },
+        "example": {
+          "filter": {
+            "type": "FromWorkflow",
+            "status": [
+              "order-completed",
+              "handling",
+              "ready-for-handling",
+              "waiting-ffmt-authorization",
+              "cancel"
+            ]
+          },
+          "hook": {
+            "url": "https://endpoint.example/path",
+            "headers": {
+              "key": "value"
+            }
+          }
+        }
+      },
+      "Hook": {
+        "title": "Hook",
+        "required": [
+          "url",
+          "headers"
+        ],
+        "type": "object",
+        "properties": {
+          "url": {
+            "type": "string"
+          },
+          "headers": {
+            "$ref": "#/components/schemas/Headers"
+          }
+        },
+        "example": {
+          "url": "https://endpoint.example/path",
+          "headers": {
+            "key": "value"
+          }
+        }
+      },
+      "Headers": {
+        "title": "Headers",
+        "required": [
+          "key"
+        ],
+        "type": "object",
+        "properties": {
+          "key": {
+            "type": "string"
+          }
+        },
+        "example": {
+          "key": "value"
+        }
+      },
+      "HookConfiguration": {
+        "title": "HookConfiguration",
+        "required": [
+          "Domain",
+          "OrderId",
+          "State",
+          "LastState",
+          "LastChange",
+          "CurrentChange",
+          "Origin"
+        ],
+        "type": "object",
+        "properties": {
+          "Domain": {
+            "type": "string"
+          },
+          "OrderId": {
+            "type": "string"
+          },
+          "State": {
+            "type": "string"
+          },
+          "LastState": {
+            "type": "string"
+          },
+          "LastChange": {
+            "type": "string"
+          },
+          "CurrentChange": {
+            "type": "string"
+          },
+          "Origin": {
+            "$ref": "#/components/schemas/Origin2"
+          }
+        }
+      },
+      "Origin2": {
+        "title": "Origin2",
+        "required": [
+          "Account",
+          "Key"
+        ],
+        "type": "object",
+        "properties": {
+          "Account": {
+            "type": "string"
+          },
+          "Key": {
+            "type": "string"
+          }
+        },
+        "example": {
+          "Account": "automacaoqa",
+          "Key": "vtexappkey-appvtex"
+        }
+      },
+      "Createchange": {
+        "required": [
+          "reason"
+        ],
+        "type": "object",
+        "properties": {
+          "reason": {
+            "type": "string",
+            "description": "Reason why you wish to change order. Since you can make several changes to an order, filling this field with a clear explanation helps organize the change order history. The shopper can view this field value in [transactional emails](https://help.vtex.com/en/tutorial/order-transactional-email-templates--3g2S2kqBOoSGcCaqMYK2my) and [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh).",
+            "example": "The client wants to change a weighable product."
+          },
+          "replace": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Replace"
+            },
+            "description": "Array containing `replace` change information. Besides `replace`, you can `add` or `remove` items from an order.\r\n\r\n- `add`: the schema will correspond to the object `to` inside the `replace` array.\r\n\r\n- `remove`: the schema will correspond to the object `from` inside the `replace` array.\r\n\r\nYou will find request body examples of both cases in the endpoint description on the top of the page. The successful response `202 - Accepted` schema is the same for all three operations, whether they are used separately or combined in the same request."
+          }
+        }
+      },
+      "Replace": {
+        "required": [
+          "from",
+          "to"
+        ],
+        "type": "object",
+        "description": "Replacing operation object.",
+        "properties": {
+          "from": {
+            "required": [
+              "items"
+            ],
+            "type": "object",
+            "properties": {
+              "items": {
+                "type": "array",
+                "items": {
+                  "required": [
+                    "id",
+                    "quantity"
+                  ],
+                  "type": "object",
+                  "description": "Information about item being changed.",
+                  "properties": {
+                    "id": {
+                      "type": "string",
+                      "description": "SKU ID of the item that will be changed.",
+                      "example": "1"
+                    },
+                    "quantity": {
+                      "type": "integer",
+                      "description": "Quantity of the item being changed.",
+                      "example": 1
+                    }
+                  }
+                },
+                "description": "Array with information about the item to be replaced."
+              }
+            },
+            "description": "Object with information about the items been replaced. If instead of an order `replace` you wish to `remove` items, you will use the same schema naming the object `remove` instead of `from`. For a complete example, see the description at the top of the page."
+          },
+          "to": {
+            "required": [
+              "items"
+            ],
+            "type": "object",
+            "properties": {
+              "items": {
+                "type": "array",
+                "items": {
+                  "required": [
+                    "id",
+                    "quantity",
+                    "measurementUnit",
+                    "unitMultiplier"
+                  ],
+                  "type": "object",
+                  "description": "Replacing item details.",
+                  "properties": {
+                    "id": {
+                      "type": "string",
+                      "description": "SKU ID of the item that will replace the previous one. If you only wish to replace the product weight, you will repeat the SKU ID used in `from`.",
+                      "example": "1"
+                    },
+                    "quantity": {
+                      "type": "integer",
+                      "description": "Updated quantity of the item been changed.",
+                      "example": 1
+                    },
+                    "measurementUnit": {
+                      "type": "string",
+                      "description": "Measurement unit of the new item. The values accepted are the measurement units registered in the store's catalog. For example, `kg` for kilograms or `un` for unitary items. When you don't specify a value, the request gets the information from the Catalog.",
+                      "example": "kg"
+                    },
+                    "unitMultiplier": {
+                      "type": "number",
+                      "description": "Unit multiplier for item update. For example, if you wish to increase an order with three times more items than a single one, you would fill in with `3.0`.",
+                      "example": 3.0
+                    }
+                  }
+                },
+                "description": "Array with information about the replacing items."
+              },
+              "shippingData": {
+                "required": [
+                  "logisticsInfo"
+                ],
+                "type": "object",
+                "description": "Shipping data object.",
+                "properties": {
+                  "logisticsInfo": {
+                    "type": "array",
+                    "items": {
+                      "required": [
+                        "itemIndex",
+                        "slaId",
+                        "deliveryChannel",
+                        "addressId",
+                        "price"
+                      ],
+                      "type": "object",
+                      "description": "Shipping details of the changed order.",
+                      "properties": {
+                        "itemIndex": {
+                          "type": "integer",
+                          "description": "Index that identifies the position of this item in the original array, starting from `0`.",
+                          "example": 0
+                        },
+                        "slaId": {
+                          "type": "string",
+                          "description": "Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the order.",
+                          "example": "Normal"
+                        },
+                        "deliveryChannel": {
+                          "type": "string",
+                          "description": "Order shipping type, which can be `pickup-in-point` for [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R), and `delivery` for delivery.",
+                          "enum": [
+                            "delivery",
+                            "pickup-in-point"
+                          ],
+                          "example": "delivery"
+                        },
+                        "addressId": {
+                          "type": "string",
+                          "description": "Shipping address ID.",
+                          "example": "9ec276fd3a604eb1aa151b5333ca5db7"
+                        },
+                        "price": {
+                          "type": "integer",
+                          "description": "Shipping price for the item in cents. Does not account for the whole order's shipping price.",
+                          "example": 1000
+                        }
+                      }
+                    },
+                    "description": "Array containing information about the shipping address of the changed order. This field is optional, when you don't send it the request body, the system assumes there were no changes in shipping."
+                  }
+                }
+              }
+            },
+            "description": "Object with information about the new replacing items. If instead of an order `replace` you wish to `add` items, you will use the same schema naming the object `add` instead of `to`. For a complete example, see the description at the top of the page."
+          }
+        }
+      },
+      "response202": {
+        "required": [
+          "requestId",
+          "workflowId",
+          "reason",
+          "manualDiscountValue",
+          "manualIncrementValue",
+          "totalChangeValue",
+          "totals",
+          "add",
+          "remove",
+          "replace",
+          "date",
+          "origin",
+          "settings"
+        ],
+        "type": "object",
+        "properties": {
+          "requestId": {
+            "type": "string",
+            "description": "Unique code that identifies a change order request."
+          },
+          "workflowId": {
+            "type": "string",
+            "description": "Code that identifies the transaction of changing the orders in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196)."
+          },
+          "reason": {
+            "type": "string",
+            "description": "Reason that motivated the order change."
+          },
+          "manualDiscountValue": {
+            "type": "integer",
+            "description": "This field shows if a manual price was applied to the total order amount. The value is in cents."
+          },
+          "manualIncrementValue": {
+            "type": "integer",
+            "description": "This field shows if an increment value was applied to the total order amount. The value is in cents."
+          },
+          "totalChangeValue": {
+            "type": "integer",
+            "description": "This field shows how much the order total price is considering that price changes might have been made. The value is in cents."
+          },
+          "totals": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "description": "Item changing price details."
+            },
+            "description": "Array containing information about change prices per item."
+          },
+          "add": {
+            "type": "array",
+            "description": "Array with information about the `add` operation, when applicable. The schema will correspond to the object `to` inside the `replace` array.",
+            "nullable": true,
+            "items": {
+              "type": "string",
+              "description": "Adding details."
+            }
+          },
+          "remove": {
+            "type": "array",
+            "description": "Array with information about the `remove` operation, when applicable. The schema will correspond to the object `from` inside the `replace` array.",
+            "nullable": true,
+            "items": {
+              "type": "string",
+              "description": "Removal details."
+            }
+          },
+          "replace": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Replace1"
+            },
+            "description": "Array with information about the `replace` operation, when applicable.",
+            "nullable": true
+          },
+          "date": {
+            "type": "string",
+            "description": "Date and time of the request. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`."
+          },
+          "origin": {
+            "$ref": "#/components/schemas/OriginV2"
+          },
+          "settings": {
+            "$ref": "#/components/schemas/Settings"
+          }
+        }
+      },
+      "Replace1": {
+        "required": [
+          "from",
+          "to"
+        ],
+        "type": "object",
+        "description": "Details about what will be replaced.",
+        "properties": {
+          "from": {
+            "required": [
+              "paymentData",
+              "items",
+              "shippingData"
+            ],
+            "type": "object",
+            "properties": {
+              "paymentData": {
+                "$ref": "#/components/schemas/PaymentDataV2"
+              },
+              "items": {
+                "type": "array",
+                "description": "Array with items information.",
+                "items": {
+                  "required": [
+                    "id",
+                    "quantity",
+                    "price",
+                    "measurementUnit",
+                    "unitMultiplier",
+                    "sellingPrice",
+                    "name",
+                    "detailUrl",
+                    "imageUrl"
+                  ],
+                  "type": "object",
+                  "description": "Details about a given item.",
+                  "properties": {
+                    "id": {
+                      "type": "string",
+                      "description": "SKU ID of the item been replaced."
+                    },
+                    "quantity": {
+                      "type": "integer",
+                      "description": "Quantity of items been replaced."
+                    },
+                    "price": {
+                      "type": "integer",
+                      "nullable": true,
+                      "description": "Shipping price for the replaced item, in cents. It does not account for the whole order's shipping price."
+                    },
+                    "measurementUnit": {
+                      "type": "string",
+                      "nullable": true,
+                      "description": "Measurement unit of the item been replaced. For example, `kg` for kilograms or `un` for unitary items."
+                    },
+                    "unitMultiplier": {
+                      "type": "integer",
+                      "description": "Unit multiplier for item been update."
+                    },
+                    "sellingPrice": {
+                      "type": "string",
+                      "description": "Selling price of the item been replaced.",
+                      "nullable": true
+                    },
+                    "name": {
+                      "type": "string",
+                      "nullable": true,
+                      "description": "Name of the item been replaced."
+                    },
+                    "detailUrl": {
+                      "type": "string",
+                      "nullable": true,
+                      "description": "URL slug of the item been replaced."
+                    },
+                    "imageUrl": {
+                      "type": "string",
+                      "nullable": true,
+                      "description": "Image URL slug of the item been replaced."
+                    }
+                  }
+                }
+              },
+              "shippingData": {
+                "$ref": "#/components/schemas/ShippingData1"
+              }
+            },
+            "description": "Information about what items were replaced."
+          },
+          "to": {
+            "required": [
+              "items",
+              "paymentData",
+              "receiptData",
+              "shippingData"
+            ],
+            "type": "object",
+            "description": "Information about items that replaced the previous one.",
+            "properties": {
+              "items": {
+                "type": "array",
+                "items": {
+                  "$ref": "#/components/schemas/Item3"
+                },
+                "description": "Array containing information about the item replacing the previous one."
+              },
+              "paymentData": {
+                "$ref": "#/components/schemas/PaymentDataV2"
+              },
+              "receiptData": {
+                "type": "object",
+                "nullable": true,
+                "description": "Information about the receipt after order change."
+              },
+              "shippingData": {
+                "type": "object",
+                "description": "Shipping data object.",
+                "required": [
+                  "logisticsInfo"
+                ],
+                "properties": {
+                  "logisticsInfo": {
+                    "type": "array",
+                    "items": {
+                      "$ref": "#/components/schemas/LogisticsInfo1"
+                    },
+                    "description": "Array with shipping information."
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
+      "PaymentDataV2": {
+        "type": "object",
+        "description": "Payment data object.",
+        "required": [
+          "transactions"
+        ],
+        "properties": {
+          "transactions": {
+            "type": "array",
+            "description": "Information about financial transactions.",
+            "items": {
+              "type": "string",
+              "description": "Array containing financial information. This is an optional field.",
+              "example": "creditcard"
+            }
+          }
+        }
+      },
+      "ShippingData1": {
+        "description": "Shipping data object.",
+        "required": [
+          "logisticsInfo"
+        ],
+        "type": "object",
+        "properties": {
+          "logisticsInfo": {
+            "type": "array",
+            "description": "Array with logistics information about the order been replaced. If not sent in the original request, it will be an empty array in the response.",
+            "items": {
+              "type": "string",
+              "description": "Logistics details."
+            }
+          }
+        }
+      },
+      "Item3": {
+        "type": "object",
+        "description": "Object with item details.",
+        "required": [
+          "uniqueId",
+          "id",
+          "productId",
+          "productRefId",
+          "refId",
+          "ean",
+          "name",
+          "skuName",
+          "modalType",
+          "parentItemIndex",
+          "parentAssemblyBinding",
+          "assemblies",
+          "priceValidUntil",
+          "tax",
+          "price",
+          "listPrice",
+          "manualPrice",
+          "manualPriceAppliedBy",
+          "sellingPrice",
+          "rewardValue",
+          "isGift",
+          "additionalInfo",
+          "preSaleDate",
+          "productCategoryIds",
+          "productCategories",
+          "quantity",
+          "seller",
+          "sellerChain",
+          "imageUrl",
+          "detailUrl",
+          "components",
+          "bundleItems",
+          "attachments",
+          "attachmentOfferings",
+          "offerings",
+          "priceTags",
+          "availability",
+          "measurementUnit",
+          "unitMultiplier",
+          "manufacturerCode",
+          "priceDefinition"
+        ],
+        "properties": {
+          "uniqueId": {
+            "type": "string",
+            "description": "Item's unique ID in the change order request.",
+            "example": "40E763F4378E4F40AD1FE915FE1078E1"
+          },
+          "id": {
+            "type": "string",
+            "description": "SKU ID of the item replacing the previous one.",
+            "example": "3"
+          },
+          "productId": {
+            "type": "string",
+            "nullable": true,
+            "description": "Product ID of the item replacing the previous one.",
+            "example": "7"
+          },
+          "productRefId": {
+            "type": "string",
+            "nullable": true,
+            "description": "Product Ref ID of the item replacing the previous one.",
+            "example": "smallcup"
+          },
+          "refId": {
+            "type": "string",
+            "nullable": true,
+            "description": "Reference ID of the item replacing the previous one.",
+            "example": "356"
+          },
+          "ean": {
+            "type": "string",
+            "nullable": true,
+            "description": "European Article Number (EAN) of the item replacing the previous one.",
+            "example": "8745121641680"
+          },
+          "name": {
+            "type": "string",
+            "nullable": true,
+            "description": "Name of the Product associated with the item replacing the previous one.",
+            "example": "Small cup of coffee with pink logo"
+          },
+          "skuName": {
+            "type": "string",
+            "nullable": true,
+            "description": "Name of the SKU replacing the previous one.",
+            "example": "Small blue cup"
+          },
+          "modalType": {
+            "type": "string",
+            "nullable": true,
+            "description": "A [modal](https://help.vtex.com/en/tutorial/how-does-the-modal-work--tutorials_125) attaches an unusual product, such as meat or glass, to a carrier specialized in shipping it.",
+            "example": "GLASS"
+          },
+          "parentItemIndex": {
+            "type": "integer",
+            "nullable": true,
+            "description": "Parent item index of the item replacing the previous one.",
+            "example": 0
+          },
+          "parentAssemblyBinding": {
+            "type": "string",
+            "nullable": true,
+            "description": "Parent assembly binding of the item replacing the previous one.",
+            "example": null
+          },
+          "assemblies": {
+            "type": "array",
+            "description": "Array with information about services that may be offered for the item replacing the previous one. For example, the assembly of a piece of furniture or warranty.",
+            "nullable": true,
+            "items": {
+              "type": "string",
+              "description": "Customization information."
+            }
+          },
+          "priceValidUntil": {
+            "type": "string",
+            "nullable": true,
+            "description": "Price expiration date of item replacing the previous one. The value is in the format `yyyy-mm-ddThh:mm:ss.sss`.",
+            "example": "2023-03-01T22:58:28.143"
+          },
+          "tax": {
+            "type": "integer",
+            "description": "Tax in cents of the item replacing the previous one, when applicable.",
+            "example": 0
+          },
+          "price": {
+            "type": "integer",
+            "nullable": true,
+            "description": "Final price of the item replacing the previous one, calculated in cents.",
+            "example": 600
+          },
+          "listPrice": {
+            "type": "integer",
+            "nullable": true,
+            "description": "Item's price list for the item replacing the previous one.",
+            "example": 600
+          },
+          "manualPrice": {
+            "type": "integer",
+            "nullable": true,
+            "description": "Manual price of the item replacing the previous one. It is calculated in cents.",
+            "example": 6500
+          },
+          "manualPriceAppliedBy": {
+            "type": "string",
+            "nullable": true,
+            "description": "User ID or appKey that made the manual price change of the item replacing the previous one.",
+            "example": "4cc81d44-e42e-464b-8199-1e883bf4ab6b"
+          },
+          "sellingPrice": {
+            "type": "integer",
+            "nullable": true,
+            "description": "Selling price of the item replacing the previous one. It is calculated in cents.",
+            "example": 600
+          },
+          "rewardValue": {
+            "type": "integer",
+            "description": "Reward value of the item replacing the previous one. It is calculated in cents.",
+            "example": 50
+          },
+          "isGift": {
+            "type": "boolean",
+            "description": "This field is `true` when the replacing item is a gift in the order context and `false` when it is not.",
+            "example": false
+          },
+          "additionalInfo": {
+            "$ref": "#/components/schemas/AdditionalInfoV2"
+          },
+          "preSaleDate": {
+            "type": "string",
+            "nullable": true,
+            "description": "Pre sale date of the item replacing the previous one.",
+            "example": "2023-01-01T00:00:00.0000000+00:00"
+          },
+          "productCategoryIds": {
+            "type": "string",
+            "nullable": true,
+            "description": "Replacing item's category path composed of category IDs separated by `/`. For example: `/3/15/`.",
+            "example": "/2/"
+          },
+          "productCategories": {
+            "type": "object",
+            "description": "Object containing product categories of the replacing item. Structure: `{CategoryID}: {CategoryName}`. Both the key and the value are strings.",
+            "example": {
+              "2": "Clothes"
+            }
+          },
+          "quantity": {
+            "type": "integer",
+            "description": "Quantity of replacing items.",
+            "example": 1
+          },
+          "seller": {
+            "type": "string",
+            "nullable": true,
+            "description": "Seller ID that identifies the seller the replacing item belongs to.",
+            "example": "1"
+          },
+          "sellerChain": {
+            "type": "array",
+            "description": "Array containing information about sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory) order.",
+            "nullable": true,
+            "items": {
+              "type": "string",
+              "description": "Seller identification.",
+              "nullable": true
+            }
+          },
+          "imageUrl": {
+            "type": "string",
+            "nullable": true,
+            "description": "Image URL slug of the replacing item.",
+            "example": "http://store.com.br/ids/155419-55-55//cupcoffee.png?v=6368858582363"
+          },
+          "detailUrl": {
+            "type": "string",
+            "nullable": true,
+            "description": "URL slug of the replacing item.",
+            "example": "/cup-coffee/p"
+          },
+          "components": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "description": "Replacing item's component."
+            },
+            "description": "Array with information about replacing item's components."
+          },
+          "bundleItems": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "description": "Service sold with the replacing item."
+            },
+            "description": "Array with information about services sold along with the replacing item, such as a gift package."
+          },
+          "attachments": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "description": "Information about a given attachment."
+            },
+            "description": "Array containing information on attachments."
+          },
+          "attachmentOfferings": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "description": "Information about a given offering."
+            },
+            "description": "Array with the properties of the content declared in the field `attachments`."
+          },
+          "offerings": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "description": "Item's offering."
+            },
+            "description": "Array with replacing items Item's offerings."
+          },
+          "priceTags": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "description": "Item modifier."
+            },
+            "description": "Array containing objects with replacing item's price modifiers."
+          },
+          "availability": {
+            "type": "string",
+            "nullable": true,
+            "description": "Availability to fulfill the order with the item.",
+            "example": "available"
+          },
+          "measurementUnit": {
+            "type": "string",
+            "description": "Replacing item's measurement unit.",
+            "example": "un"
+          },
+          "unitMultiplier": {
+            "type": "integer",
+            "description": "Replacing item's unit multiplier.",
+            "example": 1
+          },
+          "manufacturerCode": {
+            "type": "string",
+            "nullable": true,
+            "description": "Provided by the manufacturers to identify their product. This field must be completed if the replacing item has a manufacturer's code.",
+            "example": "manf-00005"
+          },
+          "priceDefinition": {
+            "type": "string",
+            "nullable": true,
+            "description": "replacing item's price information.",
+            "example": null
+          }
+        }
+      },
+      "AdditionalInfoV2": {
+        "type": "object",
+        "description": "Additional information object.",
+        "required": [
+          "dimension",
+          "brandName",
+          "brandId",
+          "offeringInfo",
+          "offeringType",
+          "offeringTypeId",
+          "categoriesIds",
+          "productClusterId",
+          "commercialConditionId"
+        ],
+        "properties": {
+          "dimension": {
+            "type": "string",
+            "nullable": true,
+            "description": "Replacing tem's dimensions in the measure unit configured in the catalog.",
+            "example": null
+          },
+          "brandName": {
+            "type": "string",
+            "nullable": true,
+            "description": "Replacing item's brand name.",
+            "example": "Special coffee cup"
+          },
+          "brandId": {
+            "type": "string",
+            "nullable": true,
+            "description": "Replacing item's brand ID.",
+            "example": "2000001"
+          },
+          "offeringInfo": {
+            "type": "string",
+            "nullable": true,
+            "description": "Offering information.",
+            "example": null
+          },
+          "offeringType": {
+            "type": "string",
+            "nullable": true,
+            "description": "Offering type.",
+            "example": null
+          },
+          "offeringTypeId": {
+            "type": "string",
+            "nullable": true,
+            "description": "Offering type ID.",
+            "example": null
+          },
+          "categoriesIds": {
+            "type": "string",
+            "nullable": true,
+            "description": "ID of the replacing item product category.",
+            "example": null
+          },
+          "productClusterId": {
+            "type": "string",
+            "nullable": true,
+            "description": "All product clusters related to the replacing item.",
+            "example": "135,137,143,518,1272"
+          },
+          "commercialConditionId": {
+            "type": "string",
+            "nullable": true,
+            "description": "Replacing item commercial conditions ID.",
+            "example": "5"
+          }
+        }
+      },
+      "LogisticsInfo1": {
+        "type": "object",
+        "description": "Logistics information object.",
+        "required": [
+          "itemIndex",
+          "selectedSla",
+          "selectedDeliveryChannel",
+          "addressId",
+          "slas",
+          "shipsTo",
+          "itemId",
+          "deliveryChannels",
+          "price",
+          "listPrice",
+          "shippingEstimate",
+          "dockEstimate",
+          "shippingEstimateDate",
+          "lockTTL",
+          "deliveryCompany",
+          "polygonName",
+          "transitTime",
+          "sellingPrice",
+          "deliveryIds",
+          "deliveryWindow",
+          "pickupPointId",
+          "pickupStoreInfo",
+          "pickupDistance"
+        ],
+        "properties": {
+          "itemIndex": {
+            "type": "integer",
+            "description": "Index that identifies the position of the replacing item in the array, starting from `0`.",
+            "example": 0
+          },
+          "selectedSla": {
+            "type": "string",
+            "description": "Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the replacing order.",
+            "example": "Normal"
+          },
+          "selectedDeliveryChannel": {
+            "type": "string",
+            "description": "Delivery channel selected by the customer, like `delivery` or `pickup-in-point`. This field is being deprecated and the information it retrieves can be usually be found in `deliveryChannel`.",
+            "example": "delivery",
+            "deprecated": true
+          },
+          "addressId": {
+            "type": "string",
+            "description": "Shipping address ID of the replacing item.",
+            "example": "9ec276fd3a604eb1aa151b5333ca5db7"
+          },
+          "slas": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/SlaV2"
+            },
+            "description": "Information on Service Level Agreement (SLA) of the change order shipping policy."
+          },
+          "shipsTo": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "description": "Country name represented in a three letters code ISO 3166 ALPHA-3.",
+              "example": "BRA"
+            },
+            "description": "List of countries of the change order shipping address."
+          },
+          "itemId": {
+            "type": "string",
+            "description": "Replacing item's SKU ID, which is a unique numerical identifier.",
+            "example": "3"
+          },
+          "deliveryChannels": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/DeliveryChannel"
+            },
+            "description": "Array with the delivery channels associated with the trade policy."
+          },
+          "price": {
+            "type": "integer",
+            "description": "Replacing item's final price, calculated in cents.",
+            "example": 600
+          },
+          "listPrice": {
+            "type": "integer",
+            "description": "Replacing item's price list, calculated in cents.",
+            "example": 600
+          },
+          "shippingEstimate": {
+            "type": "string",
+            "nullable": true,
+            "description": "Replacing item's shipping estimate date. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.",
+            "example": "2023-07-29T17:52:18.6483116Z"
+          },
+          "dockEstimate": {
+            "type": "string",
+            "nullable": true,
+            "description": "Replacing item's estimate duration of the [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) time. For instance, one business day is represented as `1bd`.",
+            "example": "1bd"
+          },
+          "shippingEstimateDate": {
+            "type": "string",
+            "nullable": true,
+            "description": "Replacing item's total shipping duration estimated in days. For instance, three business days are represented as `3bd`.",
+            "example": "3bd"
+          },
+          "lockTTL": {
+            "type": "string",
+            "nullable": true,
+            "description": "Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time of the SLA. For instance, one business day is represented as `1bd`.",
+            "example": "1bd"
+          },
+          "deliveryCompany": {
+            "type": "string",
+            "nullable": true,
+            "description": "[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) company's name.",
+            "example": "Correios"
+          },
+          "polygonName": {
+            "type": "string",
+            "nullable": true,
+            "description": "Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.",
+            "example": "114 - Polanco _ H-05"
+          },
+          "transitTime": {
+            "type": "string",
+            "nullable": true,
+            "description": "Duration in business days of the time the [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) takes in transit to fulfill the order. For example, three business days are represented as `3bd`.",
+            "example": "3bd"
+          },
+          "sellingPrice": {
+            "type": "integer",
+            "description": "Change item's selling price.",
+            "example": 600
+          },
+          "deliveryIds": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/DeliveryIdV2"
+            },
+            "description": "Array with delivery information."
+          },
+          "deliveryWindow": {
+            "type": "string",
+            "nullable": true,
+            "description": "Change order [scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.",
+            "example": null
+          },
+          "pickupPointId": {
+            "type": "string",
+            "nullable": true,
+            "description": "ID of the [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).",
+            "example": "pup215rkw"
+          },
+          "pickupStoreInfo": {
+            "$ref": "#/components/schemas/PickupStoreInfoV2"
+          },
+          "pickupDistance": {
+            "type": "number",
+            "nullable": true,
+            "description": "Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line.",
+            "example": "1.0"
+          }
+        }
+      },
+      "SlaV2": {
+        "description": "Service Level Agreement (SLA) object.",
+        "required": [
+          "id",
+          "deliveryChannel",
+          "name",
+          "deliveryIds",
+          "shippingEstimate",
+          "shippingEstimateDate",
+          "lockTTL",
+          "availableDeliveryWindows",
+          "deliveryWindow",
+          "price",
+          "listPrice",
+          "tax",
+          "pickupStoreInfo",
+          "pickupPointId",
+          "pickupDistance",
+          "polygonName",
+          "transitTime"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the order delivery or pickup.",
+            "example": "Normal"
+          },
+          "deliveryChannel": {
+            "type": "string",
+            "description": "Order shipping type, which can be `pickup-in-point` for [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R), and `delivery` for delivery.",
+            "example": "delivery"
+          },
+          "name": {
+            "type": "string",
+            "description": "Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the order delivery or pickup. It corresponds to the `id` value.",
+            "example": "Normal"
+          },
+          "deliveryIds": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/DeliveryIdV2"
+            },
+            "description": "Information about delivery IDs."
+          },
+          "shippingEstimate": {
+            "type": "string",
+            "nullable": true,
+            "description": "Total shipping duration estimated in days. For instance, three business days is represented as `3bd`.",
+            "example": "3bd"
+          },
+          "shippingEstimateDate": {
+            "type": "string",
+            "nullable": true,
+            "description": "Shipping estimate date. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.",
+            "example": "2023-07-27T17:52:18.6483116Z"
+          },
+          "lockTTL": {
+            "type": "string",
+            "nullable": true,
+            "description": "Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time of the SLA. For instance, one business day is represented as `1bd`.",
+            "example": "1bd"
+          },
+          "availableDeliveryWindows": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "description": "Delivery window."
+            },
+            "description": "Available [scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, for when the shipping policy has shipping windows configurations."
+          },
+          "deliveryWindow": {
+            "type": "object",
+            "nullable": true,
+            "description": "[Scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.",
+            "properties": {
+              "startDateUtc": {
+                "type": "string",
+                "description": "Delivery window starting date and time in [UTC ISO 8601 format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.",
+                "example": "2024-03-14T00:00:00+00:00"
+              },
+              "endDateUtc": {
+                "type": "string",
+                "description": "Delivery window ending date and time in [UTC ISO 8601 format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.",
+                "example": "2024-03-14T23:59:59+00:00"
+              }
+            }
+          },
+          "price": {
+            "type": "integer",
+            "description": "Shipping price for the item in cents. Does not account for the whole order's shipping price.",
+            "example": 600
+          },
+          "listPrice": {
+            "type": "integer",
+            "description": "Item's price list for a specific trade policy.",
+            "example": 600
+          },
+          "tax": {
+            "type": "integer",
+            "description": "Tax in cents, when applicable.",
+            "example": 0
+          },
+          "pickupStoreInfo": {
+            "$ref": "#/components/schemas/PickupStoreInfoV2"
+          },
+          "pickupPointId": {
+            "type": "string",
+            "nullable": true,
+            "description": "Pickup point ID is the unique identifier of the [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) related to the SLA.",
+            "example": "pup215rkw"
+          },
+          "pickupDistance": {
+            "type": "number",
+            "nullable": true,
+            "description": "Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line.",
+            "example": 1.0
+          },
+          "polygonName": {
+            "type": "string",
+            "nullable": true,
+            "description": "Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.",
+            "example": "114 - Polanco _ H-05"
+          },
+          "transitTime": {
+            "type": "string",
+            "nullable": true,
+            "description": "Duration in business days of the time the [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) takes in transit to fulfill the order. For example, three business days is represented as `3bd`.",
+            "example": "3bd"
+          }
+        }
+      },
+      "PickupStoreInfoV2": {
+        "type": "object",
+        "description": "Information about a loading dock that was transformed into a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).",
+        "required": [
+          "isPickupStore",
+          "friendlyName",
+          "address",
+          "additionalInfo",
+          "dockId"
+        ],
+        "deprecated": true,
+        "properties": {
+          "isPickupStore": {
+            "type": "boolean",
+            "description": "This field is related to converting a loading dock into a pickup point. It should always correspond to `false` because it has been deprecated.",
+            "example": false,
+            "nullable": true,
+            "deprecated": true
+          },
+          "friendlyName": {
+            "type": "string",
+            "description": "Name of the loading dock converted to pickup point to be displayed at checkout. This field has been deprecated.",
+            "example": null,
+            "nullable": true,
+            "deprecated": true
+          },
+          "address": {
+            "type": "string",
+            "nullable": true,
+            "description": "Address of the loading dock converted to pickup point. This field has been deprecated.",
+            "example": null,
+            "deprecated": true
+          },
+          "additionalInfo": {
+            "type": "string",
+            "nullable": true,
+            "description": "Additional information about the loading dock converted to pickup point. This field has been deprecated.",
+            "example": null,
+            "deprecated": true
+          },
+          "dockId": {
+            "type": "string",
+            "nullable": true,
+            "description": "ID of the loading dock converted to pickup point. This field has been deprecated.",
+            "example": "dockAjs28",
+            "deprecated": true
+          }
+        }
+      },
+      "OriginV2": {
+        "required": [
+          "account",
+          "orderId",
+          "component"
+        ],
+        "type": "object",
+        "properties": {
+          "account": {
+            "type": "string",
+            "description": "Name of the account where the order was made."
+          },
+          "orderId": {
+            "type": "string",
+            "description": "Order ID is a unique code that identifies an order."
+          },
+          "component": {
+            "type": "string",
+            "description": "Component information."
+          }
+        },
+        "description": "Object containing information about the order origin."
+      },
+      "Settings": {
+        "required": [
+          "customPaymentSystemsAllowed"
+        ],
+        "type": "object",
+        "description": "Object with account settings information, such as custom payment.",
+        "properties": {
+          "customPaymentSystemsAllowed": {
+            "type": "array",
+            "description": "Store's [custom payment](https://help.vtex.com/tutorial/how-to-configure-a-custom-payment--tutorials_451) information. Applicable only for stores that configured custom payment options.",
+            "items": {
+              "type": "string",
+              "description": "Custom payment code."
+            }
+          }
+        }
+      },
+      "From2": {
+        "type": "object",
+        "description": "What the order is changing from.",
+        "required": [
+          "paymentData",
+          "items",
+          "shippingData"
+        ],
+        "properties": {
+          "paymentData": {
+            "$ref": "#/components/schemas/PaymentDataV2"
+          },
+          "items": {
+            "type": "array",
+            "description": "Items information from before the order change.",
+            "items": {
+              "$ref": "#/components/schemas/Item4"
+            }
+          },
+          "shippingData": {
+            "$ref": "#/components/schemas/ShippingData3"
+          }
+        }
+      },
+      "Item4": {
+        "title": "Item4",
+        "required": [
+          "id",
+          "quantity",
+          "price",
+          "measurementUnit",
+          "unitMultiplier",
+          "sellingPrice",
+          "name",
+          "detailUrl",
+          "imageUrl"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "SKU ID of the item.",
+            "example": "1"
+          },
+          "quantity": {
+            "type": "integer",
+            "description": "Quantity of items been replaced.",
+            "example": 1
+          },
+          "price": {
+            "type": "string",
+            "nullable": true,
+            "description": "Item's shipping price. It does not account for the whole order's shipping price and is presented in cents.",
+            "example": 1000
+          },
+          "measurementUnit": {
+            "type": "string",
+            "nullable": true,
+            "description": "Item's measurement unit. For example, `kg` for kilograms or `un` for unitary items.",
+            "example": "kg"
+          },
+          "unitMultiplier": {
+            "type": "integer",
+            "description": "Item's unit multiplier.",
+            "example": 3
+          },
+          "sellingPrice": {
+            "type": "string",
+            "description": "Item's selling price.",
+            "example": 100
+          },
+          "name": {
+            "type": "string",
+            "nullable": true,
+            "description": "Item's name.",
+            "example": "T-shirt with logo"
+          },
+          "detailUrl": {
+            "type": "string",
+            "nullable": true,
+            "description": "Item's URL slug.",
+            "example": "/tshirt-logo/p"
+          },
+          "imageUrl": {
+            "type": "string",
+            "nullable": true,
+            "description": "Item's image URL slug.",
+            "example": "http://store.com.br/ids/155419-55-55//tshirt-logo.png?v=6378858562367"
+          }
+        },
+        "example": {
+          "id": "31",
+          "quantity": 1,
+          "price": 5000,
+          "measurementUnit": "un",
+          "unitMultiplier": 1,
+          "sellingPrice": 5000,
+          "name": "Fusca miniatura Fusca preto",
+          "detailUrl": "/fusca-miniatura-24/p",
+          "imageUrl": "http://qastore.vteximg.com.br/arquivos/ids/155431-55-55/image-bdab69af1e5c41cdbc498d02e370b376.jpg?v=636579391945870000"
+        }
+      },
+      "ShippingData3": {
+        "title": "ShippingData3",
+        "required": [
+          "logisticsInfo"
+        ],
+        "type": "object",
+        "properties": {
+          "logisticsInfo": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/LogisticsInfo2"
+            },
+            "description": "Array with shipping information."
+          }
+        },
+        "example": {
+          "logisticsInfo": [
+            {
+              "itemIndex": 0,
+              "selectedSla": "Lenta",
+              "selectedDeliveryChannel": "delivery",
+              "addressId": "9ec276fd3a604eb1aa151b5333ca5db6",
+              "slas": [
+                {
+                  "id": "Lenta",
+                  "deliveryChannel": "delivery",
+                  "name": "Lenta",
+                  "deliveryIds": [
+                    {
+                      "courierId": "1c083bf",
+                      "warehouseId": "1_1",
+                      "dockId": "1",
+                      "courierName": "Donkey",
+                      "quantity": 1,
+                      "kitItemDetails": [],
+                      "accountCarrierName": null
+                    }
+                  ],
+                  "shippingEstimate": "25bd",
+                  "shippingEstimateDate": "2023-08-30T10:17:24.6436519Z",
+                  "lockTTL": "12d",
+                  "availableDeliveryWindows": [],
+                  "deliveryWindow": null,
+                  "price": 180,
+                  "listPrice": 180,
+                  "tax": 0,
+                  "pickupStoreInfo": {
+                    "isPickupStore": false,
+                    "friendlyName": null,
+                    "address": null,
+                    "additionalInfo": null,
+                    "dockId": null
+                  },
+                  "pickupPointId": null,
+                  "pickupDistance": null,
+                  "polygonName": "",
+                  "transitTime": "25bd"
+                },
+                {
+                  "id": "Normal",
+                  "deliveryChannel": "delivery",
+                  "name": "Normal",
+                  "deliveryIds": [
+                    {
+                      "courierId": "1",
+                      "warehouseId": "1_1",
+                      "dockId": "1",
+                      "courierName": "Transportadora",
+                      "quantity": 1,
+                      "kitItemDetails": [],
+                      "accountCarrierName": null
+                    }
+                  ],
+                  "shippingEstimate": "3bd",
+                  "shippingEstimateDate": null,
+                  "lockTTL": "12d",
+                  "availableDeliveryWindows": [],
+                  "deliveryWindow": null,
+                  "price": 500,
+                  "listPrice": 500,
+                  "tax": 0,
+                  "pickupStoreInfo": {
+                    "isPickupStore": false,
+                    "friendlyName": null,
+                    "address": null,
+                    "additionalInfo": null,
+                    "dockId": null
+                  },
+                  "pickupPointId": null,
+                  "pickupDistance": null,
+                  "polygonName": "",
+                  "transitTime": "3bd"
+                },
+                {
+                  "id": "Pickup",
+                  "deliveryChannel": "delivery",
+                  "name": "Pickup",
+                  "deliveryIds": [
+                    {
+                      "courierId": "ech018654",
+                      "warehouseId": "1_1",
+                      "dockId": "1",
+                      "courierName": "Retirada",
+                      "quantity": 1,
+                      "kitItemDetails": [],
+                      "accountCarrierName": null
+                    }
+                  ],
+                  "shippingEstimate": "25bd",
+                  "shippingEstimateDate": null,
+                  "lockTTL": "12d",
+                  "availableDeliveryWindows": [],
+                  "deliveryWindow": null,
+                  "price": 700,
+                  "listPrice": 700,
+                  "tax": 0,
+                  "pickupStoreInfo": {
+                    "isPickupStore": false,
+                    "friendlyName": null,
+                    "address": null,
+                    "additionalInfo": null,
+                    "dockId": null
+                  },
+                  "pickupPointId": null,
+                  "pickupDistance": null,
+                  "polygonName": "",
+                  "transitTime": "25bd"
+                }
+              ],
+              "shipsTo": [
+                "BRA"
+              ],
+              "itemId": "31",
+              "deliveryChannels": [
+                {
+                  "id": "delivery"
+                }
+              ],
+              "price": 180,
+              "listPrice": 180,
+              "shippingEstimate": "25bd",
+              "dockEstimate": null,
+              "shippingEstimateDate": "2023-08-30T10:17:24.6436519Z",
+              "lockTTL": "12d",
+              "deliveryCompany": null,
+              "polygonName": "",
+              "transitTime": "25bd",
+              "sellingPrice": 180,
+              "deliveryIds": [
+                {
+                  "courierId": "1c083bf",
+                  "warehouseId": "1_1",
+                  "dockId": "1",
+                  "courierName": "Donkey",
+                  "quantity": 1,
+                  "kitItemDetails": null,
+                  "accountCarrierName": "qastoreecho"
+                }
+              ],
+              "deliveryWindow": null,
+              "pickupPointId": null,
+              "pickupStoreInfo": {
+                "isPickupStore": false,
+                "friendlyName": null,
+                "address": null,
+                "additionalInfo": null,
+                "dockId": null
+              },
+              "pickupDistance": null
+            }
+          ]
+        }
+      },
+      "LogisticsInfo2": {
+        "title": "LogisticsInfo2",
+        "required": [
+          "itemIndex",
+          "selectedSla",
+          "selectedDeliveryChannel",
+          "addressId",
+          "slas",
+          "shipsTo",
+          "itemId",
+          "deliveryChannels",
+          "price",
+          "listPrice",
+          "shippingEstimate",
+          "dockEstimate",
+          "shippingEstimateDate",
+          "lockTTL",
+          "deliveryCompany",
+          "polygonName",
+          "transitTime",
+          "sellingPrice",
+          "deliveryIds",
+          "deliveryWindow",
+          "pickupPointId",
+          "pickupStoreInfo",
+          "pickupDistance"
+        ],
+        "type": "object",
+        "properties": {
+          "itemIndex": {
+            "type": "integer",
+            "description": "Index that identifies the position of the replacing item in the array, starting from `0`.",
+            "example": 0
+          },
+          "selectedSla": {
+            "type": "string",
+            "description": "Shipping method of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) used in the replacing order.",
+            "example": "Normal"
+          },
+          "selectedDeliveryChannel": {
+            "type": "string",
+            "description": "Delivery channel selected by the customer, like `delivery` or `pickup-in-point`. This field is being deprecated and the information it retrieves can be usually be found in `deliveryChannel`.",
+            "example": "delivery",
+            "deprecated": true
+          },
+          "addressId": {
+            "type": "string",
+            "description": "Shipping address ID.",
+            "example": "9ec276fd3a604eb1aa151b5333ca5db7"
+          },
+          "slas": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/SlaV2"
+            },
+            "description": "Information on Service Level Agreement (SLA) of the change order."
+          },
+          "shipsTo": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "description": "Country name represented in a three letters code ISO 3166 ALPHA-3.",
+              "example": "BRA"
+            },
+            "description": "List of countries of the change order shipping address."
+          },
+          "itemId": {
+            "type": "string",
+            "description": "Replacing item's SKU ID, which is a unique numerical identifier.",
+            "example": "3"
+          },
+          "deliveryChannels": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/DeliveryChannel"
+            },
+            "description": "Array with the delivery channels associated with the trade policy."
+          },
+          "price": {
+            "type": "integer",
+            "description": "Item's final price, calculated in cents.",
+            "example": 600
+          },
+          "listPrice": {
+            "type": "integer",
+            "description": "Item's price list, calculated in cents.",
+            "example": 600
+          },
+          "shippingEstimate": {
+            "type": "string",
+            "nullable": true,
+            "description": "Item's shipping estimate date. The value is in UTC ISO 8601 format `yyyy-mm-ddThh:mm:ss.sssZ`.",
+            "example": "2023-07-29T17:52:18.6483116Z"
+          },
+          "dockEstimate": {
+            "type": "string",
+            "nullable": true,
+            "description": "Item's estimate duration of the [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) time. For instance, one business day is represented as `1bd`.",
+            "example": "1bd"
+          },
+          "shippingEstimateDate": {
+            "type": "string",
+            "nullable": true,
+            "description": "Replacing item's total shipping duration estimated in days. For instance, three business days are represented as `3bd`.",
+            "example": "3bd"
+          },
+          "lockTTL": {
+            "type": "string",
+            "nullable": true,
+            "description": "Logistics [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) waiting time of the SLA. For instance, one business day is represented as `1bd`.",
+            "example": "1bd"
+          },
+          "deliveryCompany": {
+            "type": "string",
+            "nullable": true,
+            "description": "[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) company's name.",
+            "example": "Correios"
+          },
+          "polygonName": {
+            "type": "string",
+            "nullable": true,
+            "description": "Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation/) associated with the shipping policy.",
+            "example": "114 - Polanco _ H-05"
+          },
+          "transitTime": {
+            "type": "string",
+            "nullable": true,
+            "description": "Duration in business days of the time the [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) takes in transit to fulfill the order. For example, three business days are represented as `3bd`.",
+            "example": "3bd"
+          },
+          "sellingPrice": {
+            "type": "integer",
+            "description": "Item's selling price.",
+            "example": 600
+          },
+          "deliveryIds": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/DeliveryIdV2"
+            },
+            "description": "Array with delivery information."
+          },
+          "deliveryWindow": {
+            "type": "string",
+            "nullable": true,
+            "description": "Change order [scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) information, when applicable.",
+            "example": null
+          },
+          "pickupPointId": {
+            "type": "string",
+            "nullable": true,
+            "description": "ID of the [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).",
+            "example": "pup215rkw"
+          },
+          "pickupStoreInfo": {
+            "$ref": "#/components/schemas/PickupStoreInfoV2"
+          },
+          "pickupDistance": {
+            "type": "number",
+            "nullable": true,
+            "description": "Distance in kilometers between the pickup point and the customer's address. The distance is measured as a straight line.",
+            "example": 1.0
+          }
+        },
+        "example": {
+          "itemIndex": 0,
+          "selectedSla": "Lenta",
+          "selectedDeliveryChannel": "delivery",
+          "addressId": "9ec276fd3a604eb1aa151b5333ca5db6",
+          "slas": [
+            {
+              "id": "Lenta",
+              "deliveryChannel": "delivery",
+              "name": "Lenta",
+              "deliveryIds": [
+                {
+                  "courierId": "1c083bf",
+                  "warehouseId": "1_1",
+                  "dockId": "1",
+                  "courierName": "Donkey",
+                  "quantity": 1,
+                  "kitItemDetails": [],
+                  "accountCarrierName": null
+                }
+              ],
+              "shippingEstimate": "25bd",
+              "shippingEstimateDate": "2023-08-30T10:17:24.6436519Z",
+              "lockTTL": "12d",
+              "availableDeliveryWindows": [],
+              "deliveryWindow": null,
+              "price": 180,
+              "listPrice": 180,
+              "tax": 0,
+              "pickupStoreInfo": {
+                "isPickupStore": false,
+                "friendlyName": null,
+                "address": null,
+                "additionalInfo": null,
+                "dockId": null
+              },
+              "pickupPointId": null,
+              "pickupDistance": null,
+              "polygonName": "",
+              "transitTime": "25bd"
+            },
+            {
+              "id": "Normal",
+              "deliveryChannel": "delivery",
+              "name": "Normal",
+              "deliveryIds": [
+                {
+                  "courierId": "1",
+                  "warehouseId": "1_1",
+                  "dockId": "1",
+                  "courierName": "Transportadora",
+                  "quantity": 1,
+                  "kitItemDetails": [],
+                  "accountCarrierName": null
+                }
+              ],
+              "shippingEstimate": "3bd",
+              "shippingEstimateDate": null,
+              "lockTTL": "12d",
+              "availableDeliveryWindows": [],
+              "deliveryWindow": null,
+              "price": 500,
+              "listPrice": 500,
+              "tax": 0,
+              "pickupStoreInfo": {
+                "isPickupStore": false,
+                "friendlyName": null,
+                "address": null,
+                "additionalInfo": null,
+                "dockId": null
+              },
+              "pickupPointId": null,
+              "pickupDistance": null,
+              "polygonName": "",
+              "transitTime": "3bd"
+            },
+            {
+              "id": "Pickup",
+              "deliveryChannel": "delivery",
+              "name": "Pickup",
+              "deliveryIds": [
+                {
+                  "courierId": "ech018654",
+                  "warehouseId": "1_1",
+                  "dockId": "1",
+                  "courierName": "Retirada",
+                  "quantity": 1,
+                  "kitItemDetails": [],
+                  "accountCarrierName": null
+                }
+              ],
+              "shippingEstimate": "25bd",
+              "shippingEstimateDate": null,
+              "lockTTL": "12d",
+              "availableDeliveryWindows": [],
+              "deliveryWindow": null,
+              "price": 700,
+              "listPrice": 700,
+              "tax": 0,
+              "pickupStoreInfo": {
+                "isPickupStore": false,
+                "friendlyName": null,
+                "address": null,
+                "additionalInfo": null,
+                "dockId": null
+              },
+              "pickupPointId": null,
+              "pickupDistance": null,
+              "polygonName": "",
+              "transitTime": "25bd"
+            }
+          ],
+          "shipsTo": [
+            "BRA"
+          ],
+          "itemId": "31",
+          "deliveryChannels": [
+            {
+              "id": "delivery"
+            }
+          ],
+          "price": 180,
+          "listPrice": 180,
+          "shippingEstimate": "25bd",
+          "dockEstimate": null,
+          "shippingEstimateDate": "2023-08-30T10:17:24.6436519Z",
+          "lockTTL": "12d",
+          "deliveryCompany": null,
+          "polygonName": "",
+          "transitTime": "25bd",
+          "sellingPrice": 180,
+          "deliveryIds": [
+            {
+              "courierId": "1c083bf",
+              "warehouseId": "1_1",
+              "dockId": "1",
+              "courierName": "Donkey",
+              "quantity": 1,
+              "kitItemDetails": null,
+              "accountCarrierName": "qastoreecho"
+            }
+          ],
+          "deliveryWindow": null,
+          "pickupPointId": null,
+          "pickupStoreInfo": {
+            "isPickupStore": false,
+            "friendlyName": null,
+            "address": null,
+            "additionalInfo": null,
+            "dockId": null
+          },
+          "pickupDistance": null
+        }
+      },
+      "DeliveryIdV2": {
+        "title": "DeliveryIdV2",
+        "required": [
+          "courierId",
+          "warehouseId",
+          "dockId",
+          "courierName",
+          "quantity",
+          "kitItemDetails",
+          "accountCarrierName"
+        ],
+        "type": "object",
+        "properties": {
+          "courierId": {
+            "type": "string",
+            "description": "ID of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).",
+            "example": "136769c"
+          },
+          "warehouseId": {
+            "type": "string",
+            "description": "ID of the [warehouse](https://help.vtex.com/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).",
+            "example": "w_156"
+          },
+          "dockId": {
+            "type": "string",
+            "description": "ID of the [loading dock](https://help.vtex.com/pt/tutorial/doca--5DY8xHEjOLYDVL41Urd5qj).",
+            "example": "ld931"
+          },
+          "courierName": {
+            "type": "string",
+            "description": "Name of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).",
+            "example": "Crossborder"
+          },
+          "quantity": {
+            "type": "integer",
+            "description": "Quantity of items.",
+            "example": 1
+          },
+          "kitItemDetails": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "description": "Information about [kits](https://help.vtex.com/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28), when applicable to the order.",
+              "example": null,
+              "nullable": true
+            }
+          },
+          "accountCarrierName": {
+            "type": "string",
+            "nullable": true,
+            "description": "Name of the account's [carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE).",
+            "example": "vtexlog"
+          }
+        },
+        "example": {
+          "courierId": "1c083bf",
+          "warehouseId": "1_1",
+          "dockId": "1",
+          "courierName": "Donkey",
+          "quantity": 1,
+          "kitItemDetails": [],
+          "accountCarrierName": null
+        }
+      },
+      "DeliveryChannel": {
+        "title": "DeliveryChannel",
+        "required": [
+          "id"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Change order shipping type, which can be `pickup-in-point` for [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R), and `delivery` for delivery.",
+            "example": "delivery"
+          }
+        },
+        "example": {
+          "id": "delivery"
+        }
+      },
+      "To2": {
+        "title": "To2",
+        "required": [
+          "items",
+          "paymentData",
+          "receiptData",
+          "shippingData"
+        ],
+        "type": "object",
+        "properties": {
+          "items": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Item3"
+            },
+            "description": "Array containing information about the item replacing the previous one."
+          },
+          "paymentData": {
+            "$ref": "#/components/schemas/PaymentDataV2"
+          },
+          "receiptData": {
+            "type": "object",
+            "nullable": true,
+            "description": "Information about the receipt after order change.",
+            "example": null
+          },
+          "shippingData": {
+            "$ref": "#/components/schemas/ShippingData3"
+          }
+        },
+        "example": {
+          "items": [
+            {
+              "uniqueId": "40E763F4378E4F40AD1FE915FE1078E1",
+              "id": "1",
+              "productId": "1",
+              "productRefId": "",
+              "refId": "codrefxicaraazul",
+              "ean": "8745121641",
+              "name": "xícara azul",
+              "skuName": "azul",
+              "modalType": null,
+              "parentItemIndex": null,
+              "parentAssemblyBinding": null,
+              "assemblies": [],
+              "priceValidUntil": null,
+              "tax": 0,
+              "price": 5000,
+              "listPrice": null,
+              "manualPrice": null,
+              "manualPriceAppliedBy": null,
+              "sellingPrice": 5000,
+              "rewardValue": 0,
+              "isGift": false,
+              "additionalInfo": {
+                "dimension": null,
+                "brandName": null,
+                "brandId": null,
+                "offeringInfo": null,
+                "offeringType": null,
+                "offeringTypeId": null,
+                "categoriesIds": null,
+                "productClusterId": null,
+                "commercialConditionId": null
+              },
+              "preSaleDate": null,
+              "productCategoryIds": "/1/",
+              "productCategories": {
+                "1": "Category"
+              },
+              "quantity": 1,
+              "seller": "1",
+              "sellerChain": [
+                "1"
+              ],
+              "imageUrl": "http://qastore.vteximg.com.br/arquivos/ids/155394-55-55/xicara.jpg?v=636565506415770000",
+              "detailUrl": "/xicara/p",
+              "components": [],
+              "bundleItems": [],
+              "attachments": [],
+              "attachmentOfferings": [],
+              "offerings": [],
+              "priceTags": [],
+              "availability": null,
+              "measurementUnit": "un",
+              "unitMultiplier": 1,
+              "manufacturerCode": null,
+              "priceDefinition": {
+                "calculatedSellingPrice": 5000,
+                "total": 5000,
+                "sellingPrices": [
+                  {
+                    "value": 5000,
+                    "quantity": 1
+                  }
+                ]
+              }
+            }
+          ],
+          "paymentData": {
+            "transactions": []
+          },
+          "receiptData": null,
+          "shippingData": {
+            "logisticsInfo": [
+              {
+                "itemIndex": 0,
+                "selectedSla": "Lenta",
+                "selectedDeliveryChannel": "delivery",
+                "addressId": "9ec276fd3a604eb1aa151b5333ca5db6",
+                "slas": [
+                  {
+                    "id": "Lenta",
+                    "deliveryChannel": "delivery",
+                    "name": "Lenta",
+                    "deliveryIds": [
+                      {
+                        "courierId": "1c083bf",
+                        "warehouseId": "1_1",
+                        "dockId": "1",
+                        "courierName": "Donkey",
+                        "quantity": 1,
+                        "kitItemDetails": [],
+                        "accountCarrierName": null
+                      }
+                    ],
+                    "shippingEstimate": "25bd",
+                    "shippingEstimateDate": "2023-08-30T10:17:24.6436519Z",
+                    "lockTTL": "12d",
+                    "availableDeliveryWindows": [],
+                    "deliveryWindow": null,
+                    "price": 600,
+                    "listPrice": 180,
+                    "tax": 0,
+                    "pickupStoreInfo": {
+                      "isPickupStore": false,
+                      "friendlyName": null,
+                      "address": null,
+                      "additionalInfo": null,
+                      "dockId": null
+                    },
+                    "pickupPointId": null,
+                    "pickupDistance": null,
+                    "polygonName": "",
+                    "transitTime": "25bd"
+                  },
+                  {
+                    "id": "Normal",
+                    "deliveryChannel": "delivery",
+                    "name": "Normal",
+                    "deliveryIds": [
+                      {
+                        "courierId": "1",
+                        "warehouseId": "1_1",
+                        "dockId": "1",
+                        "courierName": "Transportadora",
+                        "quantity": 1,
+                        "kitItemDetails": [],
+                        "accountCarrierName": null
+                      }
+                    ],
+                    "shippingEstimate": "3bd",
+                    "shippingEstimateDate": null,
+                    "lockTTL": "12d",
+                    "availableDeliveryWindows": [],
+                    "deliveryWindow": null,
+                    "price": 500,
+                    "listPrice": 500,
+                    "tax": 0,
+                    "pickupStoreInfo": {
+                      "isPickupStore": false,
+                      "friendlyName": null,
+                      "address": null,
+                      "additionalInfo": null,
+                      "dockId": null
+                    },
+                    "pickupPointId": null,
+                    "pickupDistance": null,
+                    "polygonName": "",
+                    "transitTime": "3bd"
+                  },
+                  {
+                    "id": "Pickup",
+                    "deliveryChannel": "delivery",
+                    "name": "Pickup",
+                    "deliveryIds": [
+                      {
+                        "courierId": "ech018654",
+                        "warehouseId": "1_1",
+                        "dockId": "1",
+                        "courierName": "Retirada",
+                        "quantity": 1,
+                        "kitItemDetails": [],
+                        "accountCarrierName": null
+                      }
+                    ],
+                    "shippingEstimate": "25bd",
+                    "shippingEstimateDate": null,
+                    "lockTTL": "12d",
+                    "availableDeliveryWindows": [],
+                    "deliveryWindow": null,
+                    "price": 700,
+                    "listPrice": 700,
+                    "tax": 0,
+                    "pickupStoreInfo": {
+                      "isPickupStore": false,
+                      "friendlyName": null,
+                      "address": null,
+                      "additionalInfo": null,
+                      "dockId": null
+                    },
+                    "pickupPointId": null,
+                    "pickupDistance": null,
+                    "polygonName": "",
+                    "transitTime": "25bd"
+                  }
+                ],
+                "shipsTo": [
+                  "BRA"
+                ],
+                "itemId": "1",
+                "deliveryChannels": [
+                  {
+                    "id": "delivery"
+                  }
+                ],
+                "price": 600,
+                "listPrice": 180,
+                "shippingEstimate": "25bd",
+                "dockEstimate": null,
+                "shippingEstimateDate": "2023-08-30T10:17:24.6436519Z",
+                "lockTTL": "12d",
+                "deliveryCompany": null,
+                "polygonName": "",
+                "transitTime": "25bd",
+                "sellingPrice": 600,
+                "deliveryIds": [
+                  {
+                    "courierId": "1c083bf",
+                    "warehouseId": "1_1",
+                    "dockId": "1",
+                    "courierName": "Donkey",
+                    "quantity": 1,
+                    "kitItemDetails": null,
+                    "accountCarrierName": "qastoreecho"
+                  }
+                ],
+                "deliveryWindow": null,
+                "pickupPointId": null,
+                "pickupStoreInfo": {
+                  "isPickupStore": false,
+                  "friendlyName": null,
+                  "address": null,
+                  "additionalInfo": null,
+                  "dockId": null
+                },
+                "pickupDistance": null
+              }
+            ]
+          }
+        }
+      },
+      "PriceDefinition": {
+        "title": "PriceDefinition",
+        "required": [
+          "calculatedSellingPrice",
+          "total",
+          "sellingPrices"
+        ],
+        "type": "object",
+        "properties": {
+          "calculatedSellingPrice": {
+            "type": "integer"
+          },
+          "total": {
+            "type": "integer"
+          },
+          "sellingPrices": {
+            "type": "array",
+            "description": "Array containing selling price information.",
+            "items": {
+              "type": "object",
+              "description": "Selling price details.",
+              "required": [
+                "value",
+                "quantity"
+              ],
+              "properties": {
+                "value": {
+                  "type": "integer",
+                  "description": "Selling price value in cents."
+                },
+                "quantity": {
+                  "type": "integer",
+                  "description": "Quantity of items related to selling price."
+                }
+              }
+            }
+          }
+        },
+        "example": {
+          "calculatedSellingPrice": 5000,
+          "total": 5000,
+          "sellingPrices": [
+            {
+              "value": 5000,
+              "quantity": 1
+            }
+          ]
+        }
+      },
+      "ChangeOrderSettingsResponse": {
+        "type": "object",
+        "description": "Object with all VTEX account settings related to the **Change order** feature.",
+        "properties": {
+          "paymentConfiguration": {
+            "type": "object",
+            "description": "[Change order](https://help.vtex.com/en/tutorial/how-change-order-works-beta--56TO0bOFXsfmpc7YZ3wIUZ) payment configurations.",
+            "properties": {
+              "customPaymentSystemsAllowed": {
+                "type": "array",
+                "description": "List of custom payment system IDs configured for the VTEX account.",
+                "items": {
+                  "type": "string",
+                  "description": "Payment system ID."
+                }
+              }
+            }
+          },
+          "rolloutConfiguration": {
+            "type": "object",
+            "description": "**Change order** settings regarding VTEX Admin, [Orders API](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes?endpoint=patch-/api/order-system/orders/-changeOrderId-/changes) and **My Account** feature.",
+            "properties": {
+              "usingDefaultBehavior": {
+                "type": "boolean",
+                "description": "Defines if the **Change order** configurations are the default behaviour (`true`) or if the account made customizations to it (`false`). Subaccounts will have the same configurations as the main account.",
+                "default": false
+              },
+              "enableApi": {
+                "type": "boolean",
+                "description": "Defines if the account enabled the [Change order API](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) (`true`) or not (`false`). The account can only use the [Change order via VTEX Admin](https://help.vtex.com/en/tutorial/how-to-change-orders-beta--7btlG91rb6sHpW1dkd2kBw) or [via API](https://developers.vtex.com/docs/api-reference/orders-api#patch-/api/order-system/orders/-changeOrderId-/changes) if this field is set to `true`.",
+                "default": false
+              },
+              "enableAdminOrders": {
+                "type": "object",
+                "description": "Object about enabling the [Change order feature via VTEX Admin](https://help.vtex.com/en/tutorial/how-to-change-orders-beta--7btlG91rb6sHpW1dkd2kBw).",
+                "properties": {
+                  "enabledWorkspaces": {
+                    "type": "array",
+                    "description": "List with the workspaces' names that have the **Change order** feature enabled via VTEX Admin.",
+                    "items": {
+                      "type": "string",
+                      "description": "Name of the workspace with **Change order** enabled via VTEX Admin. The asterisk `*` value includes all of the account's workspaces."
+                    }
+                  }
+                }
+              },
+              "enableMyOrders": {
+                "type": "object",
+                "description": "Object about enabling the **Change order** feature via [My Account](https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh).",
+                "properties": {
+                  "enabledWorkspaces": {
+                    "type": "array",
+                    "description": "List with the workspace names that have the **Change order** feature enabled via **My Account**.",
+                    "items": {
+                      "type": "string",
+                      "description": "Name of the workspace with **Change order** enabled via **My Account**. The asterisk `*` value includes all of the account's workspaces."
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "pipelineConfiguration": {
+            "type": "object",
+            "description": "**Change order** settings related to taxes and shipping calculation.",
+            "properties": {
+              "enableTaxHubRecalculation": {
+                "type": "boolean",
+                "description": "Defines if the tax calculation is enabled for **Change order** (`true`) or not (`false`).",
+                "default": false
+              },
+              "compensateShippingChanges": {
+                "type": "boolean",
+                "description": "Defines if orders changed will have zero shipping cost (`true`) or not (`false`). Merchants usually enable this configuration to change only items and prices, without impacting the orders original freight costs.",
+                "default": true
+              }
+            }
+          }
+        }
+      },
+      "Userorderdetails": {
+        "title": "Userorderdetails",
+        "required": [
+          "orderId",
+          "sequence",
+          "marketplaceOrderId",
+          "marketplaceServicesEndpoint",
+          "sellerOrderId",
+          "origin",
+          "affiliateId",
+          "salesChannel",
+          "merchantName",
+          "status",
+          "workflowIsInError",
+          "statusDescription",
+          "value",
+          "creationDate",
+          "lastChange",
+          "orderGroup",
+          "totals",
+          "items",
+          "marketplaceItems",
+          "clientProfileData",
+          "giftRegistryData",
+          "marketingData",
+          "ratesAndBenefitsData",
+          "shippingData",
+          "paymentData",
+          "packageAttachment",
+          "sellers",
+          "callCenterOperatorData",
+          "followUpEmail",
+          "lastMessage",
+          "hostname",
+          "invoiceData",
+          "changesAttachment",
+          "openTextField",
+          "roundingError",
+          "orderFormId",
+          "commercialConditionData",
+          "isCompleted",
+          "customData",
+          "storePreferencesData",
+          "allowCancellation",
+          "allowEdition",
+          "isCheckedIn",
+          "marketplace",
+          "authorizedDate",
+          "invoicedDate",
+          "cancelReason",
+          "itemMetadata",
+          "subscriptionData",
+          "taxData",
+          "checkedInPickupPointId",
+          "cancellationData",
+          "clientPreferencesData",
+          "cancellationRequests"
+        ],
+        "type": "object",
+        "properties": {
+          "orderId": {
+            "type": "string",
+            "description": "Order ID is a unique code that identifies an order."
+          },
+          "sequence": {
+            "type": "string",
+            "description": "Sequence is a six-digit string that follows the order ID. For example, in order `1268540501456-01 (501456)`, the sequence is `501456`."
+          },
+          "marketplaceOrderId": {
+            "type": "string",
+            "description": "Marketplace order ID."
+          },
+          "marketplaceServicesEndpoint": {
+            "type": "string",
+            "description": "Marketplace services endpoint."
+          },
+          "sellerOrderId": {
+            "type": "string",
+            "description": "ID of the seller related to the order. It can be a VTEX seller or an external seller."
+          },
+          "origin": {
+            "type": "string",
+            "description": "Order's [origin in the order flow](https://developers.vtex.com/docs/guides/orders-overview#understanding-order-flow-types), which can be `Marketplace`, `Fulfillment` or `Chain`."
+          },
+          "affiliateId": {
+            "type": "string",
+            "description": "Corresponds to the three-digit [affiliate](https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials_187) identification code of the seller responsible for the order."
+          },
+          "salesChannel": {
+            "type": "string",
+            "description": "Sales channel (or [trade policy](https://help.vtex.com/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) ID related to the order."
+          },
+          "merchantName": {
+            "type": "string",
+            "description": "Name of the merchant."
+          },
+          "status": {
+            "type": "string",
+            "description": "Order [status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196)."
+          },
+          "workflowIsInError": {
+            "type": "boolean",
+            "description": "Indicates if the order workflow is in an error state."
+          },
+          "statusDescription": {
+            "type": "string",
+            "description": "`Deprecated`. Status description which is displayed on the Admin panel. This field is obsolete and may not return any value.",
+            "deprecated": true
+          },
+          "value": {
+            "type": "integer",
+            "description": "Order's total amount."
+          },
+          "creationDate": {
+            "type": "string",
+            "description": "Order's creation date."
+          },
+          "lastChange": {
+            "type": "string",
+            "description": "Order's last change date."
+          },
+          "orderGroup": {
+            "type": "string",
+            "description": "Order's group ID."
+          },
+          "totals": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Total"
+            },
+            "description": "List with details about orders' totals."
+          },
+          "items": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/OrderItem"
+            },
+            "description": "Information about order's items."
+          },
+          "marketplaceItems": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "description": "Marketplace details object."
+          },
+          "clientProfileData": {
+            "$ref": "#/components/schemas/ClientProfileData"
+          },
+          "giftRegistryData": {
+            "type": "string",
+            "nullable": true,
+            "description": "Information about gift list, when it applies."
+          },
+          "marketingData": {
+            "type": "object",
+            "description": "Information about promotions and marketing. For example, coupon tracking information and internal or external UTMs.",
+            "properties": {
+              "id": {
+                "type": "string",
+                "description": "Object ID. The expected value is `marketingData`."
+              },
+              "utmSource": {
+                "type": "string",
+                "description": "Value of the `utm_source` parameter of the URL that led to the request."
+              },
+              "utmPartner": {
+                "type": "string",
+                "description": "UTM Source Parameters."
+              },
+              "utmMedium": {
+                "type": "string",
+                "description": "Value of the `utm_medium` parameter of the URL that led to the request."
+              },
+              "utmCampaign": {
+                "type": "string",
+                "description": "Value of the `utm_campaign` parameter of the URL that led to the request."
+              },
+              "coupon": {
+                "type": "string",
+                "description": "Coupon code."
+              },
+              "utmiCampaign": {
+                "type": "string",
+                "description": "Internal UTM value `utmi_cp`."
+              },
+              "utmipage": {
+                "type": "string",
+                "description": "Internal UTM value `utmi_p`."
+              },
+              "utmiPart": {
+                "type": "string",
+                "description": "Internal UTM value `utmi_pc`."
+              },
+              "marketingTags": {
+                "type": "array",
+                "description": "Marketing tags information. This field can be used to register campaign data or informative tags regarding promotions.",
+                "items": {
+                  "type": "string",
+                  "description": "Marketing tag."
+                }
+              }
+            },
+            "nullable": true
+          },
+          "ratesAndBenefitsData": {
+            "$ref": "#/components/schemas/RatesAndBenefitsData"
+          },
+          "shippingData": {
+            "$ref": "#/components/schemas/ShippingData"
+          },
+          "paymentData": {
+            "$ref": "#/components/schemas/PaymentData"
+          },
+          "packageAttachment": {
+            "$ref": "#/components/schemas/PackageAttachment"
+          },
+          "sellers": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Seller"
+            },
+            "description": "List of all sellers associated with the order."
+          },
+          "callCenterOperatorData": {
+            "type": "string",
+            "nullable": true,
+            "description": "Call center operator responsible for the order."
+          },
+          "followUpEmail": {
+            "type": "string",
+            "description": "Email of the store's employee responsible for managing the order."
+          },
+          "lastMessage": {
+            "type": "string",
+            "nullable": true,
+            "description": "Last sent transactional message."
+          },
+          "hostname": {
+            "type": "string",
+            "description": "Account Hostname registered in License Manager."
+          },
+          "invoiceData": {
+            "type": "object",
+            "nullable": true,
+            "description": "Information pertinent to the order's invoice."
+          },
+          "changesAttachment": {
+            "$ref": "#/components/schemas/ChangesAttachment"
+          },
+          "openTextField": {
+            "type": "string",
+            "nullable": true,
+            "description": "Optional field with order's additional information. This field must be filled in using the following format: \n\r```\n\r{\r\n    \"fieldExample\": \"ValueExample\"\r\n  }\n\r```\n\r."
+          },
+          "roundingError": {
+            "type": "integer",
+            "description": "Rounding error total amount, if it applies. For example, in orders with a discount over non-integer multiplier items, the rounding price is performed per item, not after the sum of all items. That can cause a difference in the total discount amount, which is informed in this field."
+          },
+          "orderFormId": {
+            "type": "string",
+            "description": "[Order form](https://developers.vtex.com/docs/guides/orderform-fields) ID."
+          },
+          "commercialConditionData": {
+            "type": "string",
+            "nullable": true,
+            "description": "Information about commercial conditions."
+          },
+          "isCompleted": {
+            "type": "boolean",
+            "description": "When set as `true`, the order's payment has been settled, and when set as `false`, it has not been settled yet."
+          },
+          "customData": {
+            "type": "string",
+            "nullable": true,
+            "description": "Custom information in the order. This field is useful for storing data not included in other fields, for example, a message for a gift or a name to be printed in a shirt."
+          },
+          "storePreferencesData": {
+            "$ref": "#/components/schemas/StorePreferencesData"
+          },
+          "allowCancellation": {
+            "type": "boolean",
+            "description": "When set as `true`, the order can be canceled, and when set as `false`, it is no longer possible to cancel the order."
+          },
+          "allowEdition": {
+            "type": "boolean",
+            "description": "When set as `true`, the order can be edited, and when set as `false`, it is no longer possible to edit the order."
+          },
+          "isCheckedIn": {
+            "type": "boolean",
+            "description": "This field is set `true` when the order was made via inStore and `false` when it was not."
+          },
+          "marketplace": {
+            "$ref": "#/components/schemas/Marketplace"
+          },
+          "authorizedDate": {
+            "type": "string",
+            "description": "Authorized order date."
+          },
+          "invoicedDate": {
+            "type": "string",
+            "nullable": true,
+            "description": "Order's invoice date."
+          },
+          "cancelReason": {
+            "type": "string",
+            "nullable": true,
+            "description": "Reason for order cancellation."
+          },
+          "itemMetadata": {
+            "$ref": "#/components/schemas/ItemMetadata"
+          },
+          "subscriptionData": {
+            "$ref": "#/components/schemas/SubscriptionData"
+          },
+          "taxData": {
+            "$ref": "#/components/schemas/TaxData"
+          },
+          "checkedInPickupPointId": {
+            "type": "string",
+            "description": "If the field `isCheckedIn` is set as `true`, the `checkedInPickupPointId` will retrieve the ID of the physical store where the order was made."
+          },
+          "cancellationData": {
+            "$ref": "#/components/schemas/CancellationData"
+          },
+          "clientPreferencesData": {
+            "$ref": "#/components/schemas/ClientPreferencesData"
+          },
+          "cancellationRequests": {
+            "type": "array",
+            "description": "Details of cancellation requests made for the order.",
+            "items": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "string",
+                  "description": "ID of the cancellation request."
+                },
+                "reason": {
+                  "type": "string",
+                  "description": "Reason for the cancellation request."
+                },
+                "cancellationRequestDate": {
+                  "type": "string",
+                  "description": "Date when the cancellation was requested."
+                },
+                "requestedByUser": {
+                  "type": "boolean",
+                  "description": "Indicates if the request was made by the user."
+                },
+                "deniedBySeller": {
+                  "type": "boolean",
+                  "description": "Indicates if the cancellation request was denied by the seller."
+                },
+                "deniedBySellerReason": {
+                  "type": "string",
+                  "nullable": true,
+                  "description": "Reason for denial by the seller."
+                },
+                "cancellationRequestDenyDate": {
+                  "type": "string",
+                  "nullable": true,
+                  "description": "Date when the cancellation request was denied."
+                }
+              }
+            }
+          }
+        }
+      },
+      "ItemMetadata": {
+        "type": "object",
+        "description": "Metadata information about the order's items.",
+        "required": [
+          "Items"
+        ],
+        "properties": {
+          "Items": {
+            "type": "array",
+            "description": "Metadata items.",
+            "items": {
+              "type": "object",
+              "required": [
+                "Id",
+                "Seller",
+                "Name",
+                "SkuName",
+                "ProductId",
+                "RefId",
+                "Ean",
+                "ImageUrl",
+                "DetailUrl",
+                "AssemblyOptions"
+              ],
+              "properties": {
+                "Id": {
+                  "type": "string",
+                  "description": "Item's SKU ID, which is a unique numerical identifier."
+                },
+                "Seller": {
+                  "type": "string",
+                  "description": "Seller ID that identifies the seller the item belongs to."
+                },
+                "Name": {
+                  "type": "string",
+                  "description": "Name of the item as displayed to customers in the storefront."
+                },
+                "SkuName": {
+                  "type": "string",
+                  "description": "Name of the SKU corresponding to the item."
+                },
+                "ProductId": {
+                  "type": "string",
+                  "description": "ID of the Product associated with the item."
+                },
+                "RefId": {
+                  "type": "string",
+                  "description": "Item's reference ID."
+                },
+                "Ean": {
+                  "type": "string",
+                  "description": "EAN of the item."
+                },
+                "ImageUrl": {
+                  "type": "string",
+                  "description": "Item's SKU image URL."
+                },
+                "DetailUrl": {
+                  "type": "string",
+                  "description": "URL slug of the item."
+                },
+                "AssemblyOptions": {
+                  "type": "array",
+                  "description": "Displays information about assembly options related to the item, if there are any.",
+                  "items": {
+                    "type": "object",
+                    "required": [
+                      "Id",
+                      "Name",
+                      "Required",
+                      "InputValues",
+                      "Composition"
+                    ],
+                    "properties": {
+                      "Id": {
+                        "type": "string",
+                        "description": "ID of the attachment related to the order."
+                      },
+                      "Name": {
+                        "type": "string",
+                        "description": "Name of the attachment related to the order."
+                      },
+                      "Required": {
+                        "type": "boolean",
+                        "description": "Indicates if sending the attachment is required."
+                      },
+                      "InputValues": {
+                        "type": "object",
+                        "nullable": true,
+                        "description": "Displays the attachment's content."
+                      },
+                      "Composition": {
+                        "type": "object",
+                        "nullable": true,
+                        "description": "Displays the attachment's composition."
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
+      "SubscriptionData": {
+        "type": "object",
+        "description": "Information about subscriptions.",
+        "nullable": true,
+        "required": [
+          "SubscriptionGroupId",
+          "Subscriptions"
+        ],
+        "properties": {
+          "SubscriptionGroupId": {
+            "type": "string",
+            "description": "ID of the subscription's group. If this field returns `null` and the `executionCount` is `0`, the order is the first one with subscriptions."
+          },
+          "Subscriptions": {
+            "type": "array",
+            "description": "List with subscriptions and their details.",
+            "nullable": true,
+            "items": {
+              "type": "object",
+              "required": [
+                "ExecutionCount",
+                "PriceAtSubscriptionDate",
+                "ItemIndex",
+                "Plan"
+              ],
+              "properties": {
+                "ExecutionCount": {
+                  "type": "integer",
+                  "description": "Position of the order in the subscription cycle."
+                },
+                "PriceAtSubscriptionDate": {
+                  "type": "number",
+                  "description": "Price of the order at the subscription start date."
+                },
+                "ItemIndex": {
+                  "type": "integer",
+                  "description": "Each item in the subscriptions' order is identified by an index."
+                },
+                "Plan": {
+                  "type": "object",
+                  "description": "Information about the subscription's validity and frequency.",
+                  "required": [
+                    "type",
+                    "frequency",
+                    "validity"
+                  ],
+                  "properties": {
+                    "type": {
+                      "type": "string",
+                      "description": "Type of plan."
+                    },
+                    "frequency": {
+                      "type": "object",
+                      "description": "Information about subscriptions' recurrence.",
+                      "required": [
+                        "periodicity",
+                        "interval"
+                      ],
+                      "properties": {
+                        "periodicity": {
+                          "type": "string",
+                          "description": "Defines the subscriptions recurrence period."
+                        },
+                        "interval": {
+                          "type": "integer",
+                          "description": "Interval between subscription orders, depending on the periodicity."
+                        }
+                      }
+                    },
+                    "validity": {
+                      "type": "object",
+                      "description": "Information about the period during which the subscription will be valid.",
+                      "required": [
+                        "begin",
+                        "end"
+                      ],
+                      "properties": {
+                        "begin": {
+                          "type": "string",
+                          "description": "Subscription's start date in ISO 8601 format."
+                        },
+                        "end": {
+                          "type": "string",
+                          "description": "Subscription's end date in ISO 8601 format."
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
+      "TaxData": {
+        "type": "object",
+        "description": "Order's tax information.",
+        "required": [
+          "areTaxesDesignatedByMarketplace",
+          "taxInfoCollection"
+        ],
+        "properties": {
+          "areTaxesDesignatedByMarketplace": {
+            "type": "boolean",
+            "description": "Indicates if the taxes were designated by the marketplace (`true`) or not (`false`)."
+          },
+          "taxInfoCollection": {
+            "type": "array",
+            "description": "Array with detailed tax information for each item.",
+            "items": {
+              "type": "object",
+              "required": [
+                "itemIndex",
+                "sku",
+                "priceTags"
+              ],
+              "properties": {
+                "itemIndex": {
+                  "type": "integer",
+                  "description": "Index number of the item in the order."
+                },
+                "sku": {
+                  "type": "string",
+                  "description": "Alphanumeric sequence that identifies the item's SKU."
+                },
+                "priceTags": {
+                  "type": "array",
+                  "description": "List of price tags associated with taxes for the item.",
+                  "items": {
+                    "type": "object",
+                    "required": [
+                      "isPercentual",
+                      "name",
+                      "rawValue"
+                    ],
+                    "properties": {
+                      "isPercentual": {
+                        "type": "boolean",
+                        "description": "Indicates if the tax is a percentage (`true`) or a fixed amount (`false`)."
+                      },
+                      "name": {
+                        "type": "string",
+                        "description": "Name of the tax."
+                      },
+                      "rawValue": {
+                        "type": "string",
+                        "description": "Amount associated with the tax, in raw format."
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
+      "CancellationData": {
+        "type": "object",
+        "description": "Information about order cancellation, when it applies.",
+        "required": [
+          "RequestedByUser",
+          "RequestedBySystem",
+          "RequestedBySellerNotification",
+          "RequestedByPaymentNotification",
+          "Reason",
+          "CancellationDate"
+        ],
+        "properties": {
+          "RequestedByUser": {
+            "type": "boolean",
+            "description": "Indicates if the order cancellation was requested by the customer (`true`) or not (`false`)."
+          },
+          "RequestedBySystem": {
+            "type": "boolean",
+            "description": "Indicates if the order cancellation was made by the system (`true`) or not (`false`)."
+          },
+          "RequestedBySellerNotification": {
+            "type": "boolean",
+            "description": "Indicates if the order cancellation was requested by the seller (`true`) or not (`false`)."
+          },
+          "RequestedByPaymentNotification": {
+            "type": "boolean",
+            "description": "Indicates if the order cancellation was requested by the payment gateway (`true`) or not (`false`)."
+          },
+          "Reason": {
+            "type": "string",
+            "description": "The reason provided for the cancellation of the order."
+          },
+          "CancellationDate": {
+            "type": "string",
+            "description": "The date and time when the order was canceled, in ISO 8601 format."
+          }
+        }
+      },
+      "ClientPreferencesData": {
+        "type": "object",
+        "description": "Information about the customer's preferences.",
+        "required": [
+          "locale",
+          "optinNewsLetter"
+        ],
+        "properties": {
+          "locale": {
+            "type": "string",
+            "description": "Customer's preferred language in the store, typically represented by a locale code (e.g., 'en-US')."
+          },
+          "optinNewsLetter": {
+            "type": "boolean",
+            "description": "Indicates if the customer opted to receive newsletters (`true` for yes, `false` for no)."
+          }
+        }
+      },
+      "OrderItem": {
+        "type": "object",
+        "description": "Information about an individual item in the order.",
+        "required": [
+          "uniqueId",
+          "id",
+          "productId",
+          "ean",
+          "lockId",
+          "itemAttachment",
+          "attachments",
+          "quantity",
+          "seller",
+          "name",
+          "refId",
+          "price",
+          "listPrice",
+          "manualPrice",
+          "priceTags",
+          "imageUrl",
+          "detailUrl",
+          "components",
+          "bundleItems",
+          "params",
+          "offerings",
+          "attachmentOfferings",
+          "sellerSku",
+          "priceValidUntil",
+          "commission",
+          "tax",
+          "preSaleDate",
+          "additionalInfo",
+          "measurementUnit",
+          "unitMultiplier",
+          "sellingPrice",
+          "isGift",
+          "shippingPrice",
+          "rewardValue",
+          "freightCommission",
+          "priceDefinitions",
+          "taxCode",
+          "parentItemIndex",
+          "parentAssemblyBinding",
+          "callCenterOperator",
+          "serialNumbers",
+          "assemblies",
+          "costPrice"
+        ],
+        "properties": {
+          "uniqueId": {
+            "type": "string",
+            "description": "Unique identifier for the item in the order."
+          },
+          "id": {
+            "type": "string",
+            "description": "SKU identifier of the item."
+          },
+          "productId": {
+            "type": "string",
+            "description": "Product ID associated with the item."
+          },
+          "ean": {
+            "type": "string",
+            "nullable": true,
+            "description": "European Article Number (EAN) for the item, if applicable."
+          },
+          "lockId": {
+            "type": "string",
+            "description": "Identifier to lock the item in the order."
+          },
+          "itemAttachment": {
+            "type": "object",
+            "description": "Attachment details associated with the item.",
+            "properties": {
+              "content": {
+                "type": "object",
+                "description": "Content of the attachment."
+              },
+              "name": {
+                "type": "string",
+                "nullable": true,
+                "description": "Name of the attachment, if applicable."
+              }
+            }
+          },
+          "attachments": {
+            "type": "array",
+            "items": {
+              "type": "object"
+            },
+            "description": "Additional attachments for the item."
+          },
+          "quantity": {
+            "type": "integer",
+            "description": "Quantity of the item in the order."
+          },
+          "seller": {
+            "type": "string",
+            "description": "Identifier of the seller providing the item."
+          },
+          "name": {
+            "type": "string",
+            "description": "Name of the item as displayed to the customer."
+          },
+          "refId": {
+            "type": "string",
+            "description": "Reference ID for the item."
+          },
+          "price": {
+            "type": "integer",
+            "description": "Price of the item."
+          },
+          "listPrice": {
+            "type": "integer",
+            "description": "List price of the item."
+          },
+          "manualPrice": {
+            "type": "integer",
+            "nullable": true,
+            "description": "Manually defined price for the item, if applicable."
+          },
+          "priceTags": {
+            "type": "array",
+            "items": {
+              "type": "object"
+            },
+            "description": "Tags associated with the pricing of the item."
+          },
+          "imageUrl": {
+            "type": "string",
+            "description": "URL of the item's image."
+          },
+          "detailUrl": {
+            "type": "string",
+            "description": "URL for more details about the item."
+          },
+          "components": {
+            "type": "array",
+            "items": {
+              "type": "object"
+            },
+            "description": "List of components included with the item."
+          },
+          "bundleItems": {
+            "type": "array",
+            "items": {
+              "type": "object"
+            },
+            "description": "Items bundled with this item."
+          },
+          "params": {
+            "type": "array",
+            "items": {
+              "type": "object"
+            },
+            "description": "Parameters associated with the item."
+          },
+          "offerings": {
+            "type": "array",
+            "items": {
+              "type": "object"
+            },
+            "description": "List of offerings related to the item."
+          },
+          "attachmentOfferings": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "type": "string"
+                },
+                "required": {
+                  "type": "boolean"
+                },
+                "schema": {
+                  "type": "object"
+                }
+              }
+            },
+            "description": "Offerings attached to the item."
+          },
+          "sellerSku": {
+            "type": "string",
+            "description": "SKU identifier as defined by the seller."
+          },
+          "priceValidUntil": {
+            "type": "string",
+            "nullable": true,
+            "description": "Date until the price is valid."
+          },
+          "commission": {
+            "type": "integer",
+            "description": "Commission on the item, if applicable."
+          },
+          "tax": {
+            "type": "integer",
+            "description": "Tax applied to the item."
+          },
+          "preSaleDate": {
+            "type": "string",
+            "nullable": true,
+            "description": "Date when the item will be available for sale."
+          },
+          "additionalInfo": {
+            "type": "object",
+            "description": "Additional information about the item.",
+            "properties": {
+              "brandName": {
+                "type": "string",
+                "description": "Name of the brand associated with the item."
+              },
+              "brandId": {
+                "type": "string",
+                "description": "ID of the brand associated with the item."
+              },
+              "categoriesIds": {
+                "type": "string",
+                "description": "String of category IDs associated with the item."
+              },
+              "productClusterId": {
+                "type": "string",
+                "description": "Product cluster ID for the item."
+              },
+              "commercialConditionId": {
+                "type": "string",
+                "description": "ID of the commercial condition associated with the item."
+              },
+              "dimension": {
+                "type": "object",
+                "description": "Dimensions of the item.",
+                "properties": {
+                  "cubicweight": {
+                    "type": "number",
+                    "description": "Cubic weight of the item."
+                  },
+                  "height": {
+                    "type": "number",
+                    "description": "Height of the item."
+                  },
+                  "length": {
+                    "type": "number",
+                    "description": "Length of the item."
+                  },
+                  "weight": {
+                    "type": "number",
+                    "description": "Weight of the item."
+                  },
+                  "width": {
+                    "type": "number",
+                    "description": "Width of the item."
+                  }
+                }
+              },
+              "categories": {
+                "type": "array",
+                "description": "List of categories associated with the item.",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "type": "integer",
+                      "description": "ID of the category."
+                    },
+                    "name": {
+                      "type": "string",
+                      "description": "Name of the category."
+                    }
+                  },
+                  "required": [
+                    "id",
+                    "name"
+                  ]
+                }
+              }
+            }
+          },
+          "measurementUnit": {
+            "type": "string",
+            "description": "Unit of measurement for the item."
+          },
+          "unitMultiplier": {
+            "type": "integer",
+            "description": "Multiplier for the measurement unit."
+          },
+          "sellingPrice": {
+            "type": "integer",
+            "description": "Final selling price of the item."
+          },
+          "isGift": {
+            "type": "boolean",
+            "description": "Indicates if the item is a gift."
+          },
+          "shippingPrice": {
+            "type": "integer",
+            "nullable": true,
+            "description": "Shipping cost for the item, if applicable."
+          },
+          "rewardValue": {
+            "type": "integer",
+            "description": "Reward value associated with the item."
+          },
+          "freightCommission": {
+            "type": "integer",
+            "description": "Freight commission on the item."
+          },
+          "priceDefinitions": {
+            "type": "object",
+            "description": "Detailed information about the item's price structure.",
+            "properties": {
+              "sellingPrices": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "value": {
+                      "type": "integer"
+                    },
+                    "quantity": {
+                      "type": "integer"
+                    }
+                  }
+                }
+              },
+              "calculatedSellingPrice": {
+                "type": "integer"
+              },
+              "total": {
+                "type": "integer"
+              }
+            }
+          },
+          "taxCode": {
+            "type": "string",
+            "nullable": true,
+            "description": "Tax code associated with the item."
+          },
+          "parentItemIndex": {
+            "type": "integer",
+            "nullable": true,
+            "description": "Index of the parent item, if this item is part of a bundle."
+          },
+          "parentAssemblyBinding": {
+            "type": "string",
+            "nullable": true,
+            "description": "Assembly binding of the parent item, if applicable."
+          },
+          "callCenterOperator": {
+            "type": "string",
+            "description": "ID of the call center operator handling the item."
+          },
+          "serialNumbers": {
+            "type": "string",
+            "description": "Serial numbers associated with the item."
+          },
+          "assemblies": {
+            "type": "array",
+            "items": {
+              "type": "object"
+            },
+            "description": "List of assemblies related to the item."
+          },
+          "costPrice": {
+            "type": "integer",
+            "description": "Cost price of the item."
+          }
+        }
+      }
+    },
+    "parameters": {
+      "Content-Type": {
+        "name": "Content-Type",
+        "in": "header",
+        "description": "Type of the content being sent.",
+        "required": true,
+        "style": "simple",
+        "schema": {
+          "type": "string",
+          "default": "application/json"
+        }
+      },
+      "Content-Type-img": {
+        "name": "Content-Type",
+        "in": "header",
+        "description": "Type of the content being sent. If you are uploading an image, use `image/jpg` or `image/png`. When using JavaScript, use `multipart/form-data`.",
+        "required": true,
+        "style": "simple",
+        "schema": {
+          "type": "string",
+          "example": "image/jpg"
+        }
+      },
+      "Accept": {
+        "name": "Accept",
+        "in": "header",
+        "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+        "required": true,
+        "style": "simple",
+        "schema": {
+          "type": "string",
+          "default": "application/vnd.vtex.ds.v10+json"
+        }
+      },
+      "acronym": {
+        "name": "acronym",
+        "in": "path",
+        "description": "Two-letter string that identifies the data entity.",
+        "required": true,
+        "style": "simple",
+        "schema": {
+          "type": "string",
+          "example": "SP"
+        }
+      },
+      "id": {
+        "name": "id",
+        "in": "path",
+        "description": "Unique identifier of the document.",
+        "required": true,
+        "style": "simple",
+        "schema": {
+          "type": "string",
+          "example": "SP-b818cbda-e489-11e6-94f4-0ac138d2d42e"
+        }
+      },
+      "fields": {
+        "name": "_fields",
+        "in": "query",
+        "description": "Names of the fields that will be returned per document, separated by a comma `,`. It is possible to fetch all fields using `_all` as the value of this query parameter. However, in order to avoid permission errors, we strongly recommend informing only the names of the exact fields that will be used.",
+        "required": false,
+        "style": "form",
+        "schema": {
+          "type": "string",
+          "example": "email,firstName,document"
+        }
+      },
+      "_schema": {
+        "name": "_schema",
+        "in": "query",
+        "description": "Name of the [schema](https://developers.vtex.com/docs/guides/master-data-schema-lifecycle) that the document complies with.  This field is required when using `_where` or `_fields` query parameters.",
+        "required": false,
+        "style": "form",
+        "schema": {
+          "type": "string",
+          "example": "schema"
+        }
       }
     }
   },
diff --git a/vtex/utils/types.ts b/vtex/utils/types.ts
index 04e06ac50..354ddd5bf 100644
--- a/vtex/utils/types.ts
+++ b/vtex/utils/types.ts
@@ -1,3 +1,6 @@
+import { PaymentData as PaymentDataOpenAPI } from "./openapi/vcs.openapi.gen.ts";
+import { ChangesAttachment } from "./openapi/vcs.openapi.gen.ts";
+
 /**
  * @format dynamic-options
  * @options vtex/loaders/options/productIdByTerm.ts
@@ -1430,9 +1433,9 @@ export interface OrderItem {
     deniedBySellerReason: string | null;
     cancellationRequestDenyDate: string | null;
   }[] | null;
-  changesAttachment: string;
+  changesAttachment: ChangesAttachment;
   checkedInPickupPointId: string | null;
-  paymentData: PaymentData;
+  paymentData: PaymentDataOpenAPI;
   shippingData: ShippingData;
   clientPreferencesData: ClientPreferencesData;
   clientProfileData: ClientProfileData;

From ce20477d41db164c29f7af0224e2bd7da83ce937 Mon Sep 17 00:00:00 2001
From: guitavano <tavano62@gmail.com>
Date: Wed, 6 Nov 2024 10:25:00 -0300
Subject: [PATCH 19/93] remove logged in if

---
 vtex/loaders/orders/order.ts | 5 -----
 1 file changed, 5 deletions(-)

diff --git a/vtex/loaders/orders/order.ts b/vtex/loaders/orders/order.ts
index e2c968e1b..722131a51 100644
--- a/vtex/loaders/orders/order.ts
+++ b/vtex/loaders/orders/order.ts
@@ -15,11 +15,6 @@ export default async function loader(
   const { vcs } = ctx;
   const { cookie, payload } = parseCookie(req.headers, ctx.account);
 
-  // sub is userEmail
-  if (!payload?.sub || !payload?.userId) {
-    return null;
-  }
-
   const { slug } = props;
 
   const response = await vcs["GET /api/oms/user/orders/:orderId"](

From 8f17ada7b1a84721d8464f256be3e1367cd4a042 Mon Sep 17 00:00:00 2001
From: guitavano <tavano62@gmail.com>
Date: Wed, 6 Nov 2024 13:32:33 -0300
Subject: [PATCH 20/93] add host header

---
 .../intelligentSearch/productListingPage.ts        | 12 ++++++++++--
 website/components/Seo.tsx                         | 14 +++++++++-----
 2 files changed, 19 insertions(+), 7 deletions(-)

diff --git a/vtex/loaders/intelligentSearch/productListingPage.ts b/vtex/loaders/intelligentSearch/productListingPage.ts
index 38bd24557..234e4be9e 100644
--- a/vtex/loaders/intelligentSearch/productListingPage.ts
+++ b/vtex/loaders/intelligentSearch/productListingPage.ts
@@ -291,10 +291,15 @@ const loader = async (
   if (!isInSeachFormat && !pathQuery) {
     return null;
   }
+
   const locale = segment?.payload?.cultureInfo ??
     ctx.defaultSegment?.cultureInfo ?? "pt-BR";
 
   const params = withDefaultParams({ ...searchArgs, page, locale });
+
+  const headers = new Headers();
+  headers.set("host", url.host);
+
   // search products on VTEX. Feel free to change any of these parameters
   const [productsResult, facetsResult] = await Promise.all([
     vcsDeprecated
@@ -303,12 +308,15 @@ const loader = async (
         facets: toPath(selected),
       }, {
         ...STALE,
-        headers: segment ? withSegmentCookie(segment) : undefined,
+        headers: segment ? withSegmentCookie(segment, headers) : headers,
       }).then((res) => res.json()),
     vcsDeprecated["GET /api/io/_v/api/intelligent-search/facets/*facets"]({
       ...params,
       facets: toPath(fselected),
-    }, { ...STALE, headers: segment ? withSegmentCookie(segment) : undefined })
+    }, {
+      ...STALE,
+      headers: segment ? withSegmentCookie(segment, headers) : headers,
+    })
       .then((res) => res.json()),
   ]);
 
diff --git a/website/components/Seo.tsx b/website/components/Seo.tsx
index 1f23ef6ac..6bbbf3284 100644
--- a/website/components/Seo.tsx
+++ b/website/components/Seo.tsx
@@ -63,16 +63,20 @@ function Component({
   return (
     <Head>
       {title && <title>{renderTemplateString(titleTemplate, title)}</title>}
-      {description && <meta
-        name="description"
-        content={renderTemplateString(descriptionTemplate, description)}
-      />}
+      {description && (
+        <meta
+          name="description"
+          content={renderTemplateString(descriptionTemplate, description)}
+        />
+      )}
       {themeColor && <meta name="theme-color" content={themeColor} />}
       {favicon && <link rel="icon" href={favicon} />}
 
       {/* Twitter tags */}
       {title && <meta property="twitter:title" content={title} />}
-      {description && <meta property="twitter:description" content={description} />}
+      {description && (
+        <meta property="twitter:description" content={description} />
+      )}
       {image && <meta property="twitter:image" content={image} />}
       {twitterCard && <meta property="twitter:card" content={twitterCard} />}
 

From 31d25cc2a8912978f3afa2043002df2abf46c6af Mon Sep 17 00:00:00 2001
From: guitavano <tavano62@gmail.com>
Date: Fri, 22 Nov 2024 08:47:06 -0300
Subject: [PATCH 21/93] remove excludePaths feature

---
 vtex/actions/profile/updateProfile.ts |  2 +-
 vtex/loaders/proxy.ts                 | 13 +------------
 2 files changed, 2 insertions(+), 13 deletions(-)

diff --git a/vtex/actions/profile/updateProfile.ts b/vtex/actions/profile/updateProfile.ts
index 17c4f724b..63a520df1 100644
--- a/vtex/actions/profile/updateProfile.ts
+++ b/vtex/actions/profile/updateProfile.ts
@@ -73,7 +73,7 @@ const updateProfile = async (
       givenName: updatedUser?.firstName,
       familyName: updatedUser?.lastName,
       taxID: updatedUser?.document?.replace(/[^\d]/g, ""),
-      gender: updatedUser?.gender === "female"
+      gender: (updatedUser?.gender === "f" || updatedUser?.gender === "female")
         ? "https://schema.org/Female"
         : "https://schema.org/Male",
       telephone: updatedUser?.homePhone,
diff --git a/vtex/loaders/proxy.ts b/vtex/loaders/proxy.ts
index 92f4696dc..57d9c7a06 100644
--- a/vtex/loaders/proxy.ts
+++ b/vtex/loaders/proxy.ts
@@ -30,7 +30,6 @@ const buildProxyRoutes = (
     includeSiteMap,
     generateDecoSiteMap,
     excludePathsFromDecoSiteMap,
-    excludePathsFromVtexProxy,
     includeScriptsToHead,
     includeScriptsToBody,
   }: {
@@ -39,7 +38,6 @@ const buildProxyRoutes = (
     includeSiteMap?: string[];
     generateDecoSiteMap?: boolean;
     excludePathsFromDecoSiteMap: string[];
-    excludePathsFromVtexProxy?: string[];
     includeScriptsToHead?: {
       includes?: Script[];
     };
@@ -86,10 +84,7 @@ const buildProxyRoutes = (
         },
       });
     };
-    const currentPathsToProxy = PATHS_TO_PROXY.filter((path) =>
-      !excludePathsFromVtexProxy?.includes(path)
-    );
-    const routesFromPaths = [...currentPathsToProxy, ...extraPaths].map(
+    const routesFromPaths = [...PATHS_TO_PROXY, ...extraPaths].map(
       routeFromPath,
     );
 
@@ -147,10 +142,6 @@ export interface Props {
    * @title Exclude paths from /deco-sitemap.xml
    */
   excludePathsFromDecoSiteMap?: string[];
-  /**
-   * @title Exclude paths from VTEX PATHS_TO_PROXY
-   */
-  excludePathsFromVtexProxy?: string[];
   /**
    * @title Scripts to include on Html head
    */
@@ -174,7 +165,6 @@ function loader(
     includeSiteMap = [],
     generateDecoSiteMap = true,
     excludePathsFromDecoSiteMap = [],
-    excludePathsFromVtexProxy = [],
     includeScriptsToHead = { includes: [] },
     includeScriptsToBody = { includes: [] },
   }: Props,
@@ -184,7 +174,6 @@ function loader(
   return buildProxyRoutes({
     generateDecoSiteMap,
     excludePathsFromDecoSiteMap,
-    excludePathsFromVtexProxy,
     includeSiteMap,
     publicUrl: ctx.publicUrl,
     extraPaths: extraPathsToProxy,

From a570fe81b1b4dff698a6846a9fac5618ec8c483f Mon Sep 17 00:00:00 2001
From: guitavano <tavano62@gmail.com>
Date: Fri, 22 Nov 2024 08:48:14 -0300
Subject: [PATCH 22/93] remove comment

---
 vtex/loaders/payments/userPayments.ts | 8 --------
 1 file changed, 8 deletions(-)

diff --git a/vtex/loaders/payments/userPayments.ts b/vtex/loaders/payments/userPayments.ts
index 78cd5f2d0..256b84fe4 100644
--- a/vtex/loaders/payments/userPayments.ts
+++ b/vtex/loaders/payments/userPayments.ts
@@ -1,11 +1,3 @@
-// fetch("https://www.als.com/_v/private/graphql/v1?workspace=master&maxAge=long&appsEtag=remove&domain=store&locale=en-US&__bindingId=d8649f18-3877-43de-88e6-c45a81eddc02", {
-// 	"headers": {
-// 		"content-type": "application/json",
-// 	},
-// 	"body": "{\"operationName\":\"Payments\",\"variables\":{},\"extensions\":{\"persistedQuery\":{\"version\":1,\"sha256Hash\":\"95af11127e44f1857144e38f18635e0d085113c3bfdda3e4b8bc99ae63e14e60\",\"sender\":\"vtex.my-cards@1.x\",\"provider\":\"vtex.store-graphql@2.x\"}}}",
-// 	"method": "POST"
-// })
-
 import { AppContext } from "../../mod.ts";
 import { parseCookie } from "../../utils/vtexId.ts";
 

From 37892f0de5fe86ea6bff64ae758124a0d111c01b Mon Sep 17 00:00:00 2001
From: guitavano <tavano62@gmail.com>
Date: Fri, 22 Nov 2024 08:54:13 -0300
Subject: [PATCH 23/93] remove unecessary host

---
 .../loaders/intelligentSearch/productListingPage.ts | 13 ++++---------
 1 file changed, 4 insertions(+), 9 deletions(-)

diff --git a/vtex/loaders/intelligentSearch/productListingPage.ts b/vtex/loaders/intelligentSearch/productListingPage.ts
index 234e4be9e..7972a1fa9 100644
--- a/vtex/loaders/intelligentSearch/productListingPage.ts
+++ b/vtex/loaders/intelligentSearch/productListingPage.ts
@@ -297,9 +297,6 @@ const loader = async (
 
   const params = withDefaultParams({ ...searchArgs, page, locale });
 
-  const headers = new Headers();
-  headers.set("host", url.host);
-
   // search products on VTEX. Feel free to change any of these parameters
   const [productsResult, facetsResult] = await Promise.all([
     vcsDeprecated
@@ -308,15 +305,13 @@ const loader = async (
         facets: toPath(selected),
       }, {
         ...STALE,
-        headers: segment ? withSegmentCookie(segment, headers) : headers,
-      }).then((res) => res.json()),
+        headers: segment ? withSegmentCookie(segment) : undefined,
+      })
+      .then((res) => res.json()),
     vcsDeprecated["GET /api/io/_v/api/intelligent-search/facets/*facets"]({
       ...params,
       facets: toPath(fselected),
-    }, {
-      ...STALE,
-      headers: segment ? withSegmentCookie(segment, headers) : headers,
-    })
+    }, { ...STALE, headers: segment ? withSegmentCookie(segment) : undefined })
       .then((res) => res.json()),
   ]);
 

From 3719958cf14dc4e9a876f271c0566f1f7861887e Mon Sep 17 00:00:00 2001
From: guitavano <tavano62@gmail.com>
Date: Fri, 22 Nov 2024 08:54:42 -0300
Subject: [PATCH 24/93] fix fmt

---
 vtex/loaders/intelligentSearch/productListingPage.ts | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/vtex/loaders/intelligentSearch/productListingPage.ts b/vtex/loaders/intelligentSearch/productListingPage.ts
index 7972a1fa9..8854c193c 100644
--- a/vtex/loaders/intelligentSearch/productListingPage.ts
+++ b/vtex/loaders/intelligentSearch/productListingPage.ts
@@ -306,8 +306,7 @@ const loader = async (
       }, {
         ...STALE,
         headers: segment ? withSegmentCookie(segment) : undefined,
-      })
-      .then((res) => res.json()),
+      }).then((res) => res.json()),
     vcsDeprecated["GET /api/io/_v/api/intelligent-search/facets/*facets"]({
       ...params,
       facets: toPath(fselected),

From 3db894b22fb75b63de9f2586ff5391a7417a78df Mon Sep 17 00:00:00 2001
From: guitavano <tavano62@gmail.com>
Date: Fri, 22 Nov 2024 08:57:51 -0300
Subject: [PATCH 25/93] remove console log

---
 vtex/loaders/address/getAddressByZIP.ts    | 2 +-
 vtex/loaders/profile/passwordLastUpdate.ts | 3 ---
 2 files changed, 1 insertion(+), 4 deletions(-)

diff --git a/vtex/loaders/address/getAddressByZIP.ts b/vtex/loaders/address/getAddressByZIP.ts
index a7f7a1e53..0eac4ac00 100644
--- a/vtex/loaders/address/getAddressByZIP.ts
+++ b/vtex/loaders/address/getAddressByZIP.ts
@@ -42,7 +42,7 @@ export default async function loader(
 
     return addressByPostalCode;
   } catch (error) {
-    console.log(error);
+    console.error(error);
     return {
       postalCode: "",
       city: "",
diff --git a/vtex/loaders/profile/passwordLastUpdate.ts b/vtex/loaders/profile/passwordLastUpdate.ts
index f60d69731..f7ca8adc4 100644
--- a/vtex/loaders/profile/passwordLastUpdate.ts
+++ b/vtex/loaders/profile/passwordLastUpdate.ts
@@ -18,7 +18,6 @@ async function loader(
   if (!payload?.sub || !payload?.userId) {
     return null;
   }
-  console.log({ teste: payload?.userId });
 
   const query = `query getUserProfile { profile { passwordLastUpdate }}`;
 
@@ -28,8 +27,6 @@ async function loader(
       { headers: { cookie } },
     );
 
-    console.log({ profile });
-
     return profile.passwordLastUpdate ?? null;
   } catch (_) {
     return null;

From af7e182af504d06e355b04aa309da7cb67226836 Mon Sep 17 00:00:00 2001
From: guitavano <tavano62@gmail.com>
Date: Sat, 30 Nov 2024 18:50:25 -0300
Subject: [PATCH 26/93] fmt

---
 vtex/loaders/orders/list.ts | 1 +
 1 file changed, 1 insertion(+)

diff --git a/vtex/loaders/orders/list.ts b/vtex/loaders/orders/list.ts
index 2895c267a..d56004974 100644
--- a/vtex/loaders/orders/list.ts
+++ b/vtex/loaders/orders/list.ts
@@ -27,6 +27,7 @@ export default async function loader(
         clientEmail,
         page,
         per_page,
+        includeProfileLastPurchases: true,
       },
       {
         headers: {

From 6a7d36818e7094fd49897ebadee4f7be1bf5ba44 Mon Sep 17 00:00:00 2001
From: marcoferreiradev <mw.marcowilliam@gmail.com>
Date: Fri, 20 Dec 2024 10:25:43 -0300
Subject: [PATCH 27/93] feat: create loader that returns only suggestions based
 on the query

---
 vtex/loaders/intelligentSearch/searches.ts |  29 ++++
 vtex/manifest.gen.ts                       | 150 +++++++++++----------
 2 files changed, 105 insertions(+), 74 deletions(-)
 create mode 100644 vtex/loaders/intelligentSearch/searches.ts

diff --git a/vtex/loaders/intelligentSearch/searches.ts b/vtex/loaders/intelligentSearch/searches.ts
new file mode 100644
index 000000000..07ee2dd34
--- /dev/null
+++ b/vtex/loaders/intelligentSearch/searches.ts
@@ -0,0 +1,29 @@
+import { Suggestion } from "../../../commerce/types.ts";
+import { AppContext } from "../../mod.ts";
+import { getSegmentFromBag, withSegmentCookie } from "../../utils/segment.ts";
+
+export interface Props {
+  query?: string;
+}
+
+export default async function loader(
+  { query }: Props,
+  _req: Request,
+  ctx: AppContext,
+): Promise<Suggestion> {
+  const segment = getSegmentFromBag(ctx);
+  const locale = segment?.payload?.cultureInfo ??
+    ctx.defaultSegment?.cultureInfo ?? "pt-BR";
+
+  return await ctx.vcsDeprecated[
+    "GET /api/io/_v/api/intelligent-search/search_suggestions"
+  ](
+    {
+      locale,
+      query: query ?? "",
+    },
+    {
+      headers: withSegmentCookie(segment),
+    },
+  ).then((res) => res.json());
+}
diff --git a/vtex/manifest.gen.ts b/vtex/manifest.gen.ts
index 1d95b3e79..01d761cca 100644
--- a/vtex/manifest.gen.ts
+++ b/vtex/manifest.gen.ts
@@ -47,43 +47,44 @@ import * as $$$6 from "./loaders/intelligentSearch/productDetailsPage.ts";
 import * as $$$7 from "./loaders/intelligentSearch/productList.ts";
 import * as $$$8 from "./loaders/intelligentSearch/productListingPage.ts";
 import * as $$$9 from "./loaders/intelligentSearch/productSearchValidator.ts";
-import * as $$$10 from "./loaders/intelligentSearch/suggestions.ts";
-import * as $$$11 from "./loaders/intelligentSearch/topsearches.ts";
-import * as $$$12 from "./loaders/legacy/brands.ts";
-import * as $$$13 from "./loaders/legacy/pageType.ts";
-import * as $$$14 from "./loaders/legacy/productDetailsPage.ts";
-import * as $$$15 from "./loaders/legacy/productList.ts";
-import * as $$$16 from "./loaders/legacy/productListingPage.ts";
-import * as $$$17 from "./loaders/legacy/relatedProductsLoader.ts";
-import * as $$$18 from "./loaders/legacy/suggestions.ts";
-import * as $$$19 from "./loaders/logistics/getSalesChannelById.ts";
-import * as $$$20 from "./loaders/logistics/listPickupPoints.ts";
-import * as $$$21 from "./loaders/logistics/listPickupPointsByLocation.ts";
-import * as $$$22 from "./loaders/logistics/listSalesChannelById.ts";
-import * as $$$23 from "./loaders/logistics/listStockByStore.ts";
-import * as $$$24 from "./loaders/masterdata/searchDocuments.ts";
-import * as $$$25 from "./loaders/navbar.ts";
-import * as $$$26 from "./loaders/options/productIdByTerm.ts";
-import * as $$$27 from "./loaders/orders/list.ts";
-import * as $$$28 from "./loaders/orders/order.ts";
-import * as $$$29 from "./loaders/paths/PDPDefaultPath.ts";
-import * as $$$30 from "./loaders/paths/PLPDefaultPath.ts";
-import * as $$$31 from "./loaders/payments/info.ts";
-import * as $$$32 from "./loaders/payments/userPayments.ts";
-import * as $$$33 from "./loaders/product/extend.ts";
-import * as $$$34 from "./loaders/product/extensions/detailsPage.ts";
-import * as $$$35 from "./loaders/product/extensions/list.ts";
-import * as $$$36 from "./loaders/product/extensions/listingPage.ts";
-import * as $$$37 from "./loaders/product/extensions/suggestions.ts";
-import * as $$$38 from "./loaders/product/wishlist.ts";
-import * as $$$39 from "./loaders/profile/passwordLastUpdate.ts";
-import * as $$$40 from "./loaders/promotion/getPromotionById.ts";
-import * as $$$41 from "./loaders/proxy.ts";
-import * as $$$42 from "./loaders/sessions/info.ts";
-import * as $$$43 from "./loaders/user.ts";
-import * as $$$44 from "./loaders/wishlist.ts";
-import * as $$$45 from "./loaders/workflow/product.ts";
-import * as $$$46 from "./loaders/workflow/products.ts";
+import * as $$$10 from "./loaders/intelligentSearch/searches.ts";
+import * as $$$11 from "./loaders/intelligentSearch/suggestions.ts";
+import * as $$$12 from "./loaders/intelligentSearch/topsearches.ts";
+import * as $$$13 from "./loaders/legacy/brands.ts";
+import * as $$$14 from "./loaders/legacy/pageType.ts";
+import * as $$$15 from "./loaders/legacy/productDetailsPage.ts";
+import * as $$$16 from "./loaders/legacy/productList.ts";
+import * as $$$17 from "./loaders/legacy/productListingPage.ts";
+import * as $$$18 from "./loaders/legacy/relatedProductsLoader.ts";
+import * as $$$19 from "./loaders/legacy/suggestions.ts";
+import * as $$$20 from "./loaders/logistics/getSalesChannelById.ts";
+import * as $$$21 from "./loaders/logistics/listPickupPoints.ts";
+import * as $$$22 from "./loaders/logistics/listPickupPointsByLocation.ts";
+import * as $$$23 from "./loaders/logistics/listSalesChannelById.ts";
+import * as $$$24 from "./loaders/logistics/listStockByStore.ts";
+import * as $$$25 from "./loaders/masterdata/searchDocuments.ts";
+import * as $$$26 from "./loaders/navbar.ts";
+import * as $$$27 from "./loaders/options/productIdByTerm.ts";
+import * as $$$28 from "./loaders/orders/list.ts";
+import * as $$$29 from "./loaders/orders/order.ts";
+import * as $$$30 from "./loaders/paths/PDPDefaultPath.ts";
+import * as $$$31 from "./loaders/paths/PLPDefaultPath.ts";
+import * as $$$32 from "./loaders/payments/info.ts";
+import * as $$$33 from "./loaders/payments/userPayments.ts";
+import * as $$$34 from "./loaders/product/extend.ts";
+import * as $$$35 from "./loaders/product/extensions/detailsPage.ts";
+import * as $$$36 from "./loaders/product/extensions/list.ts";
+import * as $$$37 from "./loaders/product/extensions/listingPage.ts";
+import * as $$$38 from "./loaders/product/extensions/suggestions.ts";
+import * as $$$39 from "./loaders/product/wishlist.ts";
+import * as $$$40 from "./loaders/profile/passwordLastUpdate.ts";
+import * as $$$41 from "./loaders/promotion/getPromotionById.ts";
+import * as $$$42 from "./loaders/proxy.ts";
+import * as $$$43 from "./loaders/sessions/info.ts";
+import * as $$$44 from "./loaders/user.ts";
+import * as $$$45 from "./loaders/wishlist.ts";
+import * as $$$46 from "./loaders/workflow/product.ts";
+import * as $$$47 from "./loaders/workflow/products.ts";
 import * as $$$$$$0 from "./sections/Analytics/Vtex.tsx";
 import * as $$$$$$$$$$0 from "./workflows/events.ts";
 import * as $$$$$$$$$$1 from "./workflows/product/index.ts";
@@ -100,43 +101,44 @@ const manifest = {
     "vtex/loaders/intelligentSearch/productList.ts": $$$7,
     "vtex/loaders/intelligentSearch/productListingPage.ts": $$$8,
     "vtex/loaders/intelligentSearch/productSearchValidator.ts": $$$9,
-    "vtex/loaders/intelligentSearch/suggestions.ts": $$$10,
-    "vtex/loaders/intelligentSearch/topsearches.ts": $$$11,
-    "vtex/loaders/legacy/brands.ts": $$$12,
-    "vtex/loaders/legacy/pageType.ts": $$$13,
-    "vtex/loaders/legacy/productDetailsPage.ts": $$$14,
-    "vtex/loaders/legacy/productList.ts": $$$15,
-    "vtex/loaders/legacy/productListingPage.ts": $$$16,
-    "vtex/loaders/legacy/relatedProductsLoader.ts": $$$17,
-    "vtex/loaders/legacy/suggestions.ts": $$$18,
-    "vtex/loaders/logistics/getSalesChannelById.ts": $$$19,
-    "vtex/loaders/logistics/listPickupPoints.ts": $$$20,
-    "vtex/loaders/logistics/listPickupPointsByLocation.ts": $$$21,
-    "vtex/loaders/logistics/listSalesChannelById.ts": $$$22,
-    "vtex/loaders/logistics/listStockByStore.ts": $$$23,
-    "vtex/loaders/masterdata/searchDocuments.ts": $$$24,
-    "vtex/loaders/navbar.ts": $$$25,
-    "vtex/loaders/options/productIdByTerm.ts": $$$26,
-    "vtex/loaders/orders/list.ts": $$$27,
-    "vtex/loaders/orders/order.ts": $$$28,
-    "vtex/loaders/paths/PDPDefaultPath.ts": $$$29,
-    "vtex/loaders/paths/PLPDefaultPath.ts": $$$30,
-    "vtex/loaders/payments/info.ts": $$$31,
-    "vtex/loaders/payments/userPayments.ts": $$$32,
-    "vtex/loaders/product/extend.ts": $$$33,
-    "vtex/loaders/product/extensions/detailsPage.ts": $$$34,
-    "vtex/loaders/product/extensions/list.ts": $$$35,
-    "vtex/loaders/product/extensions/listingPage.ts": $$$36,
-    "vtex/loaders/product/extensions/suggestions.ts": $$$37,
-    "vtex/loaders/product/wishlist.ts": $$$38,
-    "vtex/loaders/profile/passwordLastUpdate.ts": $$$39,
-    "vtex/loaders/promotion/getPromotionById.ts": $$$40,
-    "vtex/loaders/proxy.ts": $$$41,
-    "vtex/loaders/sessions/info.ts": $$$42,
-    "vtex/loaders/user.ts": $$$43,
-    "vtex/loaders/wishlist.ts": $$$44,
-    "vtex/loaders/workflow/product.ts": $$$45,
-    "vtex/loaders/workflow/products.ts": $$$46,
+    "vtex/loaders/intelligentSearch/searches.ts": $$$10,
+    "vtex/loaders/intelligentSearch/suggestions.ts": $$$11,
+    "vtex/loaders/intelligentSearch/topsearches.ts": $$$12,
+    "vtex/loaders/legacy/brands.ts": $$$13,
+    "vtex/loaders/legacy/pageType.ts": $$$14,
+    "vtex/loaders/legacy/productDetailsPage.ts": $$$15,
+    "vtex/loaders/legacy/productList.ts": $$$16,
+    "vtex/loaders/legacy/productListingPage.ts": $$$17,
+    "vtex/loaders/legacy/relatedProductsLoader.ts": $$$18,
+    "vtex/loaders/legacy/suggestions.ts": $$$19,
+    "vtex/loaders/logistics/getSalesChannelById.ts": $$$20,
+    "vtex/loaders/logistics/listPickupPoints.ts": $$$21,
+    "vtex/loaders/logistics/listPickupPointsByLocation.ts": $$$22,
+    "vtex/loaders/logistics/listSalesChannelById.ts": $$$23,
+    "vtex/loaders/logistics/listStockByStore.ts": $$$24,
+    "vtex/loaders/masterdata/searchDocuments.ts": $$$25,
+    "vtex/loaders/navbar.ts": $$$26,
+    "vtex/loaders/options/productIdByTerm.ts": $$$27,
+    "vtex/loaders/orders/list.ts": $$$28,
+    "vtex/loaders/orders/order.ts": $$$29,
+    "vtex/loaders/paths/PDPDefaultPath.ts": $$$30,
+    "vtex/loaders/paths/PLPDefaultPath.ts": $$$31,
+    "vtex/loaders/payments/info.ts": $$$32,
+    "vtex/loaders/payments/userPayments.ts": $$$33,
+    "vtex/loaders/product/extend.ts": $$$34,
+    "vtex/loaders/product/extensions/detailsPage.ts": $$$35,
+    "vtex/loaders/product/extensions/list.ts": $$$36,
+    "vtex/loaders/product/extensions/listingPage.ts": $$$37,
+    "vtex/loaders/product/extensions/suggestions.ts": $$$38,
+    "vtex/loaders/product/wishlist.ts": $$$39,
+    "vtex/loaders/profile/passwordLastUpdate.ts": $$$40,
+    "vtex/loaders/promotion/getPromotionById.ts": $$$41,
+    "vtex/loaders/proxy.ts": $$$42,
+    "vtex/loaders/sessions/info.ts": $$$43,
+    "vtex/loaders/user.ts": $$$44,
+    "vtex/loaders/wishlist.ts": $$$45,
+    "vtex/loaders/workflow/product.ts": $$$46,
+    "vtex/loaders/workflow/products.ts": $$$47,
   },
   "handlers": {
     "vtex/handlers/sitemap.ts": $$$$0,

From 0c195610763627fccda82d5d3f5169c45e18191f Mon Sep 17 00:00:00 2001
From: soutofernando <fernandosoutol45@gmail.com>
Date: Fri, 20 Dec 2024 15:25:31 -0300
Subject: [PATCH 28/93] fix: cancel order

---
 vtex/actions/orders/cancel.ts         |   4 +-
 vtex/utils/client.ts                  |   8 --
 vtex/utils/openapi/vcs.openapi.gen.ts |  64 +++++++++++++++
 vtex/utils/openapi/vcs.openapi.json   | 107 ++++++++++++++++++++++++++
 vtex/utils/types.ts                   |   6 +-
 5 files changed, 176 insertions(+), 13 deletions(-)

diff --git a/vtex/actions/orders/cancel.ts b/vtex/actions/orders/cancel.ts
index 78401327b..ed32f2e3d 100644
--- a/vtex/actions/orders/cancel.ts
+++ b/vtex/actions/orders/cancel.ts
@@ -13,7 +13,7 @@ async function action(
   req: Request,
   ctx: AppContext,
 ): Promise<CanceledOrder | null> {
-  const { vcsDeprecated } = ctx;
+  const { vcs } = ctx;
   const { cookie, payload } = parseCookie(req.headers, ctx.account);
 
   if (!payload?.sub || !payload?.userId) {
@@ -22,7 +22,7 @@ async function action(
 
   const { orderId, reason, requestedByUser } = props;
 
-  const response = await vcsDeprecated
+  const response = await vcs
     ["POST /api/oms/pvt/orders/:orderId/cancel"](
       { orderId },
       {
diff --git a/vtex/utils/client.ts b/vtex/utils/client.ts
index afe62a9ba..b66360953 100644
--- a/vtex/utils/client.ts
+++ b/vtex/utils/client.ts
@@ -1,7 +1,6 @@
 import { Userorderslist } from "./openapi/vcs.openapi.gen.ts";
 import {
   Brand,
-  CanceledOrder,
   Category,
   CreateNewDocument,
   FacetSearchResult,
@@ -257,13 +256,6 @@ export interface VTEXCommerceStable {
   "GET /api/oms/user/orders/:orderId": {
     response: OrderItem;
   };
-  "POST /api/oms/pvt/orders/:orderId/cancel": {
-    response: CanceledOrder;
-    body: {
-      reason: string;
-      requestedByUser: boolean;
-    };
-  };
 }
 
 export interface SP {
diff --git a/vtex/utils/openapi/vcs.openapi.gen.ts b/vtex/utils/openapi/vcs.openapi.gen.ts
index 29f7b5b58..24e4d5418 100644
--- a/vtex/utils/openapi/vcs.openapi.gen.ts
+++ b/vtex/utils/openapi/vcs.openapi.gen.ts
@@ -17822,6 +17822,70 @@ ascending?: boolean
 }
 }
 }
+/**
+ * Cancels an order using its identification code (`orderId`). A common scenario is when the seller has a problem fulfilling the order and requests the marketplace to cancel it. 
+ * 
+ * ## Orders that cannot be canceled 
+ * 
+ * The following situations do not allow order cancellation: 
+ * 
+ * - **Partial invoices:** [Partially invoiced](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe) orders cannot be canceled. However, the customer can [change the order](https://developers.vtex.com/docs/guides/change-order) to replace or remove items from it. 
+ * 
+ * - **Invoiced status:** Orders with `invoiced` [status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196) cannot be canceled. If the order has already been invoiced, you can use the [Order invoice notification](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/invoice) endpoint to generate a return invoice. 
+ * 
+ * - **Incomplete orders:** [Incomplete orders](https://help.vtex.com/en/tutorial/how-incomplete-orders-work--tutorials_294) cannot be canceled. 
+ * 
+ * ## Declining order cancelation 
+ * 
+ * The order flow has a cancellation window (grace period) in which the customer can automatically cancel the order. Except for that period, the seller can [decline an order cancellation request](https://help.vtex.com/en/tutorial/declining-order-cancelation--F2n0h1TeQ5td540Gjyff4), regardless of whether the customer or the marketplace initiated it. 
+ * 
+ * For more information, see [Order canceling improvements](https://developers.vtex.com/docs/guides/order-canceling-improvements). 
+ * 
+ * ## Permissions
+ * 
+ * Any user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | OMS | OMS access | **Cancel order** | 
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | OMS - Full access | Cancel order |
+ * | IntegrationProfile - Fulfillment Oms | Cancel order |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). 
+ * 
+ * To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"POST /api/oms/pvt/orders/:orderId/cancel": {
+body: {
+/**
+ * Reason for cancelling the order.
+ */
+reason?: string
+/**
+ * If requested by the user
+ */
+requestedByUser?: boolean
+}
+response: {
+/**
+ * Date and time when the notification was received.
+ */
+date?: string
+/**
+ * Identification of the order in the seller.
+ */
+orderId?: string
+/**
+ * Protocol code generated by the update. It may be `null`.
+ */
+receipt?: string
+}
+}
 /**
  * Retrieves information on pickup points close to a given location determined by geocoordinates or postal code.
  * 
diff --git a/vtex/utils/openapi/vcs.openapi.json b/vtex/utils/openapi/vcs.openapi.json
index b8b013298..ccf0dd933 100644
--- a/vtex/utils/openapi/vcs.openapi.json
+++ b/vtex/utils/openapi/vcs.openapi.json
@@ -35225,6 +35225,113 @@
         "deprecated": false
       }
     },
+    "/api/oms/pvt/orders/{orderId}/cancel": {
+      "post": {
+        "tags": [
+          "Orders"
+        ],
+        "summary": "Cancel order",
+        "description": "Cancels an order using its identification code (`orderId`). A common scenario is when the seller has a problem fulfilling the order and requests the marketplace to cancel it. \r\n\r\n## Orders that cannot be canceled \r\n\r\nThe following situations do not allow order cancellation: \r\n\r\n- **Partial invoices:** [Partially invoiced](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe) orders cannot be canceled. However, the customer can [change the order](https://developers.vtex.com/docs/guides/change-order) to replace or remove items from it. \r\n\r\n- **Invoiced status:** Orders with `invoiced` [status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196) cannot be canceled. If the order has already been invoiced, you can use the [Order invoice notification](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/invoice) endpoint to generate a return invoice. \r\n\r\n- **Incomplete orders:** [Incomplete orders](https://help.vtex.com/en/tutorial/how-incomplete-orders-work--tutorials_294) cannot be canceled. \r\n\r\n## Declining order cancelation \r\n\r\nThe order flow has a cancellation window (grace period) in which the customer can automatically cancel the order. Except for that period, the seller can [decline an order cancellation request](https://help.vtex.com/en/tutorial/declining-order-cancelation--F2n0h1TeQ5td540Gjyff4), regardless of whether the customer or the marketplace initiated it. \r\n\r\nFor more information, see [Order canceling improvements](https://developers.vtex.com/docs/guides/order-canceling-improvements). \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **Cancel order** | \r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| OMS - Full access | Cancel order |\r\n| IntegrationProfile - Fulfillment Oms | Cancel order |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). \r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "CancelOrder",
+        "parameters": [
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Describes the type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "orderId",
+            "in": "path",
+            "description": "ID that identifies the order in the seller.",
+            "example": "1172452900788-01",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "1172452900788-01"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "reason": {
+                    "type": "string",
+                    "description": "Reason for cancelling the order.",
+                    "example": "Unexpected stock shortage"
+                  },
+                  "requestedByUser": {
+                    "type": "boolean",
+                    "description": "If requested by the user",
+                    "example": "User canceled the order "
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "date": {
+                      "type": "string",
+                      "description": "Date and time when the notification was received."
+                    },
+                    "orderId": {
+                      "type": "string",
+                      "description": "Identification of the order in the seller."
+                    },
+                    "receipt": {
+                      "type": "string",
+                      "description": "Protocol code generated by the update. It may be `null`."
+                    }
+                  }
+                },
+                "example": {
+                  "date": "2024-02-07T15:22:56.7612218-02:00",
+                  "orderId": "123543123",
+                  "receipt": "38e0e47da2934847b489216d208cfd91"
+                }
+              }
+            }
+          },
+          "429": {
+            "description": "Too many requests."
+          },
+          "403": {
+            "description": "The credentials are not enabled to access the service."
+          },
+          "404": {
+            "description": "Value not found."
+          }
+        }
+      }
+    },
     "/api/checkout/pub/pickup-points": {
       "get": {
         "tags": [
diff --git a/vtex/utils/types.ts b/vtex/utils/types.ts
index 354ddd5bf..10ea37b3a 100644
--- a/vtex/utils/types.ts
+++ b/vtex/utils/types.ts
@@ -1472,9 +1472,9 @@ export interface OrderItem {
 }
 
 export interface CanceledOrder {
-  date: string;
-  orderId: string;
-  receipt: string | null;
+  date?: string;
+  orderId?: string;
+  receipt?: string | null;
 }
 
 interface Marketplace {

From d6a8eec2a5b6703b7ec08ddf777b760b042c453e Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Wed, 12 Mar 2025 10:30:38 -0400
Subject: [PATCH 29/93] fix: sanitize IS sort param

---
 .../intelligentSearch/productListingPage.ts     | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/vtex/loaders/intelligentSearch/productListingPage.ts b/vtex/loaders/intelligentSearch/productListingPage.ts
index 8854c193c..3d163f4a3 100644
--- a/vtex/loaders/intelligentSearch/productListingPage.ts
+++ b/vtex/loaders/intelligentSearch/productListingPage.ts
@@ -63,6 +63,18 @@ const LEGACY_TO_IS: Record<string, Sort> = {
   OrderByReleaseDateDESC: "release:desc",
   OrderByBestDiscountDESC: "discount:desc",
 };
+
+const sortValues = [
+  "price:desc",
+  "price:asc",
+  "orders:desc",
+  "name:desc",
+  "name:asc",
+  "release:desc",
+  "discount:desc",
+  "relevance:desc",
+];
+
 export const mapLabelledFuzzyToFuzzy = (
   labelledFuzzy?: LabelledFuzzy,
 ): Fuzzy | undefined => {
@@ -162,10 +174,13 @@ const searchArgsOf = (props: Props, url: URL) => {
         : 0,
       VTEX_MAX_PAGES - currentPageoffset,
     );
-  const sort = (url.searchParams.get("sort") as Sort) ??
+  let sort = (url.searchParams.get("sort") as Sort) ??
     LEGACY_TO_IS[url.searchParams.get("O") ?? ""] ??
     props.sort ??
     sortOptions[0].value;
+  if (!sort || !sortValues.includes(sort)) {
+    sort = sortOptions[0].value as Sort;
+  }
   const selectedFacets = mergeFacets(
     props.selectedFacets ?? [],
     filtersFromURL(url),

From 1b22b54fff8de0a617c325933b3eb8ef821457f3 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Wed, 16 Apr 2025 22:24:30 -0400
Subject: [PATCH 30/93] feat: add get user order by id loader

---
 vtex/loaders/orders/getUserOrderById.ts | 27 ++++++++++
 vtex/utils/client.ts                    |  4 ++
 vtex/utils/types.ts                     | 65 +++++++++++++++++++++++++
 vtex/utils/vtexId.ts                    | 18 +++----
 4 files changed, 104 insertions(+), 10 deletions(-)
 create mode 100644 vtex/loaders/orders/getUserOrderById.ts

diff --git a/vtex/loaders/orders/getUserOrderById.ts b/vtex/loaders/orders/getUserOrderById.ts
new file mode 100644
index 000000000..303c75064
--- /dev/null
+++ b/vtex/loaders/orders/getUserOrderById.ts
@@ -0,0 +1,27 @@
+import { AppContext } from "../../mod.ts";
+import { parseCookie } from "../../utils/vtexId.ts";
+
+interface Props {
+  orderId: string;
+}
+
+/**
+ * @title VTEX - Get User Order By Id
+ * @description Gets user order by id, the user must be authenticated or have access to the order
+ */
+export default async function loader(
+  { orderId }: Props,
+  req: Request,
+  ctx: AppContext,
+) {
+  const { vcsDeprecated } = ctx;
+  const { cookie } = parseCookie(req.headers, ctx.account);
+
+  const order = await vcsDeprecated["GET /api/checkout/pub/orders/:orderId"]({
+    orderId,
+  }, {
+    headers: { cookie },
+  }).then((res) => res.json());
+
+  return order;
+}
diff --git a/vtex/utils/client.ts b/vtex/utils/client.ts
index b66360953..6a0a756cc 100644
--- a/vtex/utils/client.ts
+++ b/vtex/utils/client.ts
@@ -10,6 +10,7 @@ import {
   LegacySort,
   OrderForm,
   OrderItem,
+  OrderPlaced,
   PageType,
   PortalSuggestion,
   ProductSearchResult,
@@ -21,6 +22,9 @@ import {
 } from "./types.ts";
 
 export interface VTEXCommerceStable {
+  "GET /api/checkout/pub/orders/:orderId": {
+    response: OrderPlaced;
+  };
   "POST /api/checkout/pub/orderForm/:orderFormId/messages/clear": {
     // deno-lint-ignore no-explicit-any
     body: Record<any, never>;
diff --git a/vtex/utils/types.ts b/vtex/utils/types.ts
index 10ea37b3a..dd84e249b 100644
--- a/vtex/utils/types.ts
+++ b/vtex/utils/types.ts
@@ -1477,6 +1477,71 @@ export interface CanceledOrder {
   receipt?: string | null;
 }
 
+interface OrderPlacedSeller {
+  id: string;
+  name: string;
+  logo: string;
+}
+
+export interface OrderPlaced {
+  sellers: OrderPlacedSeller[];
+  orderId: string;
+  orderGroup: string;
+  state: string;
+  isCheckedIn: boolean;
+  sellerOrderId: string;
+  storeId: string | null;
+  checkedInPickupPointId: string | null;
+  value: number;
+  items: OrderFormItem[];
+  totals: Total[];
+  clientProfileData: ClientProfileData;
+  ratesAndBenefitsData: RatesAndBenefitsData;
+  shippingData: ShippingData;
+  paymentData: PaymentData;
+  clientPreferencesData: ClientPreferencesData;
+  commercialConditionData: null;
+  giftRegistryData: null;
+  marketingData: MarketingData | null;
+  storePreferencesData: StorePreferencesData;
+  openTextField: null;
+  invoiceData: null;
+  itemMetadata: ItemMetadata;
+  taxData: null;
+  customData: null;
+  hooksData: null;
+  changeData: null;
+  subscriptionData: null;
+  merchantContextData: null;
+  purchaseAgentData: null;
+  salesChannel: string;
+  followUpEmail: string;
+  creationDate: string;
+  lastChange: string;
+  timeZoneCreationDate: string;
+  timeZoneLastChange: string;
+  isCompleted: boolean;
+  hostName: string;
+  merchantName: string | null;
+  userType: string;
+  roundingError: number;
+  allowEdition: boolean;
+  allowCancellation: boolean;
+  isUserDataVisible: boolean;
+  cancellationData: CancelattionData;
+  orderFormCreationDate: string;
+  marketplaceRequestedCancellationWindow: null;
+}
+
+interface CancelattionData {
+  requestedByUser: true;
+  reason: string;
+  cancellationDate: string;
+  cancellationRequestId: string;
+  requestedBy: null;
+  cancellationSource: null;
+}
+
 interface Marketplace {
   baseURL: string;
   // deno-lint-ignore no-explicit-any
diff --git a/vtex/utils/vtexId.ts b/vtex/utils/vtexId.ts
index 51f367a94..2dec534ef 100644
--- a/vtex/utils/vtexId.ts
+++ b/vtex/utils/vtexId.ts
@@ -3,6 +3,7 @@ import { decode } from "https://deno.land/x/djwt@v2.8/mod.ts";
 import { stringify } from "./cookies.ts";
 
 export const VTEX_ID_CLIENT_COOKIE = "VtexIdclientAutCookie";
+export const CHECKOUT_DATA_ACCESS_COOKIE = "CheckoutDataAccess";
 
 interface CookiePayload {
   sub: string; // user email
@@ -14,7 +15,12 @@ interface CookiePayload {
 }
 
 export const parseCookie = (headers: Headers, account: string) => {
-  const cookies = getCookies(headers);
+  const cookies = Object.fromEntries(
+    Object.entries(getCookies(headers)).filter(([key]) =>
+      key.startsWith(VTEX_ID_CLIENT_COOKIE) ||
+      key.startsWith(CHECKOUT_DATA_ACCESS_COOKIE)
+    ),
+  );
   const cookie = cookies[VTEX_ID_CLIENT_COOKIE] ||
     cookies[`${VTEX_ID_CLIENT_COOKIE}_${account}`];
   const decoded = cookie ? decode(cookie) : null;
@@ -22,15 +28,7 @@ export const parseCookie = (headers: Headers, account: string) => {
   const payload = decoded?.[1] as CookiePayload | undefined;
 
   return {
-    cookie: stringify({
-      ...(cookies[VTEX_ID_CLIENT_COOKIE] &&
-        { [VTEX_ID_CLIENT_COOKIE]: cookies[VTEX_ID_CLIENT_COOKIE] }),
-      ...(cookies[`${VTEX_ID_CLIENT_COOKIE}_${account}`] &&
-        {
-          [`${VTEX_ID_CLIENT_COOKIE}_${account}`]:
-            cookies[`${VTEX_ID_CLIENT_COOKIE}_${account}`],
-        }),
-    }),
+    cookie: stringify(cookies),
     payload,
   };
 };

From 7bdfd8cba64ac400fbe9f5c443cc0e0533005c91 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Wed, 16 Apr 2025 22:41:32 -0400
Subject: [PATCH 31/93] fix: build manifest

---
 vtex/manifest.gen.ts | 82 +++++++++++++++++++++++---------------------
 1 file changed, 42 insertions(+), 40 deletions(-)

diff --git a/vtex/manifest.gen.ts b/vtex/manifest.gen.ts
index 01d761cca..cbff42f0c 100644
--- a/vtex/manifest.gen.ts
+++ b/vtex/manifest.gen.ts
@@ -65,26 +65,27 @@ import * as $$$24 from "./loaders/logistics/listStockByStore.ts";
 import * as $$$25 from "./loaders/masterdata/searchDocuments.ts";
 import * as $$$26 from "./loaders/navbar.ts";
 import * as $$$27 from "./loaders/options/productIdByTerm.ts";
-import * as $$$28 from "./loaders/orders/list.ts";
-import * as $$$29 from "./loaders/orders/order.ts";
-import * as $$$30 from "./loaders/paths/PDPDefaultPath.ts";
-import * as $$$31 from "./loaders/paths/PLPDefaultPath.ts";
-import * as $$$32 from "./loaders/payments/info.ts";
-import * as $$$33 from "./loaders/payments/userPayments.ts";
-import * as $$$34 from "./loaders/product/extend.ts";
-import * as $$$35 from "./loaders/product/extensions/detailsPage.ts";
-import * as $$$36 from "./loaders/product/extensions/list.ts";
-import * as $$$37 from "./loaders/product/extensions/listingPage.ts";
-import * as $$$38 from "./loaders/product/extensions/suggestions.ts";
-import * as $$$39 from "./loaders/product/wishlist.ts";
-import * as $$$40 from "./loaders/profile/passwordLastUpdate.ts";
-import * as $$$41 from "./loaders/promotion/getPromotionById.ts";
-import * as $$$42 from "./loaders/proxy.ts";
-import * as $$$43 from "./loaders/sessions/info.ts";
-import * as $$$44 from "./loaders/user.ts";
-import * as $$$45 from "./loaders/wishlist.ts";
-import * as $$$46 from "./loaders/workflow/product.ts";
-import * as $$$47 from "./loaders/workflow/products.ts";
+import * as $$$28 from "./loaders/orders/getUserOrderById.ts";
+import * as $$$29 from "./loaders/orders/list.ts";
+import * as $$$30 from "./loaders/orders/order.ts";
+import * as $$$31 from "./loaders/paths/PDPDefaultPath.ts";
+import * as $$$32 from "./loaders/paths/PLPDefaultPath.ts";
+import * as $$$33 from "./loaders/payments/info.ts";
+import * as $$$34 from "./loaders/payments/userPayments.ts";
+import * as $$$35 from "./loaders/product/extend.ts";
+import * as $$$36 from "./loaders/product/extensions/detailsPage.ts";
+import * as $$$37 from "./loaders/product/extensions/list.ts";
+import * as $$$38 from "./loaders/product/extensions/listingPage.ts";
+import * as $$$39 from "./loaders/product/extensions/suggestions.ts";
+import * as $$$40 from "./loaders/product/wishlist.ts";
+import * as $$$41 from "./loaders/profile/passwordLastUpdate.ts";
+import * as $$$42 from "./loaders/promotion/getPromotionById.ts";
+import * as $$$43 from "./loaders/proxy.ts";
+import * as $$$44 from "./loaders/sessions/info.ts";
+import * as $$$45 from "./loaders/user.ts";
+import * as $$$46 from "./loaders/wishlist.ts";
+import * as $$$47 from "./loaders/workflow/product.ts";
+import * as $$$48 from "./loaders/workflow/products.ts";
 import * as $$$$$$0 from "./sections/Analytics/Vtex.tsx";
 import * as $$$$$$$$$$0 from "./workflows/events.ts";
 import * as $$$$$$$$$$1 from "./workflows/product/index.ts";
@@ -119,26 +120,27 @@ const manifest = {
     "vtex/loaders/masterdata/searchDocuments.ts": $$$25,
     "vtex/loaders/navbar.ts": $$$26,
     "vtex/loaders/options/productIdByTerm.ts": $$$27,
-    "vtex/loaders/orders/list.ts": $$$28,
-    "vtex/loaders/orders/order.ts": $$$29,
-    "vtex/loaders/paths/PDPDefaultPath.ts": $$$30,
-    "vtex/loaders/paths/PLPDefaultPath.ts": $$$31,
-    "vtex/loaders/payments/info.ts": $$$32,
-    "vtex/loaders/payments/userPayments.ts": $$$33,
-    "vtex/loaders/product/extend.ts": $$$34,
-    "vtex/loaders/product/extensions/detailsPage.ts": $$$35,
-    "vtex/loaders/product/extensions/list.ts": $$$36,
-    "vtex/loaders/product/extensions/listingPage.ts": $$$37,
-    "vtex/loaders/product/extensions/suggestions.ts": $$$38,
-    "vtex/loaders/product/wishlist.ts": $$$39,
-    "vtex/loaders/profile/passwordLastUpdate.ts": $$$40,
-    "vtex/loaders/promotion/getPromotionById.ts": $$$41,
-    "vtex/loaders/proxy.ts": $$$42,
-    "vtex/loaders/sessions/info.ts": $$$43,
-    "vtex/loaders/user.ts": $$$44,
-    "vtex/loaders/wishlist.ts": $$$45,
-    "vtex/loaders/workflow/product.ts": $$$46,
-    "vtex/loaders/workflow/products.ts": $$$47,
+    "vtex/loaders/orders/getUserOrderById.ts": $$$28,
+    "vtex/loaders/orders/list.ts": $$$29,
+    "vtex/loaders/orders/order.ts": $$$30,
+    "vtex/loaders/paths/PDPDefaultPath.ts": $$$31,
+    "vtex/loaders/paths/PLPDefaultPath.ts": $$$32,
+    "vtex/loaders/payments/info.ts": $$$33,
+    "vtex/loaders/payments/userPayments.ts": $$$34,
+    "vtex/loaders/product/extend.ts": $$$35,
+    "vtex/loaders/product/extensions/detailsPage.ts": $$$36,
+    "vtex/loaders/product/extensions/list.ts": $$$37,
+    "vtex/loaders/product/extensions/listingPage.ts": $$$38,
+    "vtex/loaders/product/extensions/suggestions.ts": $$$39,
+    "vtex/loaders/product/wishlist.ts": $$$40,
+    "vtex/loaders/profile/passwordLastUpdate.ts": $$$41,
+    "vtex/loaders/promotion/getPromotionById.ts": $$$42,
+    "vtex/loaders/proxy.ts": $$$43,
+    "vtex/loaders/sessions/info.ts": $$$44,
+    "vtex/loaders/user.ts": $$$45,
+    "vtex/loaders/wishlist.ts": $$$46,
+    "vtex/loaders/workflow/product.ts": $$$47,
+    "vtex/loaders/workflow/products.ts": $$$48,
   },
   "handlers": {
     "vtex/handlers/sitemap.ts": $$$$0,

From 421649fab92252bd2451cb89d4c4a021ab763839 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Thu, 17 Apr 2025 00:31:27 -0400
Subject: [PATCH 32/93] feat: send more cookies to vtex requests

---
 vtex/utils/vtexId.ts | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/vtex/utils/vtexId.ts b/vtex/utils/vtexId.ts
index 2dec534ef..eae0fd27b 100644
--- a/vtex/utils/vtexId.ts
+++ b/vtex/utils/vtexId.ts
@@ -4,6 +4,7 @@ import { stringify } from "./cookies.ts";
 
 export const VTEX_ID_CLIENT_COOKIE = "VtexIdclientAutCookie";
 export const CHECKOUT_DATA_ACCESS_COOKIE = "CheckoutDataAccess";
+export const VTEX_CHKO_AUTH = "Vtex_CHKO_Auth";
 
 interface CookiePayload {
   sub: string; // user email
@@ -18,7 +19,8 @@ export const parseCookie = (headers: Headers, account: string) => {
   const cookies = Object.fromEntries(
     Object.entries(getCookies(headers)).filter(([key]) =>
       key.startsWith(VTEX_ID_CLIENT_COOKIE) ||
-      key.startsWith(CHECKOUT_DATA_ACCESS_COOKIE)
+      key.startsWith(CHECKOUT_DATA_ACCESS_COOKIE) ||
+      key.startsWith(VTEX_CHKO_AUTH)
     ),
   );
   const cookie = cookies[VTEX_ID_CLIENT_COOKIE] ||

From a3afc8977cac332984688538511063af1608531a Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Thu, 17 Apr 2025 18:44:55 -0400
Subject: [PATCH 33/93] feat: add security layer to order api

---
 vtex/loaders/orders/order.ts | 23 +++++++++++++++++------
 1 file changed, 17 insertions(+), 6 deletions(-)

diff --git a/vtex/loaders/orders/order.ts b/vtex/loaders/orders/order.ts
index 722131a51..dc340588b 100644
--- a/vtex/loaders/orders/order.ts
+++ b/vtex/loaders/orders/order.ts
@@ -1,3 +1,4 @@
+import { HttpError } from "@deco/deco";
 import { RequestURLParam } from "../../../website/functions/requestToParam.ts";
 import { AppContext } from "../../mod.ts";
 import { Userorderdetails } from "../../utils/openapi/vcs.openapi.gen.ts";
@@ -13,14 +14,19 @@ export default async function loader(
   ctx: AppContext,
 ): Promise<Userorderdetails | null> {
   const { vcs } = ctx;
-  const { cookie, payload } = parseCookie(req.headers, ctx.account);
+  const { cookie } = parseCookie(req.headers, ctx.account);
 
   const { slug } = props;
 
+  const user = await ctx.invoke.vtex.loaders.user();
+  if (!user) {
+    throw new HttpError(new Response("Unauthorized", { status: 403 }));
+  }
+
   const response = await vcs["GET /api/oms/user/orders/:orderId"](
     {
       orderId: slug.includes("-") ? slug : slug + "-01",
-      clientEmail: payload?.sub,
+      clientEmail: user.email,
     },
     {
       headers: {
@@ -29,10 +35,15 @@ export default async function loader(
     },
   );
 
-  if (response.ok) {
-    const order = await response.json();
-    return order;
+  if (!response.ok) {
+    throw new Error(`Failed to get order: ${response.status} ${response.statusText}`);
+  }
+
+  const order = await response.json();
+  
+  if (order.clientProfileData?.email !== user.email) {
+    throw new HttpError(new Response("Unauthorized", { status: 403 }));
   }
 
-  return null;
+  return order;
 }

From b48f9c23603616f0f9f6acf977b4b3ea8f7d14e2 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Mon, 12 May 2025 11:01:01 -0400
Subject: [PATCH 34/93] idk anymore

---
 .../{getUserOrderById.ts => getById.ts}       |  20 ++-
 vtex/loaders/orders/orderplaced.ts            |  42 +++++
 vtex/utils/client.ts                          |  16 +-
 vtex/utils/cookies.ts                         |   3 +
 vtex/utils/types.ts                           | 167 ++++++++++++++++++
 5 files changed, 234 insertions(+), 14 deletions(-)
 rename vtex/loaders/orders/{getUserOrderById.ts => getById.ts} (55%)
 create mode 100644 vtex/loaders/orders/orderplaced.ts

diff --git a/vtex/loaders/orders/getUserOrderById.ts b/vtex/loaders/orders/getById.ts
similarity index 55%
rename from vtex/loaders/orders/getUserOrderById.ts
rename to vtex/loaders/orders/getById.ts
index 303c75064..f946604e3 100644
--- a/vtex/loaders/orders/getUserOrderById.ts
+++ b/vtex/loaders/orders/getById.ts
@@ -7,7 +7,7 @@ interface Props {
 
 /**
  * @title VTEX - Get User Order By Id
- * @description Gets user order by id, the user must be authenticated or have access to the order
+ * @description The user must be authenticated or have OMS permissions to access this endpoint
  */
 export default async function loader(
   { orderId }: Props,
@@ -17,11 +17,17 @@ export default async function loader(
   const { vcsDeprecated } = ctx;
   const { cookie } = parseCookie(req.headers, ctx.account);
 
-  const order = await vcsDeprecated["GET /api/checkout/pub/orders/:orderId"]({
-    orderId,
-  }, {
-    headers: { cookie },
-  }).then((res) => res.json());
+  const order = await vcsDeprecated["GET /api/oms/user/orders/:orderId"](
+    {
+      orderId,
+    },
+    {
+      headers: {
+        cookie,
+        accept: "application/json",
+      },
+    },
+  ).then((res) => res.json());
 
   return order;
-}
+}
\ No newline at end of file
diff --git a/vtex/loaders/orders/orderplaced.ts b/vtex/loaders/orders/orderplaced.ts
new file mode 100644
index 000000000..dc53f9f1e
--- /dev/null
+++ b/vtex/loaders/orders/orderplaced.ts
@@ -0,0 +1,42 @@
+import { getCookies } from "@std/http";
+import { stringify } from "node:querystring";
+import { AppContext } from "../../mod.ts";
+import {
+  CHECKOUT_DATA_ACCESS_COOKIE,
+  VTEX_CHKO_AUTH,
+} from "../../utils/cookies.ts";
+import { VTEX_ID_CLIENT_COOKIE } from "../../utils/vtexId.ts";
+
+interface Props {
+  orderId: string;
+}
+
+/**
+ * @title VTEX - Get Order Placed Order Details
+ * @description Should be used on order placed page, the user must be authenticated or have access to the order through permissions or cookies
+ */
+export default async function loader(
+  { orderId }: Props,
+  req: Request,
+  ctx: AppContext,
+) {
+  const { vcsDeprecated } = ctx;
+  const cookies = Object.fromEntries(
+    Object.entries(getCookies(req.headers)).filter(([key]) =>
+      key.startsWith(VTEX_ID_CLIENT_COOKIE) ||
+      // these two cookies are set by VTEX after order is placed on checkout and are
+      // used to access the order placed page
+      key === CHECKOUT_DATA_ACCESS_COOKIE ||
+      key === VTEX_CHKO_AUTH
+    ),
+  );
+  const cookie = stringify(cookies);
+
+  const order = await vcsDeprecated["GET /api/checkout/pub/orders/:orderId"]({
+    orderId,
+  }, {
+    headers: { cookie },
+  }).then((res) => res.json());
+
+  return order;
+}
\ No newline at end of file
diff --git a/vtex/utils/client.ts b/vtex/utils/client.ts
index 6a0a756cc..fe1897c59 100644
--- a/vtex/utils/client.ts
+++ b/vtex/utils/client.ts
@@ -1,4 +1,4 @@
-import { Userorderslist } from "./openapi/vcs.openapi.gen.ts";
+import { Userorderdetails, Userorderslist } from "./openapi/vcs.openapi.gen.ts";
 import {
   Brand,
   Category,
@@ -9,8 +9,7 @@ import {
   LegacyProduct,
   LegacySort,
   OrderForm,
-  OrderItem,
-  OrderPlaced,
+  OrderFormOrder,
   PageType,
   PortalSuggestion,
   ProductSearchResult,
@@ -22,9 +21,6 @@ import {
 } from "./types.ts";
 
 export interface VTEXCommerceStable {
-  "GET /api/checkout/pub/orders/:orderId": {
-    response: OrderPlaced;
-  };
   "POST /api/checkout/pub/orderForm/:orderFormId/messages/clear": {
     // deno-lint-ignore no-explicit-any
     body: Record<any, never>;
@@ -258,7 +254,13 @@ export interface VTEXCommerceStable {
     response: Userorderslist;
   };
   "GET /api/oms/user/orders/:orderId": {
-    response: OrderItem;
+    response: Userorderdetails;
+  };
+  "GET /api/checkout/pub/orders/:orderId": {
+    response: OrderFormOrder;
+  };
+  "GET /api/checkout/pub/orders/order-group/:orderGroupId": {
+    response: OrderFormOrder[];
   };
 }
 
diff --git a/vtex/utils/cookies.ts b/vtex/utils/cookies.ts
index d6dbe1595..e68c5afe2 100644
--- a/vtex/utils/cookies.ts
+++ b/vtex/utils/cookies.ts
@@ -23,3 +23,6 @@ export const proxySetCookie = (
     setCookie(to, newCookie);
   }
 };
+
+export const CHECKOUT_DATA_ACCESS_COOKIE = "CheckoutDataAccess";
+export const VTEX_CHKO_AUTH = "Vtex_CHKO_Auth";
diff --git a/vtex/utils/types.ts b/vtex/utils/types.ts
index dd84e249b..5b6259d7a 100644
--- a/vtex/utils/types.ts
+++ b/vtex/utils/types.ts
@@ -1781,3 +1781,170 @@ export interface AdvancedLoaderConfig {
 }
 
 export type Maybe<T> = T | null | undefined;
+
+interface OrderPlacedSeller {
+  id: string;
+  name: string;
+  logo: string;
+}
+
+export interface OrderPlaced {
+  sellers: OrderPlacedSeller[];
+  orderId: string;
+  orderGroup: string;
+  state: string;
+  isCheckedIn: boolean;
+  sellerOrderId: string;
+  storeId: string | null;
+  checkedInPickupPointId: string | null;
+  value: number;
+  items: OrderFormItem[];
+  totals: Total[];
+  clientProfileData: ClientProfileData;
+  ratesAndBenefitsData: RatesAndBenefitsData;
+  shippingData: ShippingData;
+  paymentData: PaymentData;
+  clientPreferencesData: ClientPreferencesData;
+  commercialConditionData: null;
+  giftRegistryData: null;
+  marketingData: MarketingData | null;
+  storePreferencesData: StorePreferencesData;
+  openTextField: null;
+  invoiceData: null;
+  itemMetadata: ItemMetadata;
+  taxData: null;
+  customData: null;
+  hooksData: null;
+  changeData: null;
+  subscriptionData: null;
+  merchantContextData: null;
+  purchaseAgentData: null;
+  salesChannel: string;
+  followUpEmail: string;
+  creationDate: string;
+  lastChange: string;
+  timeZoneCreationDate: string;
+  timeZoneLastChange: string;
+  isCompleted: boolean;
+  hostName: string;
+  merchantName: string | null;
+  userType: string;
+  roundingError: number;
+  allowEdition: boolean;
+  allowCancellation: boolean;
+  isUserDataVisible: boolean;
+  cancellationData: CancelattionData;
+  orderFormCreationDate: string;
+  marketplaceRequestedCancellationWindow: null;
+}
+
+interface CancelattionData {
+  requestedByUser: true;
+  reason: string;
+  cancellationDate: string;
+  cancellationRequestId: string;
+  requestedBy: null;
+  cancellationSource: null;
+}
+
+export interface CanceledOrder {
+  date?: string;
+  orderId?: string;
+  receipt?: string | null;
+}
+
+export interface ReceiptData {
+  ReceiptCollection: Receipt[];
+}
+
+export interface Receipt {
+  ReceiptType: string;
+  Date: string;
+  ReceiptToken: string;
+  Source: string;
+  InvoiceNumber: string | null;
+  TransactionId: string;
+  MerchantName: string;
+  SellerOrderId: string | null;
+  ValueAsInt: number | null;
+}
+
+export interface CancellationData {
+  requestedByUser: boolean;
+  reason: string;
+  cancellationDate: string;
+  cancellationRequestId: string;
+  requestedBy: string | null;
+  cancellationSource: string | null;
+}
+
+export interface OrderFormOrder {
+  sellers: Seller[];
+  receiptData?: ReceiptData;
+  sequence?: string;
+  marketPlaceOrderId?: string;
+  origin?: number;
+  items: Item[];
+  giftRegistryData?: unknown;
+  contextData?: unknown;
+  marketPlaceOrderGroup?: string | null;
+  marketplaceServicesEndpoint?: string | null;
+  orderFormId?: string;
+  affiliateId?: string;
+  status?: string;
+  callCenterOperator?: string;
+  userProfileId?: string;
+  creationVersion?: string;
+  creationEnvironment?: string;
+  lastChangeVersion?: string;
+  workflowInstanceId?: string;
+  workflowInstanceGroupId?: string | null;
+  marketplacePaymentValue?: number | null;
+  marketplacePaymentReferenceValue?: number | null;
+  marketplace?: string | null;
+  orderId: string;
+  orderGroup: string;
+  state: string;
+  isCheckedIn: boolean;
+  sellerOrderId: string;
+  storeId?: string | null;
+  checkedInPickupPointId?: string | null;
+  value: number;
+  totals: Total[];
+  clientProfileData: ClientProfileData;
+  ratesAndBenefitsData: RatesAndBenefitsData;
+  shippingData: ShippingData;
+  paymentData: PaymentData;
+  clientPreferencesData: ClientPreferencesData;
+  commercialConditionData?: unknown;
+  marketingData?: unknown;
+  storePreferencesData: StorePreferencesData;
+  openTextField?: unknown;
+  invoiceData?: unknown;
+  itemMetadata: ItemMetadata;
+  taxData?: unknown;
+  customData?: unknown;
+  hooksData?: unknown;
+  changeData?: unknown;
+  subscriptionData?: unknown;
+  merchantContextData?: unknown;
+  purchaseAgentData?: unknown;
+  salesChannel: string;
+  followUpEmail?: string;
+  creationDate: string;
+  lastChange: string;
+  timeZoneCreationDate: string;
+  timeZoneLastChange: string;
+  isCompleted: boolean;
+  hostName: string;
+  merchantName?: string | null;
+  userType?: string;
+  roundingError?: number;
+  allowEdition?: boolean;
+  allowCancellation?: boolean;
+  isUserDataVisible?: boolean;
+  allowChangeSeller?: boolean;
+  cancellationData?: CancellationData;
+  orderFormCreationDate?: string;
+  marketplaceRequestedCancellationWindow?: unknown;
+}

From a1e68299a216a844b96a2866cba6a5f89a9e3160 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Mon, 12 May 2025 11:07:50 -0400
Subject: [PATCH 35/93] fix: check fmt manifest

---
 vtex/loaders/orders/getById.ts     |  2 +-
 vtex/loaders/orders/order.ts       |  8 +--
 vtex/loaders/orders/orderplaced.ts |  2 +-
 vtex/manifest.gen.ts               | 78 +++++++++++++++---------------
 website/manifest.gen.ts            | 54 +++++++++++----------
 5 files changed, 75 insertions(+), 69 deletions(-)

diff --git a/vtex/loaders/orders/getById.ts b/vtex/loaders/orders/getById.ts
index f946604e3..0698c5312 100644
--- a/vtex/loaders/orders/getById.ts
+++ b/vtex/loaders/orders/getById.ts
@@ -30,4 +30,4 @@ export default async function loader(
   ).then((res) => res.json());
 
   return order;
-}
\ No newline at end of file
+}
diff --git a/vtex/loaders/orders/order.ts b/vtex/loaders/orders/order.ts
index dc340588b..6000037cf 100644
--- a/vtex/loaders/orders/order.ts
+++ b/vtex/loaders/orders/order.ts
@@ -19,7 +19,7 @@ export default async function loader(
   const { slug } = props;
 
   const user = await ctx.invoke.vtex.loaders.user();
-  if (!user) {
+  if (!user?.email) {
     throw new HttpError(new Response("Unauthorized", { status: 403 }));
   }
 
@@ -36,11 +36,13 @@ export default async function loader(
   );
 
   if (!response.ok) {
-    throw new Error(`Failed to get order: ${response.status} ${response.statusText}`);
+    throw new Error(
+      `Failed to get order: ${response.status} ${response.statusText}`,
+    );
   }
 
   const order = await response.json();
-  
+
   if (order.clientProfileData?.email !== user.email) {
     throw new HttpError(new Response("Unauthorized", { status: 403 }));
   }
diff --git a/vtex/loaders/orders/orderplaced.ts b/vtex/loaders/orders/orderplaced.ts
index dc53f9f1e..0cafd4b04 100644
--- a/vtex/loaders/orders/orderplaced.ts
+++ b/vtex/loaders/orders/orderplaced.ts
@@ -39,4 +39,4 @@ export default async function loader(
   }).then((res) => res.json());
 
   return order;
-}
\ No newline at end of file
+}
diff --git a/vtex/manifest.gen.ts b/vtex/manifest.gen.ts
index cbff42f0c..8a0267aca 100644
--- a/vtex/manifest.gen.ts
+++ b/vtex/manifest.gen.ts
@@ -65,27 +65,28 @@ import * as $$$24 from "./loaders/logistics/listStockByStore.ts";
 import * as $$$25 from "./loaders/masterdata/searchDocuments.ts";
 import * as $$$26 from "./loaders/navbar.ts";
 import * as $$$27 from "./loaders/options/productIdByTerm.ts";
-import * as $$$28 from "./loaders/orders/getUserOrderById.ts";
+import * as $$$28 from "./loaders/orders/getById.ts";
 import * as $$$29 from "./loaders/orders/list.ts";
 import * as $$$30 from "./loaders/orders/order.ts";
-import * as $$$31 from "./loaders/paths/PDPDefaultPath.ts";
-import * as $$$32 from "./loaders/paths/PLPDefaultPath.ts";
-import * as $$$33 from "./loaders/payments/info.ts";
-import * as $$$34 from "./loaders/payments/userPayments.ts";
-import * as $$$35 from "./loaders/product/extend.ts";
-import * as $$$36 from "./loaders/product/extensions/detailsPage.ts";
-import * as $$$37 from "./loaders/product/extensions/list.ts";
-import * as $$$38 from "./loaders/product/extensions/listingPage.ts";
-import * as $$$39 from "./loaders/product/extensions/suggestions.ts";
-import * as $$$40 from "./loaders/product/wishlist.ts";
-import * as $$$41 from "./loaders/profile/passwordLastUpdate.ts";
-import * as $$$42 from "./loaders/promotion/getPromotionById.ts";
-import * as $$$43 from "./loaders/proxy.ts";
-import * as $$$44 from "./loaders/sessions/info.ts";
-import * as $$$45 from "./loaders/user.ts";
-import * as $$$46 from "./loaders/wishlist.ts";
-import * as $$$47 from "./loaders/workflow/product.ts";
-import * as $$$48 from "./loaders/workflow/products.ts";
+import * as $$$31 from "./loaders/orders/orderplaced.ts";
+import * as $$$32 from "./loaders/paths/PDPDefaultPath.ts";
+import * as $$$33 from "./loaders/paths/PLPDefaultPath.ts";
+import * as $$$34 from "./loaders/payments/info.ts";
+import * as $$$35 from "./loaders/payments/userPayments.ts";
+import * as $$$36 from "./loaders/product/extend.ts";
+import * as $$$37 from "./loaders/product/extensions/detailsPage.ts";
+import * as $$$38 from "./loaders/product/extensions/list.ts";
+import * as $$$39 from "./loaders/product/extensions/listingPage.ts";
+import * as $$$40 from "./loaders/product/extensions/suggestions.ts";
+import * as $$$41 from "./loaders/product/wishlist.ts";
+import * as $$$42 from "./loaders/profile/passwordLastUpdate.ts";
+import * as $$$43 from "./loaders/promotion/getPromotionById.ts";
+import * as $$$44 from "./loaders/proxy.ts";
+import * as $$$45 from "./loaders/sessions/info.ts";
+import * as $$$46 from "./loaders/user.ts";
+import * as $$$47 from "./loaders/wishlist.ts";
+import * as $$$48 from "./loaders/workflow/product.ts";
+import * as $$$49 from "./loaders/workflow/products.ts";
 import * as $$$$$$0 from "./sections/Analytics/Vtex.tsx";
 import * as $$$$$$$$$$0 from "./workflows/events.ts";
 import * as $$$$$$$$$$1 from "./workflows/product/index.ts";
@@ -120,27 +121,28 @@ const manifest = {
     "vtex/loaders/masterdata/searchDocuments.ts": $$$25,
     "vtex/loaders/navbar.ts": $$$26,
     "vtex/loaders/options/productIdByTerm.ts": $$$27,
-    "vtex/loaders/orders/getUserOrderById.ts": $$$28,
+    "vtex/loaders/orders/getById.ts": $$$28,
     "vtex/loaders/orders/list.ts": $$$29,
     "vtex/loaders/orders/order.ts": $$$30,
-    "vtex/loaders/paths/PDPDefaultPath.ts": $$$31,
-    "vtex/loaders/paths/PLPDefaultPath.ts": $$$32,
-    "vtex/loaders/payments/info.ts": $$$33,
-    "vtex/loaders/payments/userPayments.ts": $$$34,
-    "vtex/loaders/product/extend.ts": $$$35,
-    "vtex/loaders/product/extensions/detailsPage.ts": $$$36,
-    "vtex/loaders/product/extensions/list.ts": $$$37,
-    "vtex/loaders/product/extensions/listingPage.ts": $$$38,
-    "vtex/loaders/product/extensions/suggestions.ts": $$$39,
-    "vtex/loaders/product/wishlist.ts": $$$40,
-    "vtex/loaders/profile/passwordLastUpdate.ts": $$$41,
-    "vtex/loaders/promotion/getPromotionById.ts": $$$42,
-    "vtex/loaders/proxy.ts": $$$43,
-    "vtex/loaders/sessions/info.ts": $$$44,
-    "vtex/loaders/user.ts": $$$45,
-    "vtex/loaders/wishlist.ts": $$$46,
-    "vtex/loaders/workflow/product.ts": $$$47,
-    "vtex/loaders/workflow/products.ts": $$$48,
+    "vtex/loaders/orders/orderplaced.ts": $$$31,
+    "vtex/loaders/paths/PDPDefaultPath.ts": $$$32,
+    "vtex/loaders/paths/PLPDefaultPath.ts": $$$33,
+    "vtex/loaders/payments/info.ts": $$$34,
+    "vtex/loaders/payments/userPayments.ts": $$$35,
+    "vtex/loaders/product/extend.ts": $$$36,
+    "vtex/loaders/product/extensions/detailsPage.ts": $$$37,
+    "vtex/loaders/product/extensions/list.ts": $$$38,
+    "vtex/loaders/product/extensions/listingPage.ts": $$$39,
+    "vtex/loaders/product/extensions/suggestions.ts": $$$40,
+    "vtex/loaders/product/wishlist.ts": $$$41,
+    "vtex/loaders/profile/passwordLastUpdate.ts": $$$42,
+    "vtex/loaders/promotion/getPromotionById.ts": $$$43,
+    "vtex/loaders/proxy.ts": $$$44,
+    "vtex/loaders/sessions/info.ts": $$$45,
+    "vtex/loaders/user.ts": $$$46,
+    "vtex/loaders/wishlist.ts": $$$47,
+    "vtex/loaders/workflow/product.ts": $$$48,
+    "vtex/loaders/workflow/products.ts": $$$49,
   },
   "handlers": {
     "vtex/handlers/sitemap.ts": $$$$0,
diff --git a/website/manifest.gen.ts b/website/manifest.gen.ts
index 79f0482e9..0bb585b91 100644
--- a/website/manifest.gen.ts
+++ b/website/manifest.gen.ts
@@ -18,19 +18,20 @@ import * as $$$$2 from "./handlers/redirect.ts";
 import * as $$$$3 from "./handlers/router.ts";
 import * as $$$$4 from "./handlers/sitemap.ts";
 import * as $$$0 from "./loaders/asset.ts";
-import * as $$$1 from "./loaders/extension.ts";
-import * as $$$2 from "./loaders/fonts/googleFonts.ts";
-import * as $$$3 from "./loaders/fonts/local.ts";
-import * as $$$4 from "./loaders/image.ts";
-import * as $$$5 from "./loaders/options/routes.ts";
-import * as $$$6 from "./loaders/options/urlParams.ts";
-import * as $$$7 from "./loaders/pages.ts";
-import * as $$$8 from "./loaders/redirect.ts";
-import * as $$$9 from "./loaders/redirects.ts";
-import * as $$$10 from "./loaders/redirectsFromCsv.ts";
-import * as $$$11 from "./loaders/secret.ts";
-import * as $$$12 from "./loaders/secretString.ts";
-import * as $$$13 from "./loaders/whitelistAssets.ts";
+import * as $$$1 from "./loaders/environment.ts";
+import * as $$$2 from "./loaders/extension.ts";
+import * as $$$3 from "./loaders/fonts/googleFonts.ts";
+import * as $$$4 from "./loaders/fonts/local.ts";
+import * as $$$5 from "./loaders/image.ts";
+import * as $$$6 from "./loaders/options/routes.ts";
+import * as $$$7 from "./loaders/options/urlParams.ts";
+import * as $$$8 from "./loaders/pages.ts";
+import * as $$$9 from "./loaders/redirect.ts";
+import * as $$$10 from "./loaders/redirects.ts";
+import * as $$$11 from "./loaders/redirectsFromCsv.ts";
+import * as $$$12 from "./loaders/secret.ts";
+import * as $$$13 from "./loaders/secretString.ts";
+import * as $$$14 from "./loaders/whitelistAssets.ts";
 import * as $$$$$$$0 from "./matchers/always.ts";
 import * as $$$$$$$1 from "./matchers/cookie.ts";
 import * as $$$$$$$2 from "./matchers/cron.ts";
@@ -61,19 +62,20 @@ const manifest = {
   },
   "loaders": {
     "website/loaders/asset.ts": $$$0,
-    "website/loaders/extension.ts": $$$1,
-    "website/loaders/fonts/googleFonts.ts": $$$2,
-    "website/loaders/fonts/local.ts": $$$3,
-    "website/loaders/image.ts": $$$4,
-    "website/loaders/options/routes.ts": $$$5,
-    "website/loaders/options/urlParams.ts": $$$6,
-    "website/loaders/pages.ts": $$$7,
-    "website/loaders/redirect.ts": $$$8,
-    "website/loaders/redirects.ts": $$$9,
-    "website/loaders/redirectsFromCsv.ts": $$$10,
-    "website/loaders/secret.ts": $$$11,
-    "website/loaders/secretString.ts": $$$12,
-    "website/loaders/whitelistAssets.ts": $$$13,
+    "website/loaders/environment.ts": $$$1,
+    "website/loaders/extension.ts": $$$2,
+    "website/loaders/fonts/googleFonts.ts": $$$3,
+    "website/loaders/fonts/local.ts": $$$4,
+    "website/loaders/image.ts": $$$5,
+    "website/loaders/options/routes.ts": $$$6,
+    "website/loaders/options/urlParams.ts": $$$7,
+    "website/loaders/pages.ts": $$$8,
+    "website/loaders/redirect.ts": $$$9,
+    "website/loaders/redirects.ts": $$$10,
+    "website/loaders/redirectsFromCsv.ts": $$$11,
+    "website/loaders/secret.ts": $$$12,
+    "website/loaders/secretString.ts": $$$13,
+    "website/loaders/whitelistAssets.ts": $$$14,
   },
   "handlers": {
     "website/handlers/fresh.ts": $$$$0,

From 7061d39b142f18c766392734bc60f048663a711a Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Mon, 12 May 2025 13:39:25 -0400
Subject: [PATCH 36/93] fix: types and get order group on orderplaced

---
 vtex/loaders/orders/orderplaced.ts |  18 +++-
 vtex/utils/types.ts                | 142 +----------------------------
 2 files changed, 18 insertions(+), 142 deletions(-)

diff --git a/vtex/loaders/orders/orderplaced.ts b/vtex/loaders/orders/orderplaced.ts
index 0cafd4b04..6922afa2e 100644
--- a/vtex/loaders/orders/orderplaced.ts
+++ b/vtex/loaders/orders/orderplaced.ts
@@ -1,8 +1,8 @@
 import { getCookies } from "@std/http";
-import { stringify } from "node:querystring";
 import { AppContext } from "../../mod.ts";
 import {
   CHECKOUT_DATA_ACCESS_COOKIE,
+  stringify,
   VTEX_CHKO_AUTH,
 } from "../../utils/cookies.ts";
 import { VTEX_ID_CLIENT_COOKIE } from "../../utils/vtexId.ts";
@@ -32,11 +32,23 @@ export default async function loader(
   );
   const cookie = stringify(cookies);
 
+  const isOrderGroup = orderId.includes("-");
+  if (isOrderGroup) {
+    const orderGroup = await vcsDeprecated
+      ["GET /api/checkout/pub/orders/order-group/:orderGroupId"]({
+        orderGroupId: orderId,
+      }, {
+        headers: { cookie },
+      }).then((res) => res.json());
+
+    return orderGroup;
+  }
+
   const order = await vcsDeprecated["GET /api/checkout/pub/orders/:orderId"]({
-    orderId,
+    orderId: orderId.includes("-") ? orderId : orderId + "-01",
   }, {
     headers: { cookie },
   }).then((res) => res.json());
 
-  return order;
+  return [order];
 }
diff --git a/vtex/utils/types.ts b/vtex/utils/types.ts
index 5b6259d7a..98caf9467 100644
--- a/vtex/utils/types.ts
+++ b/vtex/utils/types.ts
@@ -1477,63 +1477,7 @@ export interface CanceledOrder {
   receipt?: string | null;
 }
 
-interface OrderPlacedSeller {
-  id: string;
-  name: string;
-  logo: string;
-}
-
-export interface OrderPlaced {
-  sellers: OrderPlacedSeller[];
-  orderId: string;
-  orderGroup: string;
-  state: string;
-  isCheckedIn: boolean;
-  sellerOrderId: string;
-  storeId: string | null;
-  checkedInPickupPointId: string | null;
-  value: number;
-  items: OrderFormItem[];
-  totals: Total[];
-  clientProfileData: ClientProfileData;
-  ratesAndBenefitsData: RatesAndBenefitsData;
-  shippingData: ShippingData;
-  paymentData: PaymentData;
-  clientPreferencesData: ClientPreferencesData;
-  commercialConditionData: null;
-  giftRegistryData: null;
-  marketingData: MarketingData | null;
-  storePreferencesData: StorePreferencesData;
-  openTextField: null;
-  invoiceData: null;
-  itemMetadata: ItemMetadata;
-  taxData: null;
-  customData: null;
-  hooksData: null;
-  changeData: null;
-  subscriptionData: null;
-  merchantContextData: null;
-  purchaseAgentData: null;
-  salesChannel: string;
-  followUpEmail: string;
-  creationDate: string;
-  lastChange: string;
-  timeZoneCreationDate: string;
-  timeZoneLastChange: string;
-  isCompleted: boolean;
-  hostName: string;
-  merchantName: string | null;
-  userType: string;
-  roundingError: number;
-  allowEdition: boolean;
-  allowCancellation: boolean;
-  isUserDataVisible: boolean;
-  cancellationData: CancelattionData;
-  orderFormCreationDate: string;
-  marketplaceRequestedCancellationWindow: null;
-}
-
-interface CancelattionData {
+interface CancellationData {
   requestedByUser: true;
   reason: string;
   cancellationDate: string;
@@ -1782,77 +1726,6 @@ export interface AdvancedLoaderConfig {
 
 export type Maybe<T> = T | null | undefined;
 
-interface OrderPlacedSeller {
-  id: string;
-  name: string;
-  logo: string;
-}
-
-export interface OrderPlaced {
-  sellers: OrderPlacedSeller[];
-  orderId: string;
-  orderGroup: string;
-  state: string;
-  isCheckedIn: boolean;
-  sellerOrderId: string;
-  storeId: string | null;
-  checkedInPickupPointId: string | null;
-  value: number;
-  items: OrderFormItem[];
-  totals: Total[];
-  clientProfileData: ClientProfileData;
-  ratesAndBenefitsData: RatesAndBenefitsData;
-  shippingData: ShippingData;
-  paymentData: PaymentData;
-  clientPreferencesData: ClientPreferencesData;
-  commercialConditionData: null;
-  giftRegistryData: null;
-  marketingData: MarketingData | null;
-  storePreferencesData: StorePreferencesData;
-  openTextField: null;
-  invoiceData: null;
-  itemMetadata: ItemMetadata;
-  taxData: null;
-  customData: null;
-  hooksData: null;
-  changeData: null;
-  subscriptionData: null;
-  merchantContextData: null;
-  purchaseAgentData: null;
-  salesChannel: string;
-  followUpEmail: string;
-  creationDate: string;
-  lastChange: string;
-  timeZoneCreationDate: string;
-  timeZoneLastChange: string;
-  isCompleted: boolean;
-  hostName: string;
-  merchantName: string | null;
-  userType: string;
-  roundingError: number;
-  allowEdition: boolean;
-  allowCancellation: boolean;
-  isUserDataVisible: boolean;
-  cancellationData: CancelattionData;
-  orderFormCreationDate: string;
-  marketplaceRequestedCancellationWindow: null;
-}
-
-interface CancelattionData {
-  requestedByUser: true;
-  reason: string;
-  cancellationDate: string;
-  cancellationRequestId: string;
-  requestedBy: null;
-  cancellationSource: null;
-}
-
-export interface CanceledOrder {
-  date?: string;
-  orderId?: string;
-  receipt?: string | null;
-}
-
 export interface ReceiptData {
   ReceiptCollection: Receipt[];
 }
@@ -1869,22 +1742,13 @@ export interface Receipt {
   ValueAsInt: number | null;
 }
 
-export interface CancellationData {
-  requestedByUser: boolean;
-  reason: string;
-  cancellationDate: string;
-  cancellationRequestId: string;
-  requestedBy: string | null;
-  cancellationSource: string | null;
-}
-
 export interface OrderFormOrder {
   sellers: Seller[];
   receiptData?: ReceiptData;
   sequence?: string;
   marketPlaceOrderId?: string;
   origin?: number;
-  items: Item[];
+  items: OrderFormItem[];
   giftRegistryData?: unknown;
   contextData?: unknown;
   marketPlaceOrderGroup?: string | null;
@@ -1917,7 +1781,7 @@ export interface OrderFormOrder {
   paymentData: PaymentData;
   clientPreferencesData: ClientPreferencesData;
   commercialConditionData?: unknown;
-  marketingData?: unknown;
+  marketingData?: MarketingData | null;
   storePreferencesData: StorePreferencesData;
   openTextField?: unknown;
   invoiceData?: unknown;

From cd31f40d693eb8b6e9068d55b86f38f246fc8465 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Wed, 14 May 2025 11:19:50 -0400
Subject: [PATCH 37/93] fix: woopsy

---
 vtex/loaders/orders/orderplaced.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/vtex/loaders/orders/orderplaced.ts b/vtex/loaders/orders/orderplaced.ts
index 6922afa2e..084a88c4a 100644
--- a/vtex/loaders/orders/orderplaced.ts
+++ b/vtex/loaders/orders/orderplaced.ts
@@ -32,7 +32,7 @@ export default async function loader(
   );
   const cookie = stringify(cookies);
 
-  const isOrderGroup = orderId.includes("-");
+  const isOrderGroup = !orderId.includes("-");
   if (isOrderGroup) {
     const orderGroup = await vcsDeprecated
       ["GET /api/checkout/pub/orders/order-group/:orderGroupId"]({

From 2994c9dc11d2b5e216d5af69921f9a081fbf0a48 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Tue, 20 May 2025 21:22:17 -0400
Subject: [PATCH 38/93] add simulation behavior props

---
 vtex/loaders/intelligentSearch/productList.ts        | 12 ++++++++++++
 vtex/loaders/intelligentSearch/productListingPage.ts |  8 ++++++++
 vtex/utils/intelligentSearch.ts                      |  3 +++
 3 files changed, 23 insertions(+)

diff --git a/vtex/loaders/intelligentSearch/productList.ts b/vtex/loaders/intelligentSearch/productList.ts
index eae248a5b..edc76ec3b 100644
--- a/vtex/loaders/intelligentSearch/productList.ts
+++ b/vtex/loaders/intelligentSearch/productList.ts
@@ -109,6 +109,11 @@ export interface CommonProps {
    * @deprecated Use product extensions instead
    */
   similars?: boolean;
+  /**
+   * @title Simulation Behavior
+   * @description Defines the simulation behavior.
+   */
+  simulationBehavior?: "default" | "skip" | "only1P";
 }
 
 /**
@@ -142,6 +147,7 @@ const fromProps = ({ props }: Props) => {
       sort: props.sort || "",
       selectedFacets: [{ key: "", value: props.facets }],
       hideUnavailableItems: props.hideUnavailableItems,
+      simulationBehavior: props.simulationBehavior || "default",
     } as const;
   }
 
@@ -152,6 +158,7 @@ const fromProps = ({ props }: Props) => {
       sort: "",
       selectedFacets: [],
       hideUnavailableItems: props.hideUnavailableItems,
+      simulationBehavior: props.simulationBehavior || "default",
     } as const;
   }
 
@@ -163,6 +170,7 @@ const fromProps = ({ props }: Props) => {
       fuzzy: mapLabelledFuzzyToFuzzy(props.fuzzy),
       selectedFacets: [],
       hideUnavailableItems: props.hideUnavailableItems,
+      simulationBehavior: props.simulationBehavior || "default",
     } as const;
   }
 
@@ -173,6 +181,7 @@ const fromProps = ({ props }: Props) => {
       sort: props.sort || "",
       selectedFacets: [{ key: "productClusterIds", value: props.collection }],
       hideUnavailableItems: props.hideUnavailableItems,
+      simulationBehavior: props.simulationBehavior || "default",
     } as const;
   }
 
@@ -254,6 +263,7 @@ const getSearchParams = (
         "hideUnavailableItems",
         (props.hideUnavailableItems ?? false).toString(),
       ],
+      ["simulationBehavior", props.simulationBehavior || "default"],
     ];
   }
 
@@ -267,6 +277,7 @@ const getSearchParams = (
         "hideUnavailableItems",
         (props.hideUnavailableItems ?? false).toString(),
       ],
+      ["simulationBehavior", props.simulationBehavior || "default"],
     ];
   }
 
@@ -279,6 +290,7 @@ const getSearchParams = (
         "hideUnavailableItems",
         (props.hideUnavailableItems ?? false).toString(),
       ],
+      ["simulationBehavior", props.simulationBehavior || "default"],
     ];
   }
 
diff --git a/vtex/loaders/intelligentSearch/productListingPage.ts b/vtex/loaders/intelligentSearch/productListingPage.ts
index 3d163f4a3..09f5d8ffa 100644
--- a/vtex/loaders/intelligentSearch/productListingPage.ts
+++ b/vtex/loaders/intelligentSearch/productListingPage.ts
@@ -160,9 +160,15 @@ export interface Props {
    * @description Further change loader behaviour
    */
   advancedConfigs?: AdvancedLoaderConfig;
+  /**
+   * @title Simulation Behavior
+   * @description Defines the simulation behavior.
+   */
+  simulationBehavior?: "default" | "skip" | "only1P";
 }
 const searchArgsOf = (props: Props, url: URL) => {
   const hideUnavailableItems = props.hideUnavailableItems;
+  const simulationBehavior = props.simulationBehavior || "default";
   const countFromSearchParams = url.searchParams.get("PS");
   const count = Number(countFromSearchParams ?? props.count ?? 12);
   const query = props.query ?? url.searchParams.get("q") ?? "";
@@ -195,6 +201,7 @@ const searchArgsOf = (props: Props, url: URL) => {
     count,
     hideUnavailableItems,
     selectedFacets,
+    simulationBehavior,
   };
 };
 const PAGE_TYPE_TO_MAP_PARAM = {
@@ -460,6 +467,7 @@ export const cacheKey = (props: Props, req: Request, ctx: AppContext) => {
       ).join("\\"),
     ],
     ["segment", segment],
+    ["simulationBehavior", props.simulationBehavior || "default"],
   ]);
   url.searchParams.forEach((value, key) => {
     if (!ALLOWED_PARAMS.has(key.toLowerCase()) && !isFilterParam(key)) {
diff --git a/vtex/utils/intelligentSearch.ts b/vtex/utils/intelligentSearch.ts
index 17a64781b..d9db82d6a 100644
--- a/vtex/utils/intelligentSearch.ts
+++ b/vtex/utils/intelligentSearch.ts
@@ -46,6 +46,7 @@ interface Params {
   fuzzy: string;
   locale: string;
   hideUnavailableItems: boolean;
+  simulationBehavior: "default" | "skip" | "only1P";
 }
 
 export const withDefaultParams = ({
@@ -56,6 +57,7 @@ export const withDefaultParams = ({
   fuzzy = "auto",
   locale = "pt-BR",
   hideUnavailableItems,
+  simulationBehavior = "default",
 }: Partial<Params>) => ({
   page: page + 1,
   count,
@@ -65,6 +67,7 @@ export const withDefaultParams = ({
   locale,
   // locale: locale ?? ctx.configVTEX!.defaultLocale,
   hideUnavailableItems: hideUnavailableItems ?? false,
+  simulationBehavior,
 });
 
 const IS_ANONYMOUS = Symbol("segment");

From e8167633475fcefa441ce40ac1d88b844ff62809 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Wed, 21 May 2025 13:22:53 -0400
Subject: [PATCH 39/93] add simulation behavior test a/b

---
 vtex/loaders/intelligentSearch/productList.ts | 22 +++++++++---
 .../intelligentSearch/productListingPage.ts   | 24 ++++++++++---
 vtex/middleware.ts                            |  8 ++++-
 vtex/mod.ts                                   | 17 ++++++++++
 vtex/utils/simulationBehavior.ts              | 34 +++++++++++++++++++
 5 files changed, 94 insertions(+), 11 deletions(-)
 create mode 100644 vtex/utils/simulationBehavior.ts

diff --git a/vtex/loaders/intelligentSearch/productList.ts b/vtex/loaders/intelligentSearch/productList.ts
index edc76ec3b..8958cfc9a 100644
--- a/vtex/loaders/intelligentSearch/productList.ts
+++ b/vtex/loaders/intelligentSearch/productList.ts
@@ -9,14 +9,14 @@ import {
 } from "../../utils/intelligentSearch.ts";
 import { getSegmentFromBag, withSegmentCookie } from "../../utils/segment.ts";
 import { withIsSimilarTo } from "../../utils/similars.ts";
-import { toProduct } from "../../utils/transform.ts";
+import { getSkipSimulationBehaviorFromBag } from "../../utils/simulationBehavior.ts";
+import { sortProducts, toProduct } from "../../utils/transform.ts";
 import type { Item, ProductID, Sort } from "../../utils/types.ts";
+import { getFirstItemAvailable } from "../legacy/productListingPage.ts";
 import {
   LabelledFuzzy,
   mapLabelledFuzzyToFuzzy,
 } from "./productListingPage.ts";
-import { sortProducts } from "../../utils/transform.ts";
-import { getFirstItemAvailable } from "../legacy/productListingPage.ts";
 
 /**
  * @title Collection ID
@@ -205,8 +205,14 @@ const loader = async (
   req: Request,
   ctx: AppContext,
 ): Promise<Product[] | null> => {
-  const props = expandedProps.props ??
+  const _props = expandedProps.props ??
     (expandedProps as unknown as Props["props"]);
+  const props = {
+    ..._props,
+    simulationBehavior: getSkipSimulationBehaviorFromBag(ctx)
+      ? "skip"
+      : _props.simulationBehavior || "default",
+  };
   const { vcsDeprecated } = ctx;
   const { url } = req;
   const segment = getSegmentFromBag(ctx);
@@ -304,8 +310,14 @@ export const cacheKey = (
   req: Request,
   ctx: AppContext,
 ) => {
-  const props = expandedProps.props ??
+  const _props = expandedProps.props ??
     (expandedProps as unknown as Props["props"]);
+  const props = {
+    ..._props,
+    simulationBehavior: getSkipSimulationBehaviorFromBag(ctx)
+      ? "skip"
+      : _props.simulationBehavior || "default",
+  };
 
   const url = new URL(req.url);
 
diff --git a/vtex/loaders/intelligentSearch/productListingPage.ts b/vtex/loaders/intelligentSearch/productListingPage.ts
index 09f5d8ffa..c7c270da4 100644
--- a/vtex/loaders/intelligentSearch/productListingPage.ts
+++ b/vtex/loaders/intelligentSearch/productListingPage.ts
@@ -1,3 +1,4 @@
+import { redirect } from "@deco/deco";
 import type { ProductListingPage } from "../../../commerce/types.ts";
 import { parseRange } from "../../../commerce/utils/filters.ts";
 import { STALE } from "../../../utils/fetch.ts";
@@ -5,6 +6,7 @@ import sendEvent from "../../actions/analytics/sendEvent.ts";
 import { AppContext } from "../../mod.ts";
 import {
   isFilterParam,
+  pageTypesFromUrl,
   toPath,
   withDefaultFacets,
   withDefaultParams,
@@ -15,8 +17,8 @@ import {
   pageTypesToSeo,
 } from "../../utils/legacy.ts";
 import { getSegmentFromBag, withSegmentCookie } from "../../utils/segment.ts";
-import { pageTypesFromUrl } from "../../utils/intelligentSearch.ts";
 import { withIsSimilarTo } from "../../utils/similars.ts";
+import { getSkipSimulationBehaviorFromBag } from "../../utils/simulationBehavior.ts";
 import { slugify } from "../../utils/slugify.ts";
 import {
   filtersFromURL,
@@ -36,7 +38,7 @@ import type {
 } from "../../utils/types.ts";
 import { getFirstItemAvailable } from "../legacy/productListingPage.ts";
 import PLPDefaultPath from "../paths/PLPDefaultPath.ts";
-import { redirect } from "@deco/deco";
+
 /** this type is more friendly user to fuzzy type that is 0, 1 or auto. */
 export type LabelledFuzzy = "automatic" | "disabled" | "enabled";
 /**
@@ -166,9 +168,15 @@ export interface Props {
    */
   simulationBehavior?: "default" | "skip" | "only1P";
 }
-const searchArgsOf = (props: Props, url: URL) => {
+const searchArgsOf = (props: Props, url: URL, ctx: AppContext) => {
   const hideUnavailableItems = props.hideUnavailableItems;
-  const simulationBehavior = props.simulationBehavior || "default";
+  const simulationBehavior = getSkipSimulationBehaviorFromBag(ctx)
+    ? "skip" as const
+    : (url.searchParams.get("simulationBehavior") as
+      | "skip"
+      | "default"
+      | "only1P") ||
+      props.simulationBehavior || "default";
   const countFromSearchParams = url.searchParams.get("PS");
   const count = Number(countFromSearchParams ?? props.count ?? 12);
   const query = props.query ?? url.searchParams.get("q") ?? "";
@@ -289,6 +297,7 @@ const loader = async (
   const { selectedFacets: baseSelectedFacets, page, ...args } = searchArgsOf(
     props,
     url,
+    ctx,
   );
   let pathToUse = url.href.replace(url.origin, "");
 
@@ -467,7 +476,12 @@ export const cacheKey = (props: Props, req: Request, ctx: AppContext) => {
       ).join("\\"),
     ],
     ["segment", segment],
-    ["simulationBehavior", props.simulationBehavior || "default"],
+    [
+      "simulationBehavior",
+      getSkipSimulationBehaviorFromBag(ctx)
+        ? "skip"
+        : props.simulationBehavior || "default",
+    ],
   ]);
   url.searchParams.forEach((value, key) => {
     if (!ALLOWED_PARAMS.has(key.toLowerCase()) && !isFilterParam(key)) {
diff --git a/vtex/middleware.ts b/vtex/middleware.ts
index f4e33f34b..e70e9529e 100644
--- a/vtex/middleware.ts
+++ b/vtex/middleware.ts
@@ -5,14 +5,20 @@ import {
   setISCookiesBag,
 } from "./utils/intelligentSearch.ts";
 import { getSegmentFromBag, setSegmentBag } from "./utils/segment.ts";
+import {
+  resolveSkipSimulationBehavior,
+  setSkipSimulationBehaviorToBag,
+} from "./utils/simulationBehavior.ts";
 
-export const middleware = (
+export const middleware = async (
   _props: unknown,
   req: Request,
   ctx: AppMiddlewareContext,
 ) => {
   const segment = getSegmentFromBag(ctx);
   const isCookies = getISCookiesFromBag(ctx);
+  const skipSimulationBehavior = await resolveSkipSimulationBehavior(ctx, req);
+  setSkipSimulationBehaviorToBag(ctx, skipSimulationBehavior);
 
   if (!isCookies || !segment) {
     const cookies = getCookies(req.headers);
diff --git a/vtex/mod.ts b/vtex/mod.ts
index 3d0a05f51..b21f5784d 100644
--- a/vtex/mod.ts
+++ b/vtex/mod.ts
@@ -18,6 +18,7 @@ import {
   type AppContext as AC,
   type AppMiddlewareContext as AMC,
   type AppRuntime,
+  asResolved,
   type ManifestOf,
 } from "@deco/deco";
 export type App = ReturnType<typeof VTEX>;
@@ -36,6 +37,8 @@ export type SegmentCulture = Omit<
   | "priceTables"
   | "regionId"
 >;
+import { Matcher } from "@deco/deco/blocks";
+
 /** @title VTEX */
 export interface Props {
   /**
@@ -76,6 +79,10 @@ export interface Props {
    * @hide true
    */
   platform: "vtex";
+  /**
+   * @title Skip Simulation Behavior
+   */
+  skipSimulationBehavior?: Matcher;
 }
 export const color = 0xf71963;
 /**
@@ -166,3 +173,13 @@ export const preview = async (props: AppRuntime) => {
     },
   };
 };
+export const onBeforeResolveProps = (props: Props) => {
+  const skipSimulationBehavior = props.skipSimulationBehavior
+    ? asResolved(props.skipSimulationBehavior, false)
+    : undefined;
+
+  return {
+    ...props,
+    skipSimulationBehavior,
+  };
+};
diff --git a/vtex/utils/simulationBehavior.ts b/vtex/utils/simulationBehavior.ts
new file mode 100644
index 000000000..068843d6b
--- /dev/null
+++ b/vtex/utils/simulationBehavior.ts
@@ -0,0 +1,34 @@
+import { Resolved } from "@deco/deco";
+import { Matcher } from "@deco/deco/blocks";
+import { AppContext, AppMiddlewareContext } from "../mod.ts";
+
+const SKIP_SIMULATION_BEHAVIOR_KEY = Symbol("skipSimulationBehavior");
+
+export function getSkipSimulationBehaviorFromBag(ctx: AppContext) {
+  return ctx.bag.get(SKIP_SIMULATION_BEHAVIOR_KEY);
+}
+
+export function setSkipSimulationBehaviorToBag(
+  ctx: AppMiddlewareContext,
+  skipSimulationBehavior: boolean,
+) {
+  ctx.bag.set(SKIP_SIMULATION_BEHAVIOR_KEY, skipSimulationBehavior);
+}
+
+export async function resolveSkipSimulationBehavior(
+  ctx: AppMiddlewareContext,
+  req: Request,
+) {
+  const { __resolveType, ...props } = ctx
+    .skipSimulationBehavior as unknown as Resolved<Matcher>;
+  const skipSimulationBehavior = await ctx.invoke(
+    // @ts-ignore	ignore
+    __resolveType,
+    props,
+  ) as Matcher;
+  return skipSimulationBehavior({
+    request: req,
+    siteId: 0,
+    device: ctx.device,
+  });
+}

From 6b6c28ead50263f33a68ea81c3646a81ca2efd52 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Thu, 22 May 2025 09:28:46 -0400
Subject: [PATCH 40/93] fix: undefined matcher

---
 vtex/utils/simulationBehavior.ts | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/vtex/utils/simulationBehavior.ts b/vtex/utils/simulationBehavior.ts
index 068843d6b..5ffce3b8d 100644
--- a/vtex/utils/simulationBehavior.ts
+++ b/vtex/utils/simulationBehavior.ts
@@ -20,7 +20,10 @@ export async function resolveSkipSimulationBehavior(
   req: Request,
 ) {
   const { __resolveType, ...props } = ctx
-    .skipSimulationBehavior as unknown as Resolved<Matcher>;
+    .skipSimulationBehavior as unknown as Resolved<Matcher> || {};
+  if (!__resolveType) {
+    return false;
+  }
   const skipSimulationBehavior = await ctx.invoke(
     // @ts-ignore	ignore
     __resolveType,

From fcdedc6d904fddadb0d79c78863aced9da2bce16 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Thu, 22 May 2025 09:50:22 -0400
Subject: [PATCH 41/93] fix: dangerously set inner HTML

---
 linx/loaders/product/listingPage.ts           |  5 +++--
 shopify/loaders/ProductListingPage.ts         |  5 +++--
 vnda/loaders/productListingPage.ts            |  5 ++++-
 .../intelligentSearch/productListingPage.ts   |  5 +++--
 vtex/loaders/legacy/productListingPage.ts     |  5 +++--
 wake/loaders/productListingPage.ts            |  7 +++---
 wap/loaders/productListingPage.ts             |  7 +++---
 website/components/Seo.tsx                    |  8 +++----
 website/utils/html.ts                         | 22 +++++++++++++++++++
 9 files changed, 50 insertions(+), 19 deletions(-)

diff --git a/linx/loaders/product/listingPage.ts b/linx/loaders/product/listingPage.ts
index 7b9c9440b..046d49286 100644
--- a/linx/loaders/product/listingPage.ts
+++ b/linx/loaders/product/listingPage.ts
@@ -1,4 +1,5 @@
 import type { ProductListingPage } from "../../../commerce/types.ts";
+import { safeJsonSerialize } from "../../../website/utils/html.ts";
 import { AppContext } from "../../mod.ts";
 import { isGridProductsModel } from "../../utils/paths.ts";
 import {
@@ -107,11 +108,11 @@ const loader = async (
       value: sort.Alias,
       label: sort.Label,
     })),
-    seo: {
+    seo: safeJsonSerialize({
       title: pageInfo.PageTitle,
       description: pageInfo.MetaDescription || "",
       canonical: pageInfo.CanonicalLink,
-    },
+    }),
   };
 };
 
diff --git a/shopify/loaders/ProductListingPage.ts b/shopify/loaders/ProductListingPage.ts
index 4672b8efa..90b810d80 100644
--- a/shopify/loaders/ProductListingPage.ts
+++ b/shopify/loaders/ProductListingPage.ts
@@ -1,5 +1,6 @@
 import type { ProductListingPage } from "../../commerce/types.ts";
 import { AppContext } from "../../shopify/mod.ts";
+import { safeJsonSerialize } from "../../website/utils/html.ts";
 import {
   ProductsByCollection,
   SearchProducts,
@@ -219,13 +220,13 @@ const loader = async (
       recordPerPage: count,
     },
     sortOptions: isSearch ? searchSortOptions : sortOptions,
-    seo: {
+    seo: safeJsonSerialize({
       title: collectionTitle || "",
       description: collectionDescription || "",
       canonical: `${url.origin}${url.pathname}${
         page >= 1 ? `?page=${page}` : ""
       }`,
-    },
+    }),
   };
 };
 
diff --git a/vnda/loaders/productListingPage.ts b/vnda/loaders/productListingPage.ts
index 16a8d9a86..fd03219b8 100644
--- a/vnda/loaders/productListingPage.ts
+++ b/vnda/loaders/productListingPage.ts
@@ -5,6 +5,7 @@ import type {
 import { SortOption } from "../../commerce/types.ts";
 import { STALE } from "../../utils/fetch.ts";
 import type { RequestURLParam } from "../../website/functions/requestToParam.ts";
+import { safeJsonSerialize } from "../../website/utils/html.ts";
 import type { AppContext } from "../mod.ts";
 import { ProductSearchResult, Sort } from "../utils/client/types.ts";
 import { Tag } from "../utils/openapi/vnda.openapi.gen.ts";
@@ -241,7 +242,9 @@ const searchLoader = async (
 
   return {
     "@type": "ProductListingPage",
-    seo: getSEOFromTag(categories, url, seo.at(-1), hasTypeTags, isSearchPage),
+    seo: safeJsonSerialize(
+      getSEOFromTag(categories, url, seo.at(-1), hasTypeTags, isSearchPage),
+    ),
     breadcrumb: isSearchPage
       ? {
         "@type": "BreadcrumbList",
diff --git a/vtex/loaders/intelligentSearch/productListingPage.ts b/vtex/loaders/intelligentSearch/productListingPage.ts
index c7c270da4..9a65bb98d 100644
--- a/vtex/loaders/intelligentSearch/productListingPage.ts
+++ b/vtex/loaders/intelligentSearch/productListingPage.ts
@@ -2,6 +2,7 @@ import { redirect } from "@deco/deco";
 import type { ProductListingPage } from "../../../commerce/types.ts";
 import { parseRange } from "../../../commerce/utils/filters.ts";
 import { STALE } from "../../../utils/fetch.ts";
+import { safeJsonSerialize } from "../../../website/utils/html.ts";
 import sendEvent from "../../actions/analytics/sendEvent.ts";
 import { AppContext } from "../../mod.ts";
 import {
@@ -445,11 +446,11 @@ const loader = async (
       pageTypes: allPageTypes.map(parsePageType),
     },
     sortOptions,
-    seo: pageTypesToSeo(
+    seo: safeJsonSerialize(pageTypesToSeo(
       currentPageTypes,
       baseUrl,
       hasPreviousPage ? currentPage : undefined,
-    ),
+    )),
   };
 };
 export const cache = "stale-while-revalidate";
diff --git a/vtex/loaders/legacy/productListingPage.ts b/vtex/loaders/legacy/productListingPage.ts
index f4bbce15f..a7b74aca4 100644
--- a/vtex/loaders/legacy/productListingPage.ts
+++ b/vtex/loaders/legacy/productListingPage.ts
@@ -15,6 +15,7 @@ import { getSegmentFromBag, withSegmentCookie } from "../../utils/segment.ts";
 import { withIsSimilarTo } from "../../utils/similars.ts";
 import { parsePageType } from "../../utils/transform.ts";
 import { legacyFacetToFilter, toProduct } from "../../utils/transform.ts";
+import { safeJsonSerialize } from "../../../website/utils/html.ts";
 import type {
   AdvancedLoaderConfig,
   Item,
@@ -431,11 +432,11 @@ const loader = async (
       pageTypes: allPageTypes.map(parsePageType),
     },
     sortOptions,
-    seo: pageTypesToSeo(
+    seo: safeJsonSerialize(pageTypesToSeo(
       currentPageTypes,
       baseUrl,
       hasPreviousPage ? currentPage : undefined,
-    ),
+    )),
   };
 };
 
diff --git a/wake/loaders/productListingPage.ts b/wake/loaders/productListingPage.ts
index 2a5a9bd25..faa195e98 100644
--- a/wake/loaders/productListingPage.ts
+++ b/wake/loaders/productListingPage.ts
@@ -1,7 +1,9 @@
+import { logger } from "@deco/deco/o11y";
 import type { ProductListingPage } from "../../commerce/types.ts";
 import { SortOption } from "../../commerce/types.ts";
 import { capitalize } from "../../utils/capitalize.ts";
 import { RequestURLParam } from "../../website/functions/requestToParam.ts";
+import { safeJsonSerialize } from "../../website/utils/html.ts";
 import type { AppContext } from "../mod.ts";
 import {
   getVariations,
@@ -35,7 +37,6 @@ import {
   toProduct,
 } from "../utils/transform.ts";
 import { Filters } from "./productList.ts";
-import { logger } from "@deco/deco/o11y";
 
 export type Sort =
   | "NAME:ASC"
@@ -320,11 +321,11 @@ const searchLoader = async (
     },
     sortOptions: SORT_OPTIONS,
     breadcrumb,
-    seo: {
+    seo: safeJsonSerialize({
       description: description || "",
       title: title || "",
       canonical,
-    },
+    }),
     products: products
       ?.filter((p): p is ProductFragment => Boolean(p))
       .map((variant) => {
diff --git a/wap/loaders/productListingPage.ts b/wap/loaders/productListingPage.ts
index 7770a807e..3bdbf3b9b 100644
--- a/wap/loaders/productListingPage.ts
+++ b/wap/loaders/productListingPage.ts
@@ -1,4 +1,6 @@
 import { ProductListingPage } from "../../commerce/types.ts";
+import { TypedResponse } from "../../utils/http.ts";
+import { safeJsonSerialize } from "../../website/utils/html.ts";
 import { AppContext } from "../mod.ts";
 import {
   getUrl,
@@ -7,7 +9,6 @@ import {
   toProduct,
 } from "../utils/transform.ts";
 import { WapProductsListPage } from "../utils/type.ts";
-import { TypedResponse } from "../../utils/http.ts";
 
 type ORDER_OPTS = "Favoritos" | "Maior Preço" | "Menor Preço" | "Popularidade";
 
@@ -171,13 +172,13 @@ const loader = async (
       records: data.info.total,
       recordPerPage: limit,
     },
-    seo: {
+    seo: safeJsonSerialize({
       title: data.estrutura.seo.title,
       description: data.estrutura.seo.description,
       // TODO canonical
       canonical:
         getUrl(new URL(data.estrutura.seo.canonical).pathname, url.origin).href,
-    },
+    }),
   };
 };
 
diff --git a/website/components/Seo.tsx b/website/components/Seo.tsx
index 6bbbf3284..a60e30daf 100644
--- a/website/components/Seo.tsx
+++ b/website/components/Seo.tsx
@@ -1,7 +1,7 @@
 import { Head } from "$fresh/runtime.ts";
-import type { ImageWidget } from "../../admin/widgets.ts";
-import { stripHTML } from "../utils/html.ts";
 import { JSX } from "preact";
+import type { ImageWidget } from "../../admin/widgets.ts";
+import { safeJsonSerialize, stripHTML } from "../utils/html.ts";
 
 export const renderTemplateString = (template: string, value: string) =>
   template.replace("%s", value);
@@ -97,11 +97,11 @@ function Component({
         <script
           type="application/ld+json"
           dangerouslySetInnerHTML={{
-            __html: JSON.stringify({
+            __html: safeJsonSerialize({
               "@context": "https://schema.org",
               // @ts-expect-error Trust me, I'm an engineer
               ...json,
-            }),
+            }, { returnAsString: true }),
           }}
         />
       ))}
diff --git a/website/utils/html.ts b/website/utils/html.ts
index 8adbdbdfe..1d764420d 100644
--- a/website/utils/html.ts
+++ b/website/utils/html.ts
@@ -3,3 +3,25 @@ export const stripHTML = (str: string) =>
     /(<([^>]+)>)/gi,
     "",
   );
+
+export function safeJsonSerialize(
+  // deno-lint-ignore no-explicit-any
+  obj: any,
+  options?: { returnAsString?: boolean },
+) {
+  if (!obj) {
+    return options?.returnAsString ? "{}" : {};
+  }
+
+  if (typeof obj !== "object") {
+    return options?.returnAsString ? String(obj) : obj;
+  }
+
+  const json = stripHTML(JSON.stringify(obj));
+
+  if (options?.returnAsString) {
+    return json;
+  }
+
+  return JSON.parse(json);
+}

From 5d882d64da41ecb0071f64ac9a86c559899e12d7 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Fri, 13 Jun 2025 09:40:26 -0400
Subject: [PATCH 42/93] feat: add metrics

---
 .../intelligentSearch/productListingPage.ts   | 348 ++++++++++--------
 1 file changed, 202 insertions(+), 146 deletions(-)

diff --git a/vtex/loaders/intelligentSearch/productListingPage.ts b/vtex/loaders/intelligentSearch/productListingPage.ts
index 9a65bb98d..8d9857c74 100644
--- a/vtex/loaders/intelligentSearch/productListingPage.ts
+++ b/vtex/loaders/intelligentSearch/productListingPage.ts
@@ -39,6 +39,7 @@ import type {
 } from "../../utils/types.ts";
 import { getFirstItemAvailable } from "../legacy/productListingPage.ts";
 import PLPDefaultPath from "../paths/PLPDefaultPath.ts";
+import { SpanStatusCode } from "npm:@opentelemetry/api@1.9.0";
 
 /** this type is more friendly user to fuzzy type that is 0, 1 or auto. */
 export type LabelledFuzzy = "automatic" | "disabled" | "enabled";
@@ -290,168 +291,223 @@ const loader = async (
   req: Request,
   ctx: AppContext,
 ): Promise<ProductListingPage | null> => {
-  const { vcsDeprecated } = ctx;
-  const { url: baseUrl } = req;
-  const url = new URL(props.pageHref || baseUrl);
-  const segment = getSegmentFromBag(ctx);
-  const currentPageoffset = props.pageOffset ?? 1;
-  const { selectedFacets: baseSelectedFacets, page, ...args } = searchArgsOf(
-    props,
-    url,
-    ctx,
-  );
-  let pathToUse = url.href.replace(url.origin, "");
+  const start = performance.now();
+  const span = ctx.monitoring?.tracer.startSpan("intelligent-search-metrics");
+  try {
+    const { vcsDeprecated } = ctx;
+    const { url: baseUrl } = req;
+    const url = new URL(props.pageHref || baseUrl);
+    const segment = getSegmentFromBag(ctx);
+    const currentPageoffset = props.pageOffset ?? 1;
+    const { selectedFacets: baseSelectedFacets, page, ...args } = searchArgsOf(
+      props,
+      url,
+      ctx,
+    );
+    let pathToUse = url.href.replace(url.origin, "");
 
-  if (pathToUse === "/" || pathToUse === "/*") {
-    const result = await PLPDefaultPath({ level: 1 }, req, ctx);
-    pathToUse = result?.possiblePaths[0] ?? pathToUse;
-  }
+    if (pathToUse === "/" || pathToUse === "/*") {
+      const result = await PLPDefaultPath({ level: 1 }, req, ctx);
+      pathToUse = result?.possiblePaths[0] ?? pathToUse;
+    }
 
-  const allPageTypes = await pageTypesFromUrl(pathToUse, ctx);
-  const pageTypes = getValidTypesFromPageTypes(allPageTypes);
+    const pageTypesStart = performance.now();
+    const allPageTypes = await pageTypesFromUrl(pathToUse, ctx);
+    const pageTypes = getValidTypesFromPageTypes(allPageTypes);
+    const pageTypesEnd = performance.now();
+    span?.setAttribute(
+      "page-types-time",
+      (pageTypesEnd - pageTypesStart).toString(),
+    );
 
-  const selectedFacets = baseSelectedFacets.length === 0
-    ? filtersFromPathname(pageTypes)
-    : baseSelectedFacets;
-  const selected = withDefaultFacets(selectedFacets, ctx);
-  const fselected = props.priceFacets
-    ? selected
-    : selected.filter((f) => f.key !== "price");
-  const isInSeachFormat = Boolean(selected.length) || Boolean(args.query);
-  const pathQuery = queryFromPathname(isInSeachFormat, pageTypes, url.pathname);
-  const searchArgs = { ...args, query: args.query || pathQuery };
-  if (!isInSeachFormat && !pathQuery) {
-    return null;
-  }
+    const selectedFacets = baseSelectedFacets.length === 0
+      ? filtersFromPathname(pageTypes)
+      : baseSelectedFacets;
+    const selected = withDefaultFacets(selectedFacets, ctx);
+    const fselected = props.priceFacets
+      ? selected
+      : selected.filter((f) => f.key !== "price");
+    const isInSeachFormat = Boolean(selected.length) || Boolean(args.query);
+    const pathQuery = queryFromPathname(
+      isInSeachFormat,
+      pageTypes,
+      url.pathname,
+    );
+    const searchArgs = { ...args, query: args.query || pathQuery };
+    if (!isInSeachFormat && !pathQuery) {
+      return null;
+    }
 
-  const locale = segment?.payload?.cultureInfo ??
-    ctx.defaultSegment?.cultureInfo ?? "pt-BR";
+    const locale = segment?.payload?.cultureInfo ??
+      ctx.defaultSegment?.cultureInfo ?? "pt-BR";
 
-  const params = withDefaultParams({ ...searchArgs, page, locale });
+    const params = withDefaultParams({ ...searchArgs, page, locale });
+    span?.setAttribute("simulationBehavior", searchArgs.simulationBehavior);
 
-  // search products on VTEX. Feel free to change any of these parameters
-  const [productsResult, facetsResult] = await Promise.all([
-    vcsDeprecated
-      ["GET /api/io/_v/api/intelligent-search/product_search/*facets"]({
+    const productsStart = performance.now();
+    // search products on VTEX. Feel free to change any of these parameters
+    const [productsResult, facetsResult] = await Promise.all([
+      vcsDeprecated
+        ["GET /api/io/_v/api/intelligent-search/product_search/*facets"]({
+          ...params,
+          facets: toPath(selected),
+        }, {
+          ...STALE,
+          headers: segment ? withSegmentCookie(segment) : undefined,
+        }).then((res) => {
+          span?.setAttribute(
+            "fetch-products-time",
+            (performance.now() - productsStart).toString(),
+          );
+          span?.setAttribute("fetch-products-status", res.status.toString());
+          return res.json();
+        }),
+      vcsDeprecated["GET /api/io/_v/api/intelligent-search/facets/*facets"]({
         ...params,
-        facets: toPath(selected),
+        facets: toPath(fselected),
       }, {
         ...STALE,
         headers: segment ? withSegmentCookie(segment) : undefined,
-      }).then((res) => res.json()),
-    vcsDeprecated["GET /api/io/_v/api/intelligent-search/facets/*facets"]({
-      ...params,
-      facets: toPath(fselected),
-    }, { ...STALE, headers: segment ? withSegmentCookie(segment) : undefined })
-      .then((res) => res.json()),
-  ]);
+      })
+        .then((res) => {
+          span?.setAttribute(
+            "fetch-facets-time",
+            (performance.now() - productsStart).toString(),
+          );
+          span?.setAttribute("fetch-facets-status", res.status.toString());
+          return res.json();
+        }),
+    ]);
+    const productsEnd = performance.now();
+    span?.setAttribute(
+      "products-total-time",
+      (productsEnd - productsStart).toString(),
+    );
 
-  const currentPageTypes = !props.useCollectionName
-    ? pageTypes
-    : pageTypes.map((pageType) => {
-      if (pageType.id !== pageTypes.at(-1)?.id) return pageType;
+    const currentPageTypes = !props.useCollectionName
+      ? pageTypes
+      : pageTypes.map((pageType) => {
+        if (pageType.id !== pageTypes.at(-1)?.id) return pageType;
 
-      const name = productsResult?.products?.[0]?.productClusters?.find(
-        (collection) => collection.id === pageType.name,
-      )?.name ?? pageType.name;
+        const name = productsResult?.products?.[0]?.productClusters?.find(
+          (collection) => collection.id === pageType.name,
+        )?.name ?? pageType.name;
 
-      return {
-        ...pageType,
-        name,
-      };
-    });
+        return {
+          ...pageType,
+          name,
+        };
+      });
 
-  // It is a feature from Intelligent Search on VTEX panel
-  // redirect to a specific page based on configured rules
-  if (productsResult.redirect) {
-    redirect(
-      new URL(productsResult.redirect, url.origin)
-        .href,
-    );
-  }
-  /** Intelligent search API analytics. Fire and forget 🔫 */
-  const fullTextTerm = params["query"];
-  if (fullTextTerm) {
-    sendEvent({ type: "session.ping", url: url.href }, req, ctx)
-      .then(() =>
-        sendEvent(
-          {
-            type: "search.query",
-            text: fullTextTerm,
-            misspelled: productsResult.correction?.misspelled ?? false,
-            match: productsResult.recordsFiltered,
-            operator: productsResult.operator,
-            locale: segment?.payload?.cultureInfo ?? "pt-BR",
-            url: url.href,
-          },
-          req,
-          ctx,
+    // It is a feature from Intelligent Search on VTEX panel
+    // redirect to a specific page based on configured rules
+    if (productsResult.redirect) {
+      redirect(
+        new URL(productsResult.redirect, url.origin)
+          .href,
+      );
+    }
+    /** Intelligent search API analytics. Fire and forget 🔫 */
+    const fullTextTerm = params["query"];
+    if (fullTextTerm) {
+      sendEvent({ type: "session.ping", url: url.href }, req, ctx)
+        .then(() =>
+          sendEvent(
+            {
+              type: "search.query",
+              text: fullTextTerm,
+              misspelled: productsResult.correction?.misspelled ?? false,
+              match: productsResult.recordsFiltered,
+              operator: productsResult.operator,
+              locale: segment?.payload?.cultureInfo ?? "pt-BR",
+              url: url.href,
+            },
+            req,
+            ctx,
+          )
         )
-      )
-      .catch(console.error);
-  }
-  const { products: vtexProducts, pagination, recordsFiltered } =
-    productsResult;
-  const facets = selectPriceFacet(facetsResult.facets, selectedFacets);
-  // Transform VTEX product format into schema.org's compatible format
-  // If a property is missing from the final `products` array you can add
-  // it in here
-  const products = await Promise.all(
-    vtexProducts
-      .map((p) =>
-        toProduct(p, p.items.find(getFirstItemAvailable) || p.items[0], 0, {
-          baseUrl: baseUrl,
-          priceCurrency: segment?.payload?.currencyCode ?? "BRL",
-          includeOriginalAttributes: props.advancedConfigs
-            ?.includeOriginalAttributes,
-        })
-      )
-      .map((product) =>
-        props.similars ? withIsSimilarTo(req, ctx, product) : product
-      ),
-  );
-  const paramsToPersist = new URLSearchParams();
-  searchArgs.query && paramsToPersist.set("q", searchArgs.query);
-  searchArgs.sort && paramsToPersist.set("sort", searchArgs.sort);
-  const filters = facets
-    .filter((f) => !f.hidden)
-    .map(toFilter(selectedFacets, paramsToPersist));
-  const itemListElement = pageTypesToBreadcrumbList(pageTypes, baseUrl);
-  const hasNextPage = Boolean(pagination.next.proxyUrl);
-  const hasPreviousPage = page > 0;
-  const nextPage = new URLSearchParams(url.searchParams);
-  const previousPage = new URLSearchParams(url.searchParams);
-  if (hasNextPage) {
-    nextPage.set("page", (page + currentPageoffset + 1).toString());
-  }
-  if (hasPreviousPage) {
-    previousPage.set("page", (page + currentPageoffset - 1).toString());
+        .catch(console.error);
+    }
+    const { products: vtexProducts, pagination, recordsFiltered } =
+      productsResult;
+    const facets = selectPriceFacet(facetsResult.facets, selectedFacets);
+    // Transform VTEX product format into schema.org's compatible format
+    // If a property is missing from the final `products` array you can add
+    // it in here
+    const similarStart = performance.now();
+    const products = await Promise.all(
+      vtexProducts
+        .map((p) =>
+          toProduct(p, p.items.find(getFirstItemAvailable) || p.items[0], 0, {
+            baseUrl: baseUrl,
+            priceCurrency: segment?.payload?.currencyCode ?? "BRL",
+            includeOriginalAttributes: props.advancedConfigs
+              ?.includeOriginalAttributes,
+          })
+        )
+        .map((product) =>
+          props.similars ? withIsSimilarTo(req, ctx, product) : product
+        ),
+    );
+    const similarEnd = performance.now();
+    span?.setAttribute(
+      "similar-products-time",
+      (similarEnd - similarStart).toString(),
+    );
+    const paramsToPersist = new URLSearchParams();
+    searchArgs.query && paramsToPersist.set("q", searchArgs.query);
+    searchArgs.sort && paramsToPersist.set("sort", searchArgs.sort);
+    const filters = facets
+      .filter((f) => !f.hidden)
+      .map(toFilter(selectedFacets, paramsToPersist));
+    const itemListElement = pageTypesToBreadcrumbList(pageTypes, baseUrl);
+    const hasNextPage = Boolean(pagination.next.proxyUrl);
+    const hasPreviousPage = page > 0;
+    const nextPage = new URLSearchParams(url.searchParams);
+    const previousPage = new URLSearchParams(url.searchParams);
+    if (hasNextPage) {
+      nextPage.set("page", (page + currentPageoffset + 1).toString());
+    }
+    if (hasPreviousPage) {
+      previousPage.set("page", (page + currentPageoffset - 1).toString());
+    }
+    const currentPage = page + currentPageoffset;
+    const end = performance.now();
+    span?.setAttribute("total-time", (end - start).toString());
+    span?.setStatus({ code: SpanStatusCode.OK });
+    return {
+      "@type": "ProductListingPage",
+      breadcrumb: {
+        "@type": "BreadcrumbList",
+        itemListElement,
+        numberOfItems: itemListElement.length,
+      },
+      filters,
+      products,
+      pageInfo: {
+        nextPage: hasNextPage ? `?${nextPage}` : undefined,
+        previousPage: hasPreviousPage ? `?${previousPage}` : undefined,
+        currentPage,
+        records: recordsFiltered,
+        recordPerPage: pagination.perPage,
+        pageTypes: allPageTypes.map(parsePageType),
+      },
+      sortOptions,
+      seo: safeJsonSerialize(pageTypesToSeo(
+        currentPageTypes,
+        baseUrl,
+        hasPreviousPage ? currentPage : undefined,
+      )),
+    };
+  } catch (error) {
+    span?.setStatus({
+      code: SpanStatusCode.ERROR,
+      message: (error as Error).message,
+    });
+    throw error;
+  } finally {
+    span?.end();
   }
-  const currentPage = page + currentPageoffset;
-  return {
-    "@type": "ProductListingPage",
-    breadcrumb: {
-      "@type": "BreadcrumbList",
-      itemListElement,
-      numberOfItems: itemListElement.length,
-    },
-    filters,
-    products,
-    pageInfo: {
-      nextPage: hasNextPage ? `?${nextPage}` : undefined,
-      previousPage: hasPreviousPage ? `?${previousPage}` : undefined,
-      currentPage,
-      records: recordsFiltered,
-      recordPerPage: pagination.perPage,
-      pageTypes: allPageTypes.map(parsePageType),
-    },
-    sortOptions,
-    seo: safeJsonSerialize(pageTypesToSeo(
-      currentPageTypes,
-      baseUrl,
-      hasPreviousPage ? currentPage : undefined,
-    )),
-  };
 };
 export const cache = "stale-while-revalidate";
 export const cacheKey = (props: Props, req: Request, ctx: AppContext) => {

From 42e2f813bc4684b697a50a55c05ad5b86b722d70 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Fri, 13 Jun 2025 13:46:52 -0400
Subject: [PATCH 43/93] feat: add some attributes

---
 vtex/loaders/intelligentSearch/productListingPage.ts | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/vtex/loaders/intelligentSearch/productListingPage.ts b/vtex/loaders/intelligentSearch/productListingPage.ts
index 8d9857c74..1934a1b86 100644
--- a/vtex/loaders/intelligentSearch/productListingPage.ts
+++ b/vtex/loaders/intelligentSearch/productListingPage.ts
@@ -297,6 +297,7 @@ const loader = async (
     const { vcsDeprecated } = ctx;
     const { url: baseUrl } = req;
     const url = new URL(props.pageHref || baseUrl);
+    span?.setAttribute("url", url.href);
     const segment = getSegmentFromBag(ctx);
     const currentPageoffset = props.pageOffset ?? 1;
     const { selectedFacets: baseSelectedFacets, page, ...args } = searchArgsOf(
@@ -343,6 +344,7 @@ const loader = async (
 
     const params = withDefaultParams({ ...searchArgs, page, locale });
     span?.setAttribute("simulationBehavior", searchArgs.simulationBehavior);
+    span?.setAttribute("isSearch", isInSeachFormat ? "true" : "false");
 
     const productsStart = performance.now();
     // search products on VTEX. Feel free to change any of these parameters

From 5e3fd8592184bbfe740f80a2935e0e72531ddad0 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Wed, 6 Aug 2025 14:58:17 -0400
Subject: [PATCH 44/93] use other PLP api

---
 .../intelligentSearch/productListingPage.ts   |  8 ++---
 vtex/mod.ts                                   | 34 +++++++++++--------
 2 files changed, 24 insertions(+), 18 deletions(-)

diff --git a/vtex/loaders/intelligentSearch/productListingPage.ts b/vtex/loaders/intelligentSearch/productListingPage.ts
index 1934a1b86..81429e679 100644
--- a/vtex/loaders/intelligentSearch/productListingPage.ts
+++ b/vtex/loaders/intelligentSearch/productListingPage.ts
@@ -1,4 +1,5 @@
 import { redirect } from "@deco/deco";
+import { SpanStatusCode } from "npm:@opentelemetry/api@1.9.0";
 import type { ProductListingPage } from "../../../commerce/types.ts";
 import { parseRange } from "../../../commerce/utils/filters.ts";
 import { STALE } from "../../../utils/fetch.ts";
@@ -39,7 +40,6 @@ import type {
 } from "../../utils/types.ts";
 import { getFirstItemAvailable } from "../legacy/productListingPage.ts";
 import PLPDefaultPath from "../paths/PLPDefaultPath.ts";
-import { SpanStatusCode } from "npm:@opentelemetry/api@1.9.0";
 
 /** this type is more friendly user to fuzzy type that is 0, 1 or auto. */
 export type LabelledFuzzy = "automatic" | "disabled" | "enabled";
@@ -294,7 +294,7 @@ const loader = async (
   const start = performance.now();
   const span = ctx.monitoring?.tracer.startSpan("intelligent-search-metrics");
   try {
-    const { vcsDeprecated } = ctx;
+    const { vcsDeprecated, alscom } = ctx;
     const { url: baseUrl } = req;
     const url = new URL(props.pageHref || baseUrl);
     span?.setAttribute("url", url.href);
@@ -349,7 +349,7 @@ const loader = async (
     const productsStart = performance.now();
     // search products on VTEX. Feel free to change any of these parameters
     const [productsResult, facetsResult] = await Promise.all([
-      vcsDeprecated
+      alscom
         ["GET /api/io/_v/api/intelligent-search/product_search/*facets"]({
           ...params,
           facets: toPath(selected),
@@ -364,7 +364,7 @@ const loader = async (
           span?.setAttribute("fetch-products-status", res.status.toString());
           return res.json();
         }),
-      vcsDeprecated["GET /api/io/_v/api/intelligent-search/facets/*facets"]({
+      alscom["GET /api/io/_v/api/intelligent-search/facets/*facets"]({
         ...params,
         facets: toPath(fselected),
       }, {
diff --git a/vtex/mod.ts b/vtex/mod.ts
index b21f5784d..440e43289 100644
--- a/vtex/mod.ts
+++ b/vtex/mod.ts
@@ -1,26 +1,27 @@
+import {
+  type App as A,
+  type AppContext as AC,
+  type AppMiddlewareContext as AMC,
+  type AppRuntime,
+  asResolved,
+  type ManifestOf,
+} from "@deco/deco";
+import { Matcher } from "@deco/deco/blocks";
+import { Markdown } from "../decohub/components/Markdown.tsx";
 import { createGraphqlClient } from "../utils/graphql.ts";
 import { createHttpClient } from "../utils/http.ts";
+import { removeDirtyCookies } from "../utils/normalize.ts";
+import type { Secret } from "../website/loaders/secret.ts";
 import workflow from "../workflows/mod.ts";
 import manifest, { Manifest } from "./manifest.gen.ts";
 import { middleware } from "./middleware.ts";
+import { PreviewVtex } from "./preview/Preview.tsx";
 import { SP, VTEXCommerceStable } from "./utils/client.ts";
 import { fetchSafe } from "./utils/fetchVTEX.ts";
-import { OpenAPI as VCS } from "./utils/openapi/vcs.openapi.gen.ts";
 import { OpenAPI as API } from "./utils/openapi/api.openapi.gen.ts";
 import { OpenAPI as MY } from "./utils/openapi/my.openapi.gen.ts";
+import { OpenAPI as VCS } from "./utils/openapi/vcs.openapi.gen.ts";
 import { Segment } from "./utils/types.ts";
-import type { Secret } from "../website/loaders/secret.ts";
-import { removeDirtyCookies } from "../utils/normalize.ts";
-import { Markdown } from "../decohub/components/Markdown.tsx";
-import { PreviewVtex } from "./preview/Preview.tsx";
-import {
-  type App as A,
-  type AppContext as AC,
-  type AppMiddlewareContext as AMC,
-  type AppRuntime,
-  asResolved,
-  type ManifestOf,
-} from "@deco/deco";
 export type App = ReturnType<typeof VTEX>;
 export type AppContext = AC<App>;
 export type AppManifest = ManifestOf<App>;
@@ -37,7 +38,6 @@ export type SegmentCulture = Omit<
   | "priceTables"
   | "regionId"
 >;
-import { Matcher } from "@deco/deco/blocks";
 
 /** @title VTEX */
 export interface Props {
@@ -121,6 +121,11 @@ export default function VTEX(
     processHeaders: removeDirtyCookies,
     fetcher: fetchSafe,
   });
+  const alscom = createHttpClient<VTEXCommerceStable>({
+    base: "https://als.com",
+    processHeaders: removeDirtyCookies,
+    fetcher: fetchSafe,
+  });
   const io = createGraphqlClient({
     endpoint:
       `https://${account}.vtexcommercestable.com.br/api/io/_v/private/graphql/v1`,
@@ -150,6 +155,7 @@ export default function VTEX(
     vcs,
     my,
     api,
+    alscom,
   };
   const app: A<Manifest, typeof state, [
     ReturnType<typeof workflow>,

From c57316b707e33a1204d8f20b7b1d560fd64b94cd Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Wed, 6 Aug 2025 16:19:42 -0400
Subject: [PATCH 45/93] refactor: use secure url to fetch products

---
 vtex/loaders/intelligentSearch/productListingPage.ts | 6 +++---
 vtex/mod.ts                                          | 6 +++---
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/vtex/loaders/intelligentSearch/productListingPage.ts b/vtex/loaders/intelligentSearch/productListingPage.ts
index 81429e679..92f8a92f8 100644
--- a/vtex/loaders/intelligentSearch/productListingPage.ts
+++ b/vtex/loaders/intelligentSearch/productListingPage.ts
@@ -294,7 +294,7 @@ const loader = async (
   const start = performance.now();
   const span = ctx.monitoring?.tracer.startSpan("intelligent-search-metrics");
   try {
-    const { vcsDeprecated, alscom } = ctx;
+    const { secureAPI } = ctx;
     const { url: baseUrl } = req;
     const url = new URL(props.pageHref || baseUrl);
     span?.setAttribute("url", url.href);
@@ -349,7 +349,7 @@ const loader = async (
     const productsStart = performance.now();
     // search products on VTEX. Feel free to change any of these parameters
     const [productsResult, facetsResult] = await Promise.all([
-      alscom
+      secureAPI
         ["GET /api/io/_v/api/intelligent-search/product_search/*facets"]({
           ...params,
           facets: toPath(selected),
@@ -364,7 +364,7 @@ const loader = async (
           span?.setAttribute("fetch-products-status", res.status.toString());
           return res.json();
         }),
-      alscom["GET /api/io/_v/api/intelligent-search/facets/*facets"]({
+      secureAPI["GET /api/io/_v/api/intelligent-search/facets/*facets"]({
         ...params,
         facets: toPath(fselected),
       }, {
diff --git a/vtex/mod.ts b/vtex/mod.ts
index 440e43289..72bf61b5d 100644
--- a/vtex/mod.ts
+++ b/vtex/mod.ts
@@ -121,8 +121,8 @@ export default function VTEX(
     processHeaders: removeDirtyCookies,
     fetcher: fetchSafe,
   });
-  const alscom = createHttpClient<VTEXCommerceStable>({
-    base: "https://als.com",
+  const secureAPI = createHttpClient<VTEXCommerceStable>({
+    base: publicUrl.startsWith("http") ? publicUrl : `https://${publicUrl}`,
     processHeaders: removeDirtyCookies,
     fetcher: fetchSafe,
   });
@@ -155,7 +155,7 @@ export default function VTEX(
     vcs,
     my,
     api,
-    alscom,
+    secureAPI,
   };
   const app: A<Manifest, typeof state, [
     ReturnType<typeof workflow>,

From d1f88f9f9a2202e5cd14e7372ad85c615fb2e303 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Thu, 7 Aug 2025 11:39:51 -0400
Subject: [PATCH 46/93] feat: use public url as base url

---
 vtex/loaders/intelligentSearch/productListingPage.ts | 6 +++---
 vtex/mod.ts                                          | 8 +-------
 2 files changed, 4 insertions(+), 10 deletions(-)

diff --git a/vtex/loaders/intelligentSearch/productListingPage.ts b/vtex/loaders/intelligentSearch/productListingPage.ts
index 92f8a92f8..9ec4aafa6 100644
--- a/vtex/loaders/intelligentSearch/productListingPage.ts
+++ b/vtex/loaders/intelligentSearch/productListingPage.ts
@@ -294,7 +294,7 @@ const loader = async (
   const start = performance.now();
   const span = ctx.monitoring?.tracer.startSpan("intelligent-search-metrics");
   try {
-    const { secureAPI } = ctx;
+    const { vcsDeprecated } = ctx;
     const { url: baseUrl } = req;
     const url = new URL(props.pageHref || baseUrl);
     span?.setAttribute("url", url.href);
@@ -349,7 +349,7 @@ const loader = async (
     const productsStart = performance.now();
     // search products on VTEX. Feel free to change any of these parameters
     const [productsResult, facetsResult] = await Promise.all([
-      secureAPI
+      vcsDeprecated
         ["GET /api/io/_v/api/intelligent-search/product_search/*facets"]({
           ...params,
           facets: toPath(selected),
@@ -364,7 +364,7 @@ const loader = async (
           span?.setAttribute("fetch-products-status", res.status.toString());
           return res.json();
         }),
-      secureAPI["GET /api/io/_v/api/intelligent-search/facets/*facets"]({
+      vcsDeprecated["GET /api/io/_v/api/intelligent-search/facets/*facets"]({
         ...params,
         facets: toPath(fselected),
       }, {
diff --git a/vtex/mod.ts b/vtex/mod.ts
index 72bf61b5d..dbf0ee56f 100644
--- a/vtex/mod.ts
+++ b/vtex/mod.ts
@@ -117,11 +117,6 @@ export default function VTEX(
     fetcher: fetchSafe,
   });
   const vcsDeprecated = createHttpClient<VTEXCommerceStable>({
-    base: `https://${account}.vtexcommercestable.com.br`,
-    processHeaders: removeDirtyCookies,
-    fetcher: fetchSafe,
-  });
-  const secureAPI = createHttpClient<VTEXCommerceStable>({
     base: publicUrl.startsWith("http") ? publicUrl : `https://${publicUrl}`,
     processHeaders: removeDirtyCookies,
     fetcher: fetchSafe,
@@ -133,7 +128,7 @@ export default function VTEX(
     fetcher: fetchSafe,
   });
   const vcs = createHttpClient<VCS>({
-    base: `https://${account}.vtexcommercestable.com.br`,
+    base: publicUrl.startsWith("http") ? publicUrl : `https://${publicUrl}`,
     fetcher: fetchSafe,
     processHeaders: removeDirtyCookies,
     headers: headers,
@@ -155,7 +150,6 @@ export default function VTEX(
     vcs,
     my,
     api,
-    secureAPI,
   };
   const app: A<Manifest, typeof state, [
     ReturnType<typeof workflow>,

From ab46a2a937ce87e09cbb2d8c9b6b9607d6f9ebc8 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Mon, 11 Aug 2025 20:34:33 -0400
Subject: [PATCH 47/93] refactor

---
 vtex/loaders/intelligentSearch/productListingPage.ts | 6 +++---
 vtex/mod.ts                                          | 9 ++++++++-
 2 files changed, 11 insertions(+), 4 deletions(-)

diff --git a/vtex/loaders/intelligentSearch/productListingPage.ts b/vtex/loaders/intelligentSearch/productListingPage.ts
index 9ec4aafa6..d7578977e 100644
--- a/vtex/loaders/intelligentSearch/productListingPage.ts
+++ b/vtex/loaders/intelligentSearch/productListingPage.ts
@@ -294,7 +294,7 @@ const loader = async (
   const start = performance.now();
   const span = ctx.monitoring?.tracer.startSpan("intelligent-search-metrics");
   try {
-    const { vcsDeprecated } = ctx;
+    const { secure } = ctx;
     const { url: baseUrl } = req;
     const url = new URL(props.pageHref || baseUrl);
     span?.setAttribute("url", url.href);
@@ -349,7 +349,7 @@ const loader = async (
     const productsStart = performance.now();
     // search products on VTEX. Feel free to change any of these parameters
     const [productsResult, facetsResult] = await Promise.all([
-      vcsDeprecated
+      secure
         ["GET /api/io/_v/api/intelligent-search/product_search/*facets"]({
           ...params,
           facets: toPath(selected),
@@ -364,7 +364,7 @@ const loader = async (
           span?.setAttribute("fetch-products-status", res.status.toString());
           return res.json();
         }),
-      vcsDeprecated["GET /api/io/_v/api/intelligent-search/facets/*facets"]({
+      secure["GET /api/io/_v/api/intelligent-search/facets/*facets"]({
         ...params,
         facets: toPath(fselected),
       }, {
diff --git a/vtex/mod.ts b/vtex/mod.ts
index dbf0ee56f..dbca81cea 100644
--- a/vtex/mod.ts
+++ b/vtex/mod.ts
@@ -117,7 +117,7 @@ export default function VTEX(
     fetcher: fetchSafe,
   });
   const vcsDeprecated = createHttpClient<VTEXCommerceStable>({
-    base: publicUrl.startsWith("http") ? publicUrl : `https://${publicUrl}`,
+    base: `https://${account}.vtexcommercestable.com.br`,
     processHeaders: removeDirtyCookies,
     fetcher: fetchSafe,
   });
@@ -128,6 +128,12 @@ export default function VTEX(
     fetcher: fetchSafe,
   });
   const vcs = createHttpClient<VCS>({
+    base: `https://${account}.vtexcommercestable.com.br`,
+    fetcher: fetchSafe,
+    processHeaders: removeDirtyCookies,
+    headers: headers,
+  });
+  const secure = createHttpClient<VTEXCommerceStable>({
     base: publicUrl.startsWith("http") ? publicUrl : `https://${publicUrl}`,
     fetcher: fetchSafe,
     processHeaders: removeDirtyCookies,
@@ -150,6 +156,7 @@ export default function VTEX(
     vcs,
     my,
     api,
+    secure,
   };
   const app: A<Manifest, typeof state, [
     ReturnType<typeof workflow>,

From 4821acfe012b72b65e1cbdf3bdcd6541e68848cb Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Sun, 7 Sep 2025 14:59:18 -0400
Subject: [PATCH 48/93] chore


From b47e24c9d3a2d7b73b34392d6ba181b133421524 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Sun, 7 Sep 2025 17:04:32 -0400
Subject: [PATCH 49/93] Dont send abort controller if not async render

---
 website/handlers/fresh.ts | 160 +++++++++++++++++++++++++++++++++++---
 1 file changed, 148 insertions(+), 12 deletions(-)

diff --git a/website/handlers/fresh.ts b/website/handlers/fresh.ts
index 626c68e1d..7e61896a8 100644
--- a/website/handlers/fresh.ts
+++ b/website/handlers/fresh.ts
@@ -26,7 +26,18 @@ export const isFreshCtx = <TState>(
 ): ctx is HandlerContext<unknown, TState> => {
   return typeof (ctx as HandlerContext).render === "function";
 };
-function abortHandler(ctrl: AbortController, signal: AbortSignal) {
+function abortHandler(
+  ctrl: AbortController,
+  signal: AbortSignal,
+  info?: {
+    url?: string;
+    startedAt?: number;
+    pathTemplate?: string;
+    userAgent?: string;
+    referer?: string;
+    completed?: () => boolean;
+  },
+) {
   let aborted = false;
   const abortCtrlInstance = () => {
     if (aborted) {
@@ -34,6 +45,28 @@ function abortHandler(ctrl: AbortController, signal: AbortSignal) {
     }
     try {
       if (!ctrl.signal.aborted) {
+        const skipLog =
+          (typeof info?.completed === "function" && info.completed()) ||
+          (info?.url?.startsWith("/.well-known")) ||
+          (info?.url?.endsWith(".css")) ||
+          (info?.url?.endsWith(".map"));
+
+        const elapsed = info?.startedAt
+          ? (Date.now() - info.startedAt)
+          : undefined;
+        if (!skipLog) {
+          console.warn(
+            `[fresh][request-abort] aborting loaders due to incoming request abort` +
+              (info?.url ? ` url=${info.url}` : "") +
+              (info?.pathTemplate ? ` pathTemplate=${info.pathTemplate}` : "") +
+              (info?.userAgent ? ` ua=${JSON.stringify(info.userAgent)}` : "") +
+              (info?.referer
+                ? ` referer=${JSON.stringify(info.referer)}`
+                : "") +
+              (elapsed !== undefined ? ` elapsedMs=${elapsed}` : "") +
+              ` known=true reason=incoming-request-abort`,
+          );
+        }
         ctrl?.abort();
         aborted = true; // Mark as aborted after calling abort
       }
@@ -46,10 +79,12 @@ function abortHandler(ctrl: AbortController, signal: AbortSignal) {
   return abortCtrlInstance;
 }
 function registerFinilizer(req: Request, abortCtrl: () => void) {
-  const finalizer = new FinalizationRegistry((abortCtrl: () => void) => {
-    req.signal.removeEventListener("abort", abortCtrl);
-  });
-  finalizer.register(req, abortCtrl);
+  const finalizationRegistry = new FinalizationRegistry(
+    (abortCtrl: () => void) => {
+      req.signal.removeEventListener("abort", abortCtrl);
+    },
+  );
+  finalizationRegistry.register(req, abortCtrl);
 }
 /**
  * @title Fresh Page
@@ -72,16 +107,20 @@ export default function Fresh(
       return new Response(null, { status: 200 });
     }
     const timing = appContext?.monitoring?.timings?.start?.("load-data");
+    let didFinish = false;
     const url = new URL(req.url);
+    const startedAt = Date.now();
     const asJson = url.searchParams.get("asJson");
     const delayFromProps = appContext.firstByteThresholdMS ? 1 : 0;
     const delay = Number(url.searchParams.get(__DECO_FBT) ?? delayFromProps);
     /** Controller to abort third party fetch (loaders) */
     const ctrl = new AbortController();
-    const abortCtrl = abortHandler(ctrl, req.signal);
-    /** Aborts when: Incomming request is aborted */
-    req.signal.addEventListener("abort", abortCtrl, { once: true });
-    registerFinilizer(req, abortCtrl);
+    const pathTemplate = isFreshCtx<DecoState>(ctx)
+      // deno-lint-ignore no-explicit-any
+      ? (ctx as any).state?.pathTemplate
+      : undefined;
+    // Only wire request-abort propagation when async render (firstByteThreshold) is in effect.
+    let abortCtrl: (() => void) | undefined;
     /**
      * Aborts when:
      *
@@ -90,8 +129,41 @@ export default function Fresh(
      * 3. Is not a bot (bot requires the whole page html for boosting SEO)
      */
     const firstByteThreshold = !asJson && delay && !appContext.isBot
-      ? delay === 1 ? ctrl.abort() : setTimeout(() => ctrl.abort(), delay)
+      ? (delay === 1
+        ? (() => {
+          console.warn(
+            `[fresh][async-render-abort] aborting loaders immediately due to firstByteThreshold` +
+              ` delay=${delay} url=${url.pathname}${url.search}` +
+              (pathTemplate ? ` pathTemplate=${pathTemplate}` : "") +
+              ` known=true reason=first-byte-threshold stage=loaders`,
+          );
+          ctrl.abort();
+          return undefined;
+        })()
+        : setTimeout(() => {
+          console.warn(
+            `[fresh][async-render-abort] aborting loaders after ${delay}ms due to firstByteThreshold` +
+              ` url=${url.pathname}${url.search}` +
+              (pathTemplate ? ` pathTemplate=${pathTemplate}` : "") +
+              ` known=true reason=first-byte-threshold stage=loaders`,
+          );
+          ctrl.abort();
+        }, delay))
       : undefined;
+
+    // Propagate client aborts to loaders only when async render is enabled
+    if (!asJson && delay && !appContext.isBot) {
+      abortCtrl = abortHandler(ctrl, req.signal, {
+        url: `${url.pathname}${url.search}`,
+        startedAt,
+        pathTemplate,
+        userAgent: req.headers.get("user-agent") ?? undefined,
+        referer: req.headers.get("referer") ?? undefined,
+        completed: () => didFinish,
+      });
+      req.signal.addEventListener("abort", abortCtrl, { once: true });
+      registerFinilizer(req, abortCtrl);
+    }
     try {
       const getPage = RequestContext.bind(
         { signal: ctrl.signal },
@@ -120,9 +192,39 @@ export default function Fresh(
         "load-data",
         async (span) => {
           try {
+            span?.setAttribute?.("http.target", `${url.pathname}${url.search}`);
+            if (pathTemplate) {
+              span?.setAttribute?.("deco.path_template", pathTemplate);
+            }
+            if (delay && !asJson && !appContext.isBot) {
+              span?.setAttribute?.(
+                "deco.async_render.first_byte_threshold_ms",
+                delay,
+              );
+            }
             return await getPage();
           } catch (e) {
-            span.recordException(e as Exception);
+            span?.setAttribute?.("error.path", `${url.pathname}${url.search}`);
+            if (pathTemplate) {
+              span?.setAttribute?.("error.path_template", pathTemplate);
+            }
+            const isKnownAbort =
+              (e as { name?: string })?.name === "AbortError" &&
+              ctrl.signal.aborted;
+            if (isKnownAbort) {
+              span?.setAttribute?.("deco.abort.known", true);
+              span?.setAttribute?.(
+                "deco.abort.reason",
+                "async-render-or-client-abort",
+              );
+              console.warn(
+                `[fresh][known-abort] stage=load-data url=${url.pathname}${url.search}` +
+                  (pathTemplate ? ` pathTemplate=${pathTemplate}` : "") +
+                  ` known=true reason=async-render-or-client-abort`,
+              );
+            } else {
+              span.recordException(e as Exception);
+            }
             throw e;
           } finally {
             span.end();
@@ -131,6 +233,7 @@ export default function Fresh(
         },
       );
       if (asJson !== null) {
+        didFinish = true;
         return Response.json(page, { headers: allowCorsFor(req) });
       }
       if (isFreshCtx<DecoState>(ctx)) {
@@ -144,6 +247,13 @@ export default function Fresh(
           "render-to-string",
           async (span) => {
             try {
+              span?.setAttribute?.(
+                "http.target",
+                `${url.pathname}${url.search}`,
+              );
+              if (pathTemplate) {
+                span?.setAttribute?.("deco.path_template", pathTemplate);
+              }
               const response = await renderToString({
                 page: appContext.flavor && page
                   ? errorIfFrameworkMismatch(appContext.flavor?.framework, page)
@@ -154,6 +264,14 @@ export default function Fresh(
                   pagePath: ctx.state.pathTemplate,
                 },
               });
+              if (!asJson && delay && !appContext.isBot) {
+                console.info(
+                  `[fresh][async-render-response] returned initial HTML with async render` +
+                    ` url=${url.pathname}${url.search}` +
+                    (pathTemplate ? ` pathTemplate=${pathTemplate}` : "") +
+                    ` thresholdMs=${delay}`,
+                );
+              }
               const setCookies = getSetCookies(appContext.response.headers);
               if (appContext?.caching?.enabled && setCookies.length === 0) {
                 appContext.response.headers.set(
@@ -165,7 +283,20 @@ export default function Fresh(
               }
               return response;
             } catch (err) {
-              span.recordException(err as Exception);
+              const isKnownAbort =
+                (err as { name?: string })?.name === "AbortError" &&
+                ctrl.signal.aborted;
+              if (isKnownAbort) {
+                span?.setAttribute?.("deco.abort.known", true);
+                span?.setAttribute?.("deco.abort.stage", "render-to-string");
+                console.warn(
+                  `[fresh][known-abort] stage=render-to-string url=${url.pathname}${url.search}` +
+                    (pathTemplate ? ` pathTemplate=${pathTemplate}` : "") +
+                    ` known=true reason=async-render-or-client-abort`,
+                );
+              } else {
+                span.recordException(err as Exception);
+              }
               throw err;
             } finally {
               span.end();
@@ -173,8 +304,10 @@ export default function Fresh(
             }
           },
         );
+        didFinish = true;
         return response;
       }
+      didFinish = true;
       return Response.json({ message: "Fresh is not being used" }, {
         status: 500,
       });
@@ -182,6 +315,9 @@ export default function Fresh(
       if (firstByteThreshold) {
         clearTimeout(firstByteThreshold);
       }
+      if (abortCtrl) {
+        req.signal.removeEventListener("abort", abortCtrl);
+      }
     }
   };
 }

From 16f72a2d72f4977bd0844afaf8a582c40c246752 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Sun, 7 Sep 2025 17:09:43 -0400
Subject: [PATCH 50/93] fix: section can be null

---
 website/sections/Rendering/Lazy.tsx | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/website/sections/Rendering/Lazy.tsx b/website/sections/Rendering/Lazy.tsx
index ef8fa063d..65e885eef 100644
--- a/website/sections/Rendering/Lazy.tsx
+++ b/website/sections/Rendering/Lazy.tsx
@@ -63,7 +63,10 @@ const defaultFallbackFor = (section: string) => () => (
   </div>
 );
 export const loader = async (props: Props, req: Request, ctx: AppContext) => {
-  const { section, loading } = props;
+  const { section, loading } = props as {
+    loading?: "eager" | "lazy";
+    section: Section | null;
+  };
   const url = new URL(req.url);
   const shouldRender = loading === "eager" || shouldForceRender({
     ctx,
@@ -95,15 +98,19 @@ export const loader = async (props: Props, req: Request, ctx: AppContext) => {
   return {
     loading: shouldRender ? "eager" : "lazy",
     section: {
-      Component: resolvedSection.LoadingFallback ??
-        defaultFallbackFor(resolvedSection.metadata?.component ?? "unknown"),
-      metadata: resolvedSection.metadata,
+      Component: resolvedSection?.LoadingFallback ??
+        defaultFallbackFor(resolvedSection?.metadata?.component ?? "unknown"),
+      metadata: resolvedSection?.metadata,
       props: {},
     },
   };
 };
 type SectionProps = Awaited<ReturnType<typeof loader>>;
 function Lazy({ section, loading }: SectionProps) {
+  if (!section) {
+    return null;
+  }
+
   const ctx = useSectionContext();
   if (!ctx) {
     throw new Error("Missing SectionContext");

From 049aaaf2d062bc65a7a4980dfac4de8272ff0e35 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Mon, 8 Sep 2025 01:39:24 -0400
Subject: [PATCH 51/93] feat: send zip-code param to intelligent search api
 call

---
 vtex/loaders/intelligentSearch/productListingPage.ts | 2 ++
 vtex/utils/client.ts                                 | 2 ++
 vtex/utils/intelligentSearch.ts                      | 3 +++
 3 files changed, 7 insertions(+)

diff --git a/vtex/loaders/intelligentSearch/productListingPage.ts b/vtex/loaders/intelligentSearch/productListingPage.ts
index d7578977e..0aed8c937 100644
--- a/vtex/loaders/intelligentSearch/productListingPage.ts
+++ b/vtex/loaders/intelligentSearch/productListingPage.ts
@@ -203,6 +203,7 @@ const searchArgsOf = (props: Props, url: URL, ctx: AppContext) => {
   );
   const fuzzy = mapLabelledFuzzyToFuzzy(props.fuzzy) ??
     (url.searchParams.get("fuzzy") as Fuzzy);
+  const zipCode = url.searchParams.get("zip-code") ?? undefined;
   return {
     query,
     fuzzy,
@@ -212,6 +213,7 @@ const searchArgsOf = (props: Props, url: URL, ctx: AppContext) => {
     hideUnavailableItems,
     selectedFacets,
     simulationBehavior,
+    zipCode,
   };
 };
 const PAGE_TYPE_TO_MAP_PARAM = {
diff --git a/vtex/utils/client.ts b/vtex/utils/client.ts
index fe1897c59..32e98a4b3 100644
--- a/vtex/utils/client.ts
+++ b/vtex/utils/client.ts
@@ -106,6 +106,7 @@ export interface VTEXCommerceStable {
       fuzzy?: string;
       locale?: string;
       hideUnavailableItems: boolean;
+      "zip-code"?: string;
     };
   };
   "GET /api/io/_v/api/intelligent-search/facets/*facets": {
@@ -118,6 +119,7 @@ export interface VTEXCommerceStable {
       fuzzy?: string;
       locale?: string;
       hideUnavailableItems: boolean;
+      "zip-code"?: string;
     };
   };
 
diff --git a/vtex/utils/intelligentSearch.ts b/vtex/utils/intelligentSearch.ts
index d9db82d6a..5c78d3d2f 100644
--- a/vtex/utils/intelligentSearch.ts
+++ b/vtex/utils/intelligentSearch.ts
@@ -47,6 +47,7 @@ interface Params {
   locale: string;
   hideUnavailableItems: boolean;
   simulationBehavior: "default" | "skip" | "only1P";
+  zipCode?: string;
 }
 
 export const withDefaultParams = ({
@@ -58,6 +59,7 @@ export const withDefaultParams = ({
   locale = "pt-BR",
   hideUnavailableItems,
   simulationBehavior = "default",
+  zipCode,
 }: Partial<Params>) => ({
   page: page + 1,
   count,
@@ -68,6 +70,7 @@ export const withDefaultParams = ({
   // locale: locale ?? ctx.configVTEX!.defaultLocale,
   hideUnavailableItems: hideUnavailableItems ?? false,
   simulationBehavior,
+  "zip-code": zipCode,
 });
 
 const IS_ANONYMOUS = Symbol("segment");

From 45dd4bf4d6dc1ad29fb216d67a4eacce46764d88 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Wed, 17 Sep 2025 14:09:28 -0400
Subject: [PATCH 52/93] feat: enhance hideUnavailableItems handling and persist
 zip-code in search parameters

---
 .../intelligentSearch/productListingPage.ts      | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/vtex/loaders/intelligentSearch/productListingPage.ts b/vtex/loaders/intelligentSearch/productListingPage.ts
index 0aed8c937..fc172a32f 100644
--- a/vtex/loaders/intelligentSearch/productListingPage.ts
+++ b/vtex/loaders/intelligentSearch/productListingPage.ts
@@ -171,7 +171,9 @@ export interface Props {
   simulationBehavior?: "default" | "skip" | "only1P";
 }
 const searchArgsOf = (props: Props, url: URL, ctx: AppContext) => {
-  const hideUnavailableItems = props.hideUnavailableItems;
+  const hideUnavailableItems = url.searchParams.has("hideUnavailableItems")
+    ? url.searchParams.get("hideUnavailableItems") === "true"
+    : props.hideUnavailableItems;
   const simulationBehavior = getSkipSimulationBehaviorFromBag(ctx)
     ? "skip" as const
     : (url.searchParams.get("simulationBehavior") as
@@ -461,6 +463,12 @@ const loader = async (
     const paramsToPersist = new URLSearchParams();
     searchArgs.query && paramsToPersist.set("q", searchArgs.query);
     searchArgs.sort && paramsToPersist.set("sort", searchArgs.sort);
+    searchArgs.zipCode && paramsToPersist.set("zip-code", searchArgs.zipCode);
+    searchArgs.hideUnavailableItems &&
+      paramsToPersist.set(
+        "hideUnavailableItems",
+        searchArgs.hideUnavailableItems.toString(),
+      );
     const filters = facets
       .filter((f) => !f.hidden)
       .map(toFilter(selectedFacets, paramsToPersist));
@@ -527,7 +535,11 @@ export const cacheKey = (props: Props, req: Request, ctx: AppContext) => {
     ["page", (props.page ?? url.searchParams.get("page") ?? 1).toString()],
     ["sort", props.sort ?? url.searchParams.get("sort") ?? ""],
     ["fuzzy", props.fuzzy ?? url.searchParams.get("fuzzy") ?? ""],
-    ["hideUnavailableItems", props.hideUnavailableItems?.toString() ?? ""],
+    [
+      "hideUnavailableItems",
+      url.searchParams.get("hideUnavailableItems") ??
+        props.hideUnavailableItems?.toString() ?? "",
+    ],
     ["pageOffset", (props.pageOffset ?? 1).toString()],
     [
       "selectedFacets",

From 792e86cbabdefdc41d73798a9a09045d023ea3aa Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Tue, 30 Sep 2025 14:57:59 -0400
Subject: [PATCH 53/93] feat: add pickupPoint parameter and update zip-code to
 zipcode in searchArgs

---
 .../intelligentSearch/productListingPage.ts      | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/vtex/loaders/intelligentSearch/productListingPage.ts b/vtex/loaders/intelligentSearch/productListingPage.ts
index fc172a32f..82779f7db 100644
--- a/vtex/loaders/intelligentSearch/productListingPage.ts
+++ b/vtex/loaders/intelligentSearch/productListingPage.ts
@@ -205,7 +205,8 @@ const searchArgsOf = (props: Props, url: URL, ctx: AppContext) => {
   );
   const fuzzy = mapLabelledFuzzyToFuzzy(props.fuzzy) ??
     (url.searchParams.get("fuzzy") as Fuzzy);
-  const zipCode = url.searchParams.get("zip-code") ?? undefined;
+  const zipCode = url.searchParams.get("zipcode") ?? undefined;
+  const pickupPoint = url.searchParams.get("pickupPoint") ?? undefined;
   return {
     query,
     fuzzy,
@@ -216,6 +217,7 @@ const searchArgsOf = (props: Props, url: URL, ctx: AppContext) => {
     selectedFacets,
     simulationBehavior,
     zipCode,
+    pickupPoint,
   };
 };
 const PAGE_TYPE_TO_MAP_PARAM = {
@@ -463,7 +465,9 @@ const loader = async (
     const paramsToPersist = new URLSearchParams();
     searchArgs.query && paramsToPersist.set("q", searchArgs.query);
     searchArgs.sort && paramsToPersist.set("sort", searchArgs.sort);
-    searchArgs.zipCode && paramsToPersist.set("zip-code", searchArgs.zipCode);
+    searchArgs.zipCode && paramsToPersist.set("zipcode", searchArgs.zipCode);
+    searchArgs.pickupPoint &&
+      paramsToPersist.set("pickupPoint", searchArgs.pickupPoint);
     searchArgs.hideUnavailableItems &&
       paramsToPersist.set(
         "hideUnavailableItems",
@@ -555,6 +559,14 @@ export const cacheKey = (props: Props, req: Request, ctx: AppContext) => {
         ? "skip"
         : props.simulationBehavior || "default",
     ],
+    [
+      "zipcode",
+      url.searchParams.get("zipcode") ?? "",
+    ],
+    [
+      "pickupPoint",
+      url.searchParams.get("pickupPoint") ?? "",
+    ],
   ]);
   url.searchParams.forEach((value, key) => {
     if (!ALLOWED_PARAMS.has(key.toLowerCase()) && !isFilterParam(key)) {

From be88d1c5d549185dc1f2e52736bee974947bb442 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Tue, 7 Oct 2025 11:29:17 -0400
Subject: [PATCH 54/93] feat: filter delivery options from selected facets and
 merge with price facets in product search

---
 .../intelligentSearch/productListingPage.ts       | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/vtex/loaders/intelligentSearch/productListingPage.ts b/vtex/loaders/intelligentSearch/productListingPage.ts
index 82779f7db..c1566c37b 100644
--- a/vtex/loaders/intelligentSearch/productListingPage.ts
+++ b/vtex/loaders/intelligentSearch/productListingPage.ts
@@ -327,13 +327,20 @@ const loader = async (
       (pageTypesEnd - pageTypesStart).toString(),
     );
 
-    const selectedFacets = baseSelectedFacets.length === 0
+    const deliveryOptionsFacets = baseSelectedFacets.filter(({ key }) =>
+      key === "delivery-options" || key === "shipping"
+    );
+    const selectedFacets = baseSelectedFacets.filter(({ key }) =>
+        key !== "shipping" && key !== "delivery-options"
+      ).length === 0
       ? filtersFromPathname(pageTypes)
       : baseSelectedFacets;
     const selected = withDefaultFacets(selectedFacets, ctx);
     const fselected = props.priceFacets
       ? selected
-      : selected.filter((f) => f.key !== "price");
+      : selected.filter((f) =>
+        f.key !== "price"
+      );
     const isInSeachFormat = Boolean(selected.length) || Boolean(args.query);
     const pathQuery = queryFromPathname(
       isInSeachFormat,
@@ -358,7 +365,7 @@ const loader = async (
       secure
         ["GET /api/io/_v/api/intelligent-search/product_search/*facets"]({
           ...params,
-          facets: toPath(selected),
+          facets: toPath(mergeFacets(selected, deliveryOptionsFacets)),
         }, {
           ...STALE,
           headers: segment ? withSegmentCookie(segment) : undefined,
@@ -372,7 +379,7 @@ const loader = async (
         }),
       secure["GET /api/io/_v/api/intelligent-search/facets/*facets"]({
         ...params,
-        facets: toPath(fselected),
+        facets: toPath(mergeFacets(fselected, deliveryOptionsFacets)),
       }, {
         ...STALE,
         headers: segment ? withSegmentCookie(segment) : undefined,

From 31429f17acfb4073c81519ce8a6fd7d5994eb7c0 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Mon, 13 Oct 2025 16:14:56 -0400
Subject: [PATCH 55/93] feat htmx update

---
 htmx/mod.ts            | 41 ++++++++++++++---------------------------
 htmx/sections/htmx.tsx | 14 +++++++++++---
 2 files changed, 25 insertions(+), 30 deletions(-)

diff --git a/htmx/mod.ts b/htmx/mod.ts
index 0919997db..ae76d28a1 100644
--- a/htmx/mod.ts
+++ b/htmx/mod.ts
@@ -1,35 +1,20 @@
+import { type App, type FnContext } from "@deco/deco";
 import { Markdown } from "../decohub/components/Markdown.tsx";
 import { PreviewContainer } from "../utils/preview.tsx";
 import manifest, { Manifest } from "./manifest.gen.ts";
-import { type App, type FnContext } from "@deco/deco";
-export type AppContext = FnContext<Props, Manifest>;
-export type Extension =
-  | "ajax-header"
-  | "alpine-morph"
-  | "class-tools"
-  | "client-side-templates"
-  | "debug"
-  | "event-header"
-  | "head-support"
-  | "include-vals"
-  | "json-enc"
-  | "idiomorph"
-  | "loading-states"
-  | "method-override"
-  | "morphdom-swap"
-  | "multi-swap"
-  | "path-deps"
-  | "preload"
-  | "remove-me"
-  | "response-targets"
-  | "restored"
-  | "ws"
-  | "path-params"
-  | "sse";
+
+/**
+ * @title {{{name}}}
+ */
+export interface Extension {
+  name: string;
+  url: string;
+}
+
 export interface Props {
-  /** @default 1.9.11 */
+  /** @default 1.9.12 */
   version?: string;
-  /** @defaul https://cdn.jsdelivr.net/npm  */
+  /** @default https://cdn.jsdelivr.net/npm  */
   cdn?: string;
   /** @title HTMX extensions to include */
   extensions?: Extension[];
@@ -50,6 +35,7 @@ export default function Site(state: Props): App<Manifest, Required<Props>> {
     manifest,
   };
 }
+
 export const preview = async () => {
   const markdownContent = await Markdown(
     new URL("./README.md", import.meta.url).href,
@@ -71,3 +57,4 @@ export const preview = async () => {
     },
   };
 };
+export type AppContext = FnContext<Props, Manifest>;
diff --git a/htmx/sections/htmx.tsx b/htmx/sections/htmx.tsx
index 5a8d4f7b0..54bc8cbbf 100644
--- a/htmx/sections/htmx.tsx
+++ b/htmx/sections/htmx.tsx
@@ -2,17 +2,25 @@ import { Head } from "$fresh/runtime.ts";
 import { AppContext, Extension } from "../mod.ts";
 import { type SectionProps } from "@deco/deco";
 import { useScript } from "@deco/deco/hooks";
+
 const script = (extensions: Extension[]) => {
   if (extensions.length > 0) {
     if (document.readyState === "complete") {
-      document.body.setAttribute("hx-ext", extensions.join(","));
+      document.body.setAttribute(
+        "hx-ext",
+        extensions.map((ext) => ext.name).join(","),
+      );
       return;
     }
     globalThis.onload = () => {
-      document.body.setAttribute("hx-ext", extensions.join(","));
+      document.body.setAttribute(
+        "hx-ext",
+        extensions.map((ext) => ext.name).join(","),
+      );
     };
   }
 };
+
 function Section({ version, cdn, extensions }: SectionProps<typeof loader>) {
   return (
     <Head>
@@ -27,7 +35,7 @@ function Section({ version, cdn, extensions }: SectionProps<typeof loader>) {
       {extensions.map((ext) => (
         <script
           defer
-          src={`${cdn}/htmx.org@${version}/dist/ext/${ext}.js`}
+          src={ext.url}
           crossOrigin="anonymous"
         />
       ))}

From 3918c836fdf2362ba0fc37bc995aaeabf70f662b Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Mon, 13 Oct 2025 16:44:36 -0400
Subject: [PATCH 56/93] feat: add pickupPoint parameter to Params interface and
 update withDefaultParams function

---
 vtex/utils/intelligentSearch.ts | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/vtex/utils/intelligentSearch.ts b/vtex/utils/intelligentSearch.ts
index 5c78d3d2f..d77407cf5 100644
--- a/vtex/utils/intelligentSearch.ts
+++ b/vtex/utils/intelligentSearch.ts
@@ -48,6 +48,7 @@ interface Params {
   hideUnavailableItems: boolean;
   simulationBehavior: "default" | "skip" | "only1P";
   zipCode?: string;
+  pickupPoint?: string;
 }
 
 export const withDefaultParams = ({
@@ -60,6 +61,7 @@ export const withDefaultParams = ({
   hideUnavailableItems,
   simulationBehavior = "default",
   zipCode,
+  pickupPoint,
 }: Partial<Params>) => ({
   page: page + 1,
   count,
@@ -71,6 +73,7 @@ export const withDefaultParams = ({
   hideUnavailableItems: hideUnavailableItems ?? false,
   simulationBehavior,
   "zip-code": zipCode,
+  pickupPoint,
 });
 
 const IS_ANONYMOUS = Symbol("segment");

From 203a58ef24ece39cd870e97e6bf034ab7eea4e3a Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Thu, 16 Oct 2025 15:24:23 -0400
Subject: [PATCH 57/93] refactor: remove appKey validation from App component

---
 power-reviews/mod.ts | 3 ---
 1 file changed, 3 deletions(-)

diff --git a/power-reviews/mod.ts b/power-reviews/mod.ts
index 7aa6f30b4..d932b0e55 100644
--- a/power-reviews/mod.ts
+++ b/power-reviews/mod.ts
@@ -38,9 +38,6 @@ interface State extends Props {
 export default function App(
   { appKey, locale, merchantId, merchantGroup }: Props,
 ) {
-  if (!appKey) {
-    throw new Error("Missing appKey");
-  }
   const stringAppKey = typeof appKey === "string"
     ? appKey
     : appKey?.get?.() ?? "";

From d0d288558ed6f11eb2becf8a569f7db5ffa90e1c Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Thu, 23 Oct 2025 15:09:12 -0400
Subject: [PATCH 58/93] fix: orders type

---
 vtex/loaders/orders/getById.ts |  7 ++++---
 vtex/utils/types.ts            | 10 ++++++++--
 2 files changed, 12 insertions(+), 5 deletions(-)

diff --git a/vtex/loaders/orders/getById.ts b/vtex/loaders/orders/getById.ts
index c163aa630..1c21ba64e 100644
--- a/vtex/loaders/orders/getById.ts
+++ b/vtex/loaders/orders/getById.ts
@@ -1,4 +1,5 @@
-import { AppContext } from "../../mod.ts";
+import type { AppContext } from "../../mod.ts";
+import type { UserOrderDetails } from "../../utils/types.ts";
 import { parseCookie } from "../../utils/vtexId.ts";
 
 interface Props {
@@ -14,7 +15,7 @@ export default async function loader(
   { orderId }: Props,
   req: Request,
   ctx: AppContext,
-) {
+): Promise<UserOrderDetails> {
   const { vcsDeprecated } = ctx;
   const { cookie } = parseCookie(req.headers, ctx.account);
 
@@ -28,7 +29,7 @@ export default async function loader(
         accept: "application/json",
       },
     },
-  ).then((res) => res.json());
+  ).then((res) => res.json()) as unknown as UserOrderDetails;
 
   return order;
 }
diff --git a/vtex/utils/types.ts b/vtex/utils/types.ts
index 09c4ba879..fcf530214 100644
--- a/vtex/utils/types.ts
+++ b/vtex/utils/types.ts
@@ -1,5 +1,8 @@
-import { PaymentData as PaymentDataOpenAPI } from "./openapi/vcs.openapi.gen.ts";
-import { ChangesAttachment } from "./openapi/vcs.openapi.gen.ts";
+import { OpenAPI } from "./openapi/orders.openapi.gen.ts";
+import {
+  ChangesAttachment,
+  PaymentData as PaymentDataOpenAPI,
+} from "./openapi/vcs.openapi.gen.ts";
 
 /**
  * @format dynamic-options
@@ -2070,3 +2073,6 @@ export interface OrderFormOrder {
   orderFormCreationDate?: string;
   marketplaceRequestedCancellationWindow?: unknown;
 }
+
+export type UserOrderDetails =
+  OpenAPI["GET /api/oms/user/orders/:orderId"]["response"];

From ce9c53bbb47e77445bbd58658ec73bf4a0de51a8 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Thu, 23 Oct 2025 15:21:20 -0400
Subject: [PATCH 59/93] fix: typing

---
 vtex/utils/types.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/vtex/utils/types.ts b/vtex/utils/types.ts
index fcf530214..bb40602b0 100644
--- a/vtex/utils/types.ts
+++ b/vtex/utils/types.ts
@@ -2075,4 +2075,4 @@ export interface OrderFormOrder {
 }
 
 export type UserOrderDetails =
-  OpenAPI["GET /api/oms/user/orders/:orderId"]["response"];
+  OpenAPI["GET /api/oms/pvt/orders/:orderId"]["response"];

From b0409887c12fd993c0f2a3fceb68e247e5b817cb Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Wed, 12 Nov 2025 21:10:07 -0400
Subject: [PATCH 60/93] feat: add explicit return type to vtex category tree
 loader

---
 vtex/loaders/categories/tree.ts | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/vtex/loaders/categories/tree.ts b/vtex/loaders/categories/tree.ts
index bb74dd847..1d8bbe6a5 100644
--- a/vtex/loaders/categories/tree.ts
+++ b/vtex/loaders/categories/tree.ts
@@ -11,6 +11,8 @@ export interface Props {
   categoryLevels?: number;
 }
 
+export type CategoryTree = Category | Category[];
+
 /**
  * @title Get Category Tree
  * @description Get the category tree
@@ -19,7 +21,7 @@ export default async function loader(
   { categoryLevels }: Props,
   _req: Request,
   ctx: AppContext,
-): Promise<Category | Category[]> {
+): Promise<CategoryTree> {
   return await ctx.vcsDeprecated
     ["GET /api/catalog_system/pub/category/tree/:level"]({
       level: categoryLevels ?? 1,

From f6848821f4f92754de3ef3defcb102125694ae3c Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Fri, 21 Nov 2025 12:46:31 -0400
Subject: [PATCH 61/93] fix: safe parse segment

---
 vtex/utils/segment.ts | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/vtex/utils/segment.ts b/vtex/utils/segment.ts
index 8f2960946..59ffe0f75 100644
--- a/vtex/utils/segment.ts
+++ b/vtex/utils/segment.ts
@@ -113,7 +113,13 @@ const serialize = ({
   return btoa(JSON.stringify(seg));
 };
 
-const parse = (cookie: string) => JSON.parse(atob(cookie));
+const parse = (cookie: string) => {
+  try {
+    return JSON.parse(atob(cookie));
+  } catch {
+    return null;
+  }
+};
 
 const SEGMENT_QUERY_PARAMS = [
   "utmi_campaign" as const,

From 5e27f17a9b898aa2862102fdf0c83eed5bd1e88e Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Fri, 21 Nov 2025 13:26:28 -0400
Subject: [PATCH 62/93] refactor: force disable azion assets

---
 website/components/Image.tsx | 18 +++++++++++++-----
 1 file changed, 13 insertions(+), 5 deletions(-)

diff --git a/website/components/Image.tsx b/website/components/Image.tsx
index c954f08f6..02de935a1 100644
--- a/website/components/Image.tsx
+++ b/website/components/Image.tsx
@@ -39,11 +39,19 @@ const isImageOptmizationEnabled = () =>
     ? (globalThis as any).DECO?.featureFlags?.enableImageOptimization
     : Deno.env.get("ENABLE_IMAGE_OPTIMIZATION") !== "false";
 
-const isAzionAssetsEnabled = () =>
-  IS_BROWSER
-    // deno-lint-ignore no-explicit-any
-    ? (globalThis as any).DECO?.featureFlags?.azionAssets
-    : Deno.env.get("ENABLE_AZION_ASSETS") !== "false";
+const isAzionAssetsEnabled = () => false;
+let warningShown = false;
+if (!warningShown) {
+  console.warn(
+    "\n\x1b[33mAzion assets are forced to be disabled until we find a better solution to handle SVGs.\x1b[0m\n",
+  );
+  warningShown = true;
+}
+// const isAzionAssetsEnabled = () =>
+//   IS_BROWSER
+//     // deno-lint-ignore no-explicit-any
+//     ? (globalThis as any).DECO?.featureFlags?.azionAssets
+//     : Deno.env.get("ENABLE_AZION_ASSETS") !== "false";
 
 const canShowWarning = () =>
   IS_BROWSER ? false : !Deno.env.get("DENO_DEPLOYMENT_ID");

From 0f3a2c8c688f3408518de1fef50912845812a023 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Mon, 24 Nov 2025 00:01:48 -0400
Subject: [PATCH 63/93] feat: add product reviews loader to power reviews

---
 power-reviews/loaders/productReviews.ts | 69 +++++++++++++++++++++++++
 power-reviews/manifest.gen.ts           | 10 ++--
 2 files changed, 75 insertions(+), 4 deletions(-)
 create mode 100644 power-reviews/loaders/productReviews.ts

diff --git a/power-reviews/loaders/productReviews.ts b/power-reviews/loaders/productReviews.ts
new file mode 100644
index 000000000..ef4c115be
--- /dev/null
+++ b/power-reviews/loaders/productReviews.ts
@@ -0,0 +1,69 @@
+import { ReviewPage } from "../../commerce/types.ts";
+import { AppContext } from "../mod.ts";
+import { toAggregateRating, toReview } from "../utils/tranform.ts";
+
+export interface Props {
+  /**
+   * @title Power Reviews ID
+   * @description The ID, SKU, or Model of the product in Power Reviews
+   */
+  id: string;
+  /**
+   * @title Image Only
+   * @description Filter only reviews with media
+   */
+  image_only?: boolean;
+}
+
+/**
+ * @title Power Reviews - Product Details Page
+ */
+export default async function loader(
+  props: Props,
+  _req: Request,
+  ctx: AppContext,
+): Promise<ReviewPage | null> {
+  const { api, merchantId } = ctx;
+  const pageFrom = 0, pageSize = 10;
+  const { image_only = false, id } = props;
+
+  const fullReviewResponse = await api
+    ["GET /m/:merchantId/l/:locale/product/:pageId/reviews"]({
+      merchantId: merchantId,
+      locale: "en_US",
+      pageId: id,
+      _noconfig: "true",
+      image_only: image_only,
+      "paging.from": pageFrom,
+      "paging.size": pageSize,
+    });
+
+  const fullReview = await fullReviewResponse.json();
+  const rollup = fullReview.results[0].rollup;
+  const reviews = fullReview.results[0].reviews;
+
+  const aggregateRating = toAggregateRating(rollup);
+
+  const review = reviews.length >= 1
+    ? reviews?.map((item) => toReview(item))
+    : undefined;
+
+  return {
+    id,
+    page: {
+      currentPageNumber: fullReview.paging.current_page_number,
+      nextPageUrl: fullReview.paging.next_page_url,
+      pageSize: fullReview.paging.page_size,
+      pagesTotal: fullReview.paging.pages_total,
+      totalResults: fullReview.paging.total_results,
+    },
+    review,
+    aggregateRating,
+  };
+}
+
+export const cache = {
+  maxAge: 60 * 60 * 24, // 1 hour
+};
+export const cacheKey = (props: Props) =>
+  `power-reviews:product-reviews:${props.id}:${props.image_only || false}`;
diff --git a/power-reviews/manifest.gen.ts b/power-reviews/manifest.gen.ts
index 2b08aec79..57cc2fc12 100644
--- a/power-reviews/manifest.gen.ts
+++ b/power-reviews/manifest.gen.ts
@@ -6,8 +6,9 @@ import * as $$$$$$$$$0 from "./actions/submitReview.ts";
 import * as $$$0 from "./loaders/productDetailsPage.ts";
 import * as $$$1 from "./loaders/productList.ts";
 import * as $$$2 from "./loaders/productListingPage.ts";
-import * as $$$3 from "./loaders/review.ts";
-import * as $$$4 from "./loaders/reviewForm.ts";
+import * as $$$3 from "./loaders/productReviews.ts";
+import * as $$$4 from "./loaders/review.ts";
+import * as $$$5 from "./loaders/reviewForm.ts";
 import * as $$$$$$0 from "./sections/Question.tsx";
 import * as $$$$$$1 from "./sections/WriteReviewForm.tsx";
 
@@ -16,8 +17,9 @@ const manifest = {
     "power-reviews/loaders/productDetailsPage.ts": $$$0,
     "power-reviews/loaders/productList.ts": $$$1,
     "power-reviews/loaders/productListingPage.ts": $$$2,
-    "power-reviews/loaders/review.ts": $$$3,
-    "power-reviews/loaders/reviewForm.ts": $$$4,
+    "power-reviews/loaders/productReviews.ts": $$$3,
+    "power-reviews/loaders/review.ts": $$$4,
+    "power-reviews/loaders/reviewForm.ts": $$$5,
   },
   "sections": {
     "power-reviews/sections/Question.tsx": $$$$$$0,

From cdd8f42aeb1c43fb3a1dfe98f8cb11a9141392d1 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Sun, 7 Dec 2025 15:46:37 -0400
Subject: [PATCH 64/93] chore: remove defer attribute from script tag in Events
 component

---
 website/components/Events.tsx | 1 -
 1 file changed, 1 deletion(-)

diff --git a/website/components/Events.tsx b/website/components/Events.tsx
index 837b980ed..e66381891 100644
--- a/website/components/Events.tsx
+++ b/website/components/Events.tsx
@@ -92,7 +92,6 @@ function Events({ deco }: {
   return (
     <Head>
       <script
-        defer
         id="deco-events"
         src={useScriptAsDataURI(snippet, {
           deco,

From 59e4a4f944accd2454a0e15631803276958f2346 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Mon, 8 Dec 2025 12:04:52 -0400
Subject: [PATCH 65/93] refactor: newsletter is a public api

---
 .../newsletter/updateNewsletterOptIn.ts       | 36 +++++++++++++++----
 1 file changed, 29 insertions(+), 7 deletions(-)

diff --git a/vtex/actions/newsletter/updateNewsletterOptIn.ts b/vtex/actions/newsletter/updateNewsletterOptIn.ts
index e54229735..f8a2e0478 100644
--- a/vtex/actions/newsletter/updateNewsletterOptIn.ts
+++ b/vtex/actions/newsletter/updateNewsletterOptIn.ts
@@ -7,10 +7,22 @@ const mutation =
 }`;
 
 interface Props {
+  /**
+   * The email of the user to update the newsletter opt in.
+   */
+  email: string;
   /**
    * If true, the user will be subscribed to the newsletter.
    */
   subscribe: boolean;
+  /**
+   * Name of the user to update the newsletter opt in.
+   */
+  name?: string;
+  /**
+   * Phone of the user to update the newsletter opt in.
+   */
+  phone?: string;
 }
 
 /**
@@ -23,19 +35,29 @@ async function loader(
   ctx: AppContext,
 ): Promise<{ subscribed: boolean }> {
   const { io } = ctx;
-  const { cookie, payload } = parseCookie(req.headers, ctx.account);
+  const { cookie } = parseCookie(req.headers, ctx.account);
 
-  if (!payload?.sub || !payload?.userId) {
-    throw new Error("User cookie is invalid");
-  }
-
-  await io.query<unknown, { email: string; isNewsletterOptIn: boolean }>(
+  await io.query<
+    unknown,
+    {
+      email: string;
+      isNewsletterOptIn: boolean;
+      fields?: {
+        name?: string;
+        phone?: string;
+      };
+    }
+  >(
     {
       query: mutation,
       operationName: "SubscribeNewsletter",
       variables: {
-        email: payload.sub,
+        email: props.email,
         isNewsletterOptIn: props.subscribe,
+        fields: {
+          name: props.name,
+          phone: props.phone,
+        },
       },
     },
     { headers: { cookie } },

From 5e33185f9c041f672b6336b0553c96fb9683f47e Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Mon, 15 Dec 2025 18:22:13 -0400
Subject: [PATCH 66/93] feat: add logistics openapi and list holidays API

---
 vtex/loaders/logistics/listHolidays.ts      |    32 +
 vtex/manifest.gen.ts                        |   142 +-
 vtex/mod.ts                                 |     6 +-
 vtex/utils/openapi/logistics.openapi.gen.ts |  6088 +++++++++
 vtex/utils/openapi/logistics.openapi.json   | 12352 ++++++++++++++++++
 vtex/utils/openapi/vcs.openapi.json         |     2 +-
 6 files changed, 18550 insertions(+), 72 deletions(-)
 create mode 100644 vtex/loaders/logistics/listHolidays.ts
 create mode 100644 vtex/utils/openapi/logistics.openapi.gen.ts
 create mode 100644 vtex/utils/openapi/logistics.openapi.json

diff --git a/vtex/loaders/logistics/listHolidays.ts b/vtex/loaders/logistics/listHolidays.ts
new file mode 100644
index 000000000..23e6802e0
--- /dev/null
+++ b/vtex/loaders/logistics/listHolidays.ts
@@ -0,0 +1,32 @@
+import type { TypedResponse } from "../../../utils/http.ts";
+import type { AppContext } from "../../mod.ts";
+
+export type Holiday = {
+  id: string;
+  account: string;
+  startDate: string;
+  endDate: string;
+  name: string;
+};
+
+export default async function loader(
+  _props: unknown,
+  _req: Request,
+  ctx: AppContext,
+): Promise<Holiday[]> {
+  const { vcs } = ctx;
+
+  const response = await vcs["GET /api/logistics/pvt/configuration/holidays"](
+    {},
+  )
+    .then((r) => (r as TypedResponse<Holiday[]>).json());
+
+  return response;
+}
+
+export const cache = {
+  maxAge: 60 * 60 * 24, // 1 day
+};
+export const cacheKey = (_props: unknown, _req: Request, _ctx: AppContext) => {
+  return "logistics-holidays";
+};
diff --git a/vtex/manifest.gen.ts b/vtex/manifest.gen.ts
index 63b76370a..9f67f1ce5 100644
--- a/vtex/manifest.gen.ts
+++ b/vtex/manifest.gen.ts
@@ -76,41 +76,42 @@ import * as $$$19 from "./loaders/legacy/productListingPage.ts";
 import * as $$$20 from "./loaders/legacy/relatedProductsLoader.ts";
 import * as $$$21 from "./loaders/legacy/suggestions.ts";
 import * as $$$22 from "./loaders/logistics/getSalesChannelById.ts";
-import * as $$$23 from "./loaders/logistics/listPickupPoints.ts";
-import * as $$$24 from "./loaders/logistics/listPickupPointsByLocation.ts";
-import * as $$$25 from "./loaders/logistics/listSalesChannelById.ts";
-import * as $$$26 from "./loaders/logistics/listStockByStore.ts";
-import * as $$$27 from "./loaders/masterdata/searchDocuments.ts";
-import * as $$$28 from "./loaders/navbar.ts";
-import * as $$$29 from "./loaders/options/productIdByTerm.ts";
-import * as $$$30 from "./loaders/orders/getById.ts";
-import * as $$$31 from "./loaders/orders/list.ts";
-import * as $$$32 from "./loaders/orders/order.ts";
-import * as $$$33 from "./loaders/orders/orderplaced.ts";
-import * as $$$34 from "./loaders/paths/PDPDefaultPath.ts";
-import * as $$$35 from "./loaders/paths/PLPDefaultPath.ts";
-import * as $$$36 from "./loaders/payment/paymentSystems.ts";
-import * as $$$37 from "./loaders/payment/userPayments.ts";
-import * as $$$38 from "./loaders/payments/info.ts";
-import * as $$$39 from "./loaders/payments/userPayments.ts";
-import * as $$$40 from "./loaders/product/extend.ts";
-import * as $$$41 from "./loaders/product/extensions/detailsPage.ts";
-import * as $$$42 from "./loaders/product/extensions/list.ts";
-import * as $$$43 from "./loaders/product/extensions/listingPage.ts";
-import * as $$$44 from "./loaders/product/extensions/suggestions.ts";
-import * as $$$45 from "./loaders/product/wishlist.ts";
-import * as $$$46 from "./loaders/profile/getCurrentProfile.ts";
-import * as $$$47 from "./loaders/profile/getProfileByEmail.ts";
-import * as $$$48 from "./loaders/profile/passwordLastUpdate.ts";
-import * as $$$49 from "./loaders/promotion/getPromotionById.ts";
-import * as $$$50 from "./loaders/proxy.ts";
-import * as $$$51 from "./loaders/session/getSession.ts";
-import * as $$$52 from "./loaders/session/getUserSessions.ts";
-import * as $$$53 from "./loaders/sessions/info.ts";
-import * as $$$54 from "./loaders/user.ts";
-import * as $$$55 from "./loaders/wishlist.ts";
-import * as $$$56 from "./loaders/workflow/product.ts";
-import * as $$$57 from "./loaders/workflow/products.ts";
+import * as $$$23 from "./loaders/logistics/listHolidays.ts";
+import * as $$$24 from "./loaders/logistics/listPickupPoints.ts";
+import * as $$$25 from "./loaders/logistics/listPickupPointsByLocation.ts";
+import * as $$$26 from "./loaders/logistics/listSalesChannelById.ts";
+import * as $$$27 from "./loaders/logistics/listStockByStore.ts";
+import * as $$$28 from "./loaders/masterdata/searchDocuments.ts";
+import * as $$$29 from "./loaders/navbar.ts";
+import * as $$$30 from "./loaders/options/productIdByTerm.ts";
+import * as $$$31 from "./loaders/orders/getById.ts";
+import * as $$$32 from "./loaders/orders/list.ts";
+import * as $$$33 from "./loaders/orders/order.ts";
+import * as $$$34 from "./loaders/orders/orderplaced.ts";
+import * as $$$35 from "./loaders/paths/PDPDefaultPath.ts";
+import * as $$$36 from "./loaders/paths/PLPDefaultPath.ts";
+import * as $$$37 from "./loaders/payment/paymentSystems.ts";
+import * as $$$38 from "./loaders/payment/userPayments.ts";
+import * as $$$39 from "./loaders/payments/info.ts";
+import * as $$$40 from "./loaders/payments/userPayments.ts";
+import * as $$$41 from "./loaders/product/extend.ts";
+import * as $$$42 from "./loaders/product/extensions/detailsPage.ts";
+import * as $$$43 from "./loaders/product/extensions/list.ts";
+import * as $$$44 from "./loaders/product/extensions/listingPage.ts";
+import * as $$$45 from "./loaders/product/extensions/suggestions.ts";
+import * as $$$46 from "./loaders/product/wishlist.ts";
+import * as $$$47 from "./loaders/profile/getCurrentProfile.ts";
+import * as $$$48 from "./loaders/profile/getProfileByEmail.ts";
+import * as $$$49 from "./loaders/profile/passwordLastUpdate.ts";
+import * as $$$50 from "./loaders/promotion/getPromotionById.ts";
+import * as $$$51 from "./loaders/proxy.ts";
+import * as $$$52 from "./loaders/session/getSession.ts";
+import * as $$$53 from "./loaders/session/getUserSessions.ts";
+import * as $$$54 from "./loaders/sessions/info.ts";
+import * as $$$55 from "./loaders/user.ts";
+import * as $$$56 from "./loaders/wishlist.ts";
+import * as $$$57 from "./loaders/workflow/product.ts";
+import * as $$$58 from "./loaders/workflow/products.ts";
 import * as $$$$$$0 from "./sections/Analytics/Vtex.tsx";
 import * as $$$$$$$$$$0 from "./workflows/events.ts";
 import * as $$$$$$$$$$1 from "./workflows/product/index.ts";
@@ -140,41 +141,42 @@ const manifest = {
     "vtex/loaders/legacy/relatedProductsLoader.ts": $$$20,
     "vtex/loaders/legacy/suggestions.ts": $$$21,
     "vtex/loaders/logistics/getSalesChannelById.ts": $$$22,
-    "vtex/loaders/logistics/listPickupPoints.ts": $$$23,
-    "vtex/loaders/logistics/listPickupPointsByLocation.ts": $$$24,
-    "vtex/loaders/logistics/listSalesChannelById.ts": $$$25,
-    "vtex/loaders/logistics/listStockByStore.ts": $$$26,
-    "vtex/loaders/masterdata/searchDocuments.ts": $$$27,
-    "vtex/loaders/navbar.ts": $$$28,
-    "vtex/loaders/options/productIdByTerm.ts": $$$29,
-    "vtex/loaders/orders/getById.ts": $$$30,
-    "vtex/loaders/orders/list.ts": $$$31,
-    "vtex/loaders/orders/order.ts": $$$32,
-    "vtex/loaders/orders/orderplaced.ts": $$$33,
-    "vtex/loaders/paths/PDPDefaultPath.ts": $$$34,
-    "vtex/loaders/paths/PLPDefaultPath.ts": $$$35,
-    "vtex/loaders/payment/paymentSystems.ts": $$$36,
-    "vtex/loaders/payment/userPayments.ts": $$$37,
-    "vtex/loaders/payments/info.ts": $$$38,
-    "vtex/loaders/payments/userPayments.ts": $$$39,
-    "vtex/loaders/product/extend.ts": $$$40,
-    "vtex/loaders/product/extensions/detailsPage.ts": $$$41,
-    "vtex/loaders/product/extensions/list.ts": $$$42,
-    "vtex/loaders/product/extensions/listingPage.ts": $$$43,
-    "vtex/loaders/product/extensions/suggestions.ts": $$$44,
-    "vtex/loaders/product/wishlist.ts": $$$45,
-    "vtex/loaders/profile/getCurrentProfile.ts": $$$46,
-    "vtex/loaders/profile/getProfileByEmail.ts": $$$47,
-    "vtex/loaders/profile/passwordLastUpdate.ts": $$$48,
-    "vtex/loaders/promotion/getPromotionById.ts": $$$49,
-    "vtex/loaders/proxy.ts": $$$50,
-    "vtex/loaders/session/getSession.ts": $$$51,
-    "vtex/loaders/session/getUserSessions.ts": $$$52,
-    "vtex/loaders/sessions/info.ts": $$$53,
-    "vtex/loaders/user.ts": $$$54,
-    "vtex/loaders/wishlist.ts": $$$55,
-    "vtex/loaders/workflow/product.ts": $$$56,
-    "vtex/loaders/workflow/products.ts": $$$57,
+    "vtex/loaders/logistics/listHolidays.ts": $$$23,
+    "vtex/loaders/logistics/listPickupPoints.ts": $$$24,
+    "vtex/loaders/logistics/listPickupPointsByLocation.ts": $$$25,
+    "vtex/loaders/logistics/listSalesChannelById.ts": $$$26,
+    "vtex/loaders/logistics/listStockByStore.ts": $$$27,
+    "vtex/loaders/masterdata/searchDocuments.ts": $$$28,
+    "vtex/loaders/navbar.ts": $$$29,
+    "vtex/loaders/options/productIdByTerm.ts": $$$30,
+    "vtex/loaders/orders/getById.ts": $$$31,
+    "vtex/loaders/orders/list.ts": $$$32,
+    "vtex/loaders/orders/order.ts": $$$33,
+    "vtex/loaders/orders/orderplaced.ts": $$$34,
+    "vtex/loaders/paths/PDPDefaultPath.ts": $$$35,
+    "vtex/loaders/paths/PLPDefaultPath.ts": $$$36,
+    "vtex/loaders/payment/paymentSystems.ts": $$$37,
+    "vtex/loaders/payment/userPayments.ts": $$$38,
+    "vtex/loaders/payments/info.ts": $$$39,
+    "vtex/loaders/payments/userPayments.ts": $$$40,
+    "vtex/loaders/product/extend.ts": $$$41,
+    "vtex/loaders/product/extensions/detailsPage.ts": $$$42,
+    "vtex/loaders/product/extensions/list.ts": $$$43,
+    "vtex/loaders/product/extensions/listingPage.ts": $$$44,
+    "vtex/loaders/product/extensions/suggestions.ts": $$$45,
+    "vtex/loaders/product/wishlist.ts": $$$46,
+    "vtex/loaders/profile/getCurrentProfile.ts": $$$47,
+    "vtex/loaders/profile/getProfileByEmail.ts": $$$48,
+    "vtex/loaders/profile/passwordLastUpdate.ts": $$$49,
+    "vtex/loaders/promotion/getPromotionById.ts": $$$50,
+    "vtex/loaders/proxy.ts": $$$51,
+    "vtex/loaders/session/getSession.ts": $$$52,
+    "vtex/loaders/session/getUserSessions.ts": $$$53,
+    "vtex/loaders/sessions/info.ts": $$$54,
+    "vtex/loaders/user.ts": $$$55,
+    "vtex/loaders/wishlist.ts": $$$56,
+    "vtex/loaders/workflow/product.ts": $$$57,
+    "vtex/loaders/workflow/products.ts": $$$58,
   },
   "handlers": {
     "vtex/handlers/sitemap.ts": $$$$0,
diff --git a/vtex/mod.ts b/vtex/mod.ts
index 39cc42a9b..675729f0e 100644
--- a/vtex/mod.ts
+++ b/vtex/mod.ts
@@ -23,7 +23,11 @@ import { OpenAPI as API } from "./utils/openapi/api.openapi.gen.ts";
 import { OpenAPI as MY } from "./utils/openapi/my.openapi.gen.ts";
 import { OpenAPI as VPAY } from "./utils/openapi/payments.openapi.gen.ts";
 import { OpenAPI as SUB } from "./utils/openapi/subscriptions.openapi.gen.ts";
-import { OpenAPI as VCS } from "./utils/openapi/vcs.openapi.gen.ts";
+import { OpenAPI as _VCS } from "./utils/openapi/vcs.openapi.gen.ts";
+import { OpenAPI as LOGISTICS } from "./utils/openapi/logistics.openapi.gen.ts";
+
+type VCS = _VCS & LOGISTICS;
+
 import { Segment } from "./utils/types.ts";
 
 export type App = ReturnType<typeof VTEX>;
diff --git a/vtex/utils/openapi/logistics.openapi.gen.ts b/vtex/utils/openapi/logistics.openapi.gen.ts
new file mode 100644
index 000000000..787f0a69e
--- /dev/null
+++ b/vtex/utils/openapi/logistics.openapi.gen.ts
@@ -0,0 +1,6088 @@
+
+// deno-fmt-ignore-file
+// deno-lint-ignore-file no-explicit-any ban-types ban-unused-ignore
+//
+// DO NOT EDIT. This file is generated by deco.
+// This file SHOULD be checked into source version control.
+// To generate this file: deno task start
+//        
+
+
+export interface OpenAPI {
+/**
+ * Retrieves information from a [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) from your store, searching by shipping policy ID.
+ * 
+ * >⚠️ While most endpoints return time fields in UTC format, this endpoint returns **Scheduled Delivery** related time fields adjusted to the time zone configured for the VTEX account.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics viewer** |
+ * | Logistics | Logistics access | **Logistics shipping full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics viewer |
+ * | Logistics - Read only | Logistics viewer |
+ * | Logistics - Full access | Logistics shipping full access |
+ * | OMS - Full access | Logistics shipping full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"GET /api/logistics/pvt/shipping-policies/:id": {
+/**
+ * Details about a given shipping policy.
+ */
+response: {
+/**
+ * [Shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) ID.
+ */
+id?: string
+/**
+ * [Shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) name.
+ */
+name?: string
+/**
+ * Type of shipping available for this shipping policy (carrier). Options are shown on [shipping simulation](https://help.vtex.com/en/tutorial/shipping-simulation--tutorials_144).
+ */
+shippingMethod?: string
+/**
+ * If the shipping policy includes deliveries on weekends and holidays.
+ */
+weekendAndHolidays?: {
+/**
+ * Defines if shipping on Saturdays is valid (`true`) or not (`false`).
+ */
+saturday?: boolean
+/**
+ * Defines if shipping on Sundays is valid (`true`) or not (`false`).
+ */
+sunday?: boolean
+/**
+ * Defines if shipping on holidays is valid (`true`) or not (`false`).
+ */
+holiday?: boolean
+}
+/**
+ * Object containing attributes of maximum dimension permitted by the shipping policy (carrier).
+ */
+maxDimension?: {
+/**
+ * Largest measure acceptable of the package.
+ */
+largestMeasure?: number
+/**
+ * Limit for the sum of all maximum measures of the package.
+ */
+maxMeasureSum?: number
+}
+/**
+ * Determines the number of items allowed per shipment.
+ */
+numberOfItemsPerShipment?: number
+/**
+ * Minimum value accepted by the carrier for delivering.
+ */
+minimumValueAceptable?: number
+/**
+ * Maximum value accepted by the carrier for delivering.
+ */
+maximumValueAceptable?: number
+/**
+ * @deprecated
+ * Additional time configured in `HH:MM:SS` format.
+ */
+additionalTime?: string
+/**
+ * @deprecated
+ * Additional price object.
+ */
+additionalPrice?: {
+/**
+ * @deprecated
+ * Additional price method.
+ */
+method?: number
+/**
+ * @deprecated
+ * Payment value.
+ */
+value?: number
+}
+/**
+ * [Scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) settings.
+ */
+deliveryScheduleSettings?: {
+/**
+ * Defines if the scheduled delivery configuration is active (`true`) or not (`false`).
+ */
+useDeliverySchedule?: boolean
+/**
+ * Range of days available within a delivery window, for the customer to choose the scheduled delivery. For example, if the configured `maxRangeDelivery` is equal `7`, and the customer buys something on a Tuesday, the options for scheduled delivery will be shown until the following Tuesday (7 days from the purchase day). If no options are available within the `maxRangeDelivery` set, the shipping policy will not be shown on the checkout.
+ */
+maxRangeDelivery?: number
+/**
+ * Selected days for delivery, from `0` (Sunday) to `6` (Saturday).
+ */
+dayOfWeekForDelivery?: {
+/**
+ * Day of the week, from `0` (Sunday) to `6` (Saturday).
+ */
+dayOfWeek?: number
+/**
+ * Reservation window for scheduled delivery.
+ */
+deliveryRanges?: {
+/**
+ * Start time for day of the week in `hh:mm:ss` format.
+ */
+startTime?: string
+/**
+ * End time for day of the week in `hh:mm:ss` format.
+ */
+endTime?: string
+/**
+ * List price for day of the week.
+ */
+listPrice?: number
+/**
+ * Sets maximum [delivery capacity](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz) for a given reservation window for scheduled delivery.
+ */
+deliveryCapacity?: (null | {
+/**
+ * Defines how the delivery capacity is measured for this reservation window, by maximum number of orders (`ORDERS_QUANTITY`) or items (`SKUS_QUANTITY`).
+ */
+capacityType?: string
+/**
+ * Maximum number of orders or SKUs that the store is capable of fulfilling.
+ */
+maxValue?: number
+}[])
+}[]
+}[]
+/**
+ * @deprecated
+ * Defines if there are any days of the week that are blocked.
+ */
+dayOfWeekBlockeds?: (null | string[])
+}
+/**
+ * Schedule sent by the carrier to configure the shipping policy.
+ */
+carrierSchedule?: {
+/**
+ * Day of the week from `0` (Sunday) to `6` (Saturday).
+ */
+dayOfWeek?: number
+/**
+ * Time limit in `HH:MM:SS` format.
+ */
+timeLimit?: string
+}[]
+/**
+ * Settings for the cubic weight of a package, which accounts for the [package's volume](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128), and not only weight.
+ */
+cubicWeightSettings?: {
+/**
+ * Factor that will be used on the cubic weight calculation, usually given by the carrier.
+ */
+volumetricFactor?: number
+/**
+ * Packages' minimum acceptable [volumetric weight](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128).
+ */
+minimunAcceptableVolumetricWeight?: number
+}
+/**
+ * Configurations for the [modal](https://help.vtex.com/en/tutorial/how-does-the-modal-work--tutorials_125), which is the attachement of a specific product to a carrier specialized in delivering that type of product.
+ */
+modalSettings?: {
+/**
+ * Type of special freight.
+ */
+modals?: ("CHEMICALS" | "ELECTRONICS" | "FURNITURE" | "GLASS" | "LIQUID" | "MATTRESSES" | "REFRIGERATED" | "TIRES" | "WHITE_GOODS" | "FIREARMS")[]
+/**
+ * When set as `true`, the modal's configurations will apply only for items with a defined modal, when `false`, the modal configuration will not be set.
+ */
+useOnlyItemsWithDefinedModal?: boolean
+}
+/**
+ * Business hours configurations.
+ */
+businessHourSettings?: {
+/**
+ * Business hours configurations array for the days of the week.
+ */
+carrierBusinessHours?: {
+/**
+ * Opening time in `HH:MM:SS` format.
+ */
+openingTime?: string
+/**
+ * Closing time in `HH:MM:SS` format.
+ */
+closingTime?: string
+/**
+ * Day of the week from `0` (Sunday) to `6` (Saturday).
+ */
+dayOfWeek?: (0 | 1 | 2 | 3 | 4 | 5 | 6)
+}[]
+/**
+ * Defines if deliveries outside business hours are allowed (`true`) or not (`false`).
+ */
+isOpenOutsideBusinessHours?: boolean
+}
+/**
+ * [Pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) configurations of the shipping policy.
+ */
+pickupPointsSettings?: {
+/**
+ * Pickup point IDs configured for the shipping policy.
+ */
+pickupPointIds?: string[]
+/**
+ * Pickup points tags configured for the shipping policy.
+ */
+pickupPointTags?: string[]
+/**
+ * Sellers associated with [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) related to the shipping policy.
+ */
+sellers?: string[]
+}
+/**
+ * Shipping policy processing status.
+ */
+processingStatus?: {
+/**
+ * Shipping policy processing status code.
+ */
+status?: number
+/**
+ * Error message, when applicable.
+ */
+errorMessage?: (null | string)
+/**
+ * Error metadata, when applicable.
+ */
+errorsMetadata?: (null | string)
+}
+/**
+ * Defines if the shipping type is `delivery` or `pickup`.
+ */
+deliveryChannel?: string
+/**
+ * Shipping policy calculation type.
+ */
+calculationType?: number
+/**
+ * Defines if the shipping policy is active (`true`) or not (`false`).
+ */
+isActive?: boolean
+/**
+ * Date and time since the last [indexing](https://help.vtex.com/en/tutorial/understanding-how-indexation-works--tutorials_256), in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DD hh:mm:ss[.nnnnnnn]+hh:mm`.
+ */
+lastIndexedAt?: (null | string)
+/**
+ * Shipping hours settings configurations.
+ */
+shippingHoursSettings?: {
+/**
+ * Shipping hours settings array.
+ */
+shippingHours?: {
+/**
+ * Day of the week from `0` (Sunday) to `6` (Saturday).
+ */
+dayOfWeek?: number
+/**
+ * Opening time in `hh:mm:ss` format.
+ */
+openingTime?: string
+/**
+ * Closing time in `hh:mm:ss` format.
+ */
+closingTime?: string
+}[]
+/**
+ * Defines if the configuration that allows accepting orders outside shipping hours is active (`true`) or not (`false`).
+ */
+acceptOrdersOutsideShippingHours?: boolean
+}
+/**
+ * [Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) information.
+ */
+carrierInfo?: {
+/**
+ * VTEX store account name related to the shipping policy.
+ */
+carrierAccountName?: string
+/**
+ * Delivery agreement ID.
+ */
+deliveryAgreementId?: (null | string)
+/**
+ * Shipping policy [loading docks](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) valid for the carrier.
+ */
+linkedDocks?: {
+/**
+ * Loading dock ID.
+ */
+id?: string
+/**
+ * Loading dock name.
+ */
+name?: string
+}[]
+/**
+ * Defines if shipping configurations related to the carrier make them ready for shipping (`true`) or not (`false`).
+ */
+readyToUse?: boolean
+}
+}
+}
+/**
+ * Updates information about a [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) of your store, searching by shipping policy ID. 
+ * 
+ * >⚠️ While most endpoints return time fields in UTC format, this endpoint returns **Scheduled Delivery** related time fields adjusted to the time zone configured for the VTEX account. 
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics shipping full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics shipping full access |
+ * | OMS - Full access | Logistics shipping full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"PUT /api/logistics/pvt/shipping-policies/:id": {
+body: {
+/**
+ * [Shipping policy]((https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) name.
+ */
+name: string
+/**
+ * Type of shipping available for this shipping policy (carrier). Options are shown on [shipping simulation](https://help.vtex.com/en/tutorial/shipping-simulation--tutorials_144).
+ */
+shippingMethod: string
+/**
+ * Defines if the delivery on weekends configuration is active (`true`) or not (`false`).
+ */
+deliveryOnWeekends: boolean
+/**
+ * Object containing attributes of maximum dimension permitted by the shipping policy (carrier).
+ */
+maxDimension: {
+/**
+ * Largest measure acceptable of the package.
+ */
+largestMeasure: number
+/**
+ * Sum of all maximum measures of the package.
+ */
+maxMeasureSum: number
+}
+/**
+ * Settings for the cubic weight of a package, which accounts for the [package's volume](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128), and not only weight.
+ */
+cubicWeightSettings?: {
+/**
+ * Factor that will be used on the cubic weight calculation, usually given by the carrier.
+ */
+volumetricFactor?: number
+/**
+ * Packages' minimum acceptable [volumetric weight](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128).
+ */
+minimunAcceptableVolumetricWeight?: number
+}
+/**
+ * Configurations for the [modal](https://help.vtex.com/en/tutorial/how-does-the-modal-work--tutorials_125), which is the attachement of a specific product to a carrier specialized in delivering that type of product.
+ */
+modalSettings?: {
+/**
+ * Type of special freight.
+ */
+modals?: ("CHEMICALS" | "ELECTRONICS" | "FURNITURE" | "GLASS" | "LIQUID" | "MATTRESSES" | "REFRIGERATED" | "TIRES" | "WHITE_GOODS" | "FIREARMS")[]
+/**
+ * When set as `true`, the modal's configurations will apply only for items with a defined modal, when `false`, the modal configuration will not be set.
+ */
+useOnlyItemsWithDefinedModal?: boolean
+}
+/**
+ * Defines if the shipping policy is active (`true`) or inactive (`false`).
+ */
+isActive: boolean
+/**
+ * [Scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) settings.
+ */
+deliveryScheduleSettings?: {
+/**
+ * Defines if the scheduled delivery configuration is active (`true`) or inactive (`false`).
+ */
+useDeliverySchedule: boolean
+/**
+ * Range of days available within a delivery window, for the customer to choose the scheduled delivery. For example, if the configured maxRangeDelivery is equal 7, and the customer buys something on a Tuesday, the options for scheduled delivery will be shown until the following Tuesday (7 days from the purchase day). If no options are available within the maxRangeDelivery set, this shipping policy won't be shown on the checkout.
+ */
+maxRangeDelivery: number
+/**
+ * Select the chosen days of the week for delivery, from `0` (sunday) to `6` (saturday). Make sure to add the available hours, as shown in the example.
+ */
+dayOfWeekForDelivery: {
+/**
+ * Day of the week, from `0` (Sunday) to `6` (Saturday).
+ */
+dayOfWeek: (0 | 1 | 2 | 3 | 4 | 5 | 6)
+/**
+ * Reservation windows for scheduled delivery.
+ */
+deliveryRanges: {
+/**
+ * Start time for day of the week.
+ */
+startTime: string
+/**
+ * End time for day of the week.
+ */
+endTime: string
+/**
+ * List price for day of the week.
+ */
+listPrice: number
+/**
+ * Sets maximum delivery capacity for a given reservation window for scheduled delivery.
+ */
+deliveryCapacity?: {
+/**
+ * Defines how the delivery capacity is measured for this reservation window, by maximum number of orders (`"ORDERS_QUANTITY"`) or SKUs (`"SKUS_QUANTITY"`).
+ */
+capacityType: string
+/**
+ * Maximum number of orders or SKUs that the store is capable of fulfilling.
+ */
+maxValue: number
+}[]
+}[]
+}[]
+}
+}
+}
+/**
+ * Deletes a [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) of your store, searching by shipping policy ID. 
+ * 
+ * >⚠️ While most endpoints return time fields in UTC format, this endpoint returns **Scheduled Delivery** related time fields adjusted to the time zone configured for the VTEX account. 
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics shipping full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics shipping full access |
+ * | OMS - Full access | Logistics shipping full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"DELETE /api/logistics/pvt/shipping-policies/:id": {
+
+}
+/**
+ * Lists all [shipping policies](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) from your store.
+ * 
+ * >⚠️ While most endpoints return time fields in UTC format, this endpoint returns **Scheduled Delivery** related time fields adjusted to the time zone configured for the VTEX account.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics viewer** |
+ * | Logistics | Logistics access | **Logistics shipping full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics viewer |
+ * | Logistics - Read only | Logistics viewer |
+ * | Logistics - Full access | Logistics shipping full access |
+ * | OMS - Full access | Logistics shipping full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"GET /api/logistics/pvt/shipping-policies": {
+searchParams: {
+/**
+ * Number of the starting page of the response. When no value is sent, it starts in page `1`.
+ */
+page?: number
+/**
+ * Desired number of items per page, to retrieve information from your shipping policies.
+ */
+perPage?: number
+}
+/**
+ * Paged shipping policies list.
+ */
+response: {
+/**
+ * List of shipping policies related to the account.
+ */
+items?: {
+/**
+ * [Shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) ID.
+ */
+id?: string
+/**
+ * [Shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) name.
+ */
+name?: string
+/**
+ * Type of shipping available for this shipping policy (carrier). Options are shown on [shipping simulation](https://help.vtex.com/en/tutorial/shipping-simulation--tutorials_144).
+ */
+shippingMethod?: string
+/**
+ * If the shipping policy includes deliveries on weekends and holidays.
+ */
+weekendAndHolidays?: {
+/**
+ * Defines if shipping on Saturdays is valid (`true`) or not (`false`).
+ */
+saturday?: boolean
+/**
+ * Defines if shipping on Sundays is valid (`true`) or not (`false`).
+ */
+sunday?: boolean
+/**
+ * Defines if shipping on holidays is valid (`true`) or not (`false`).
+ */
+holiday?: boolean
+}
+/**
+ * Object containing attributes of maximum dimension permitted by the shipping policy (carrier).
+ */
+maxDimension?: {
+/**
+ * Largest measure acceptable of the package.
+ */
+largestMeasure?: number
+/**
+ * Limit for the sum of all maximum measures of the package.
+ */
+maxMeasureSum?: number
+}
+/**
+ * Determines the number of items allowed per shipment.
+ */
+numberOfItemsPerShipment?: number
+/**
+ * Minimum value accepted by the carrier for delivering.
+ */
+minimumValueAceptable?: number
+/**
+ * Maximum value accepted by the carrier for delivering.
+ */
+maximumValueAceptable?: number
+/**
+ * @deprecated
+ * Additional time configured in `HH:MM:SS` format.
+ */
+additionalTime?: string
+/**
+ * @deprecated
+ * Additional price object.
+ */
+additionalPrice?: {
+/**
+ * @deprecated
+ * Additional price method.
+ */
+method?: number
+/**
+ * @deprecated
+ * Payment value.
+ */
+value?: number
+}
+/**
+ * [Scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) settings.
+ */
+deliveryScheduleSettings?: {
+/**
+ * Defines if the scheduled delivery configuration is active (`true`) or not (`false`).
+ */
+useDeliverySchedule?: boolean
+/**
+ * Range of days available within a delivery window, for the customer to choose the scheduled delivery. For example, if the configured `maxRangeDelivery` is equal `7`, and the customer buys something on a Tuesday, the options for scheduled delivery will be shown until the following Tuesday (7 days from the purchase day). If no options are available within the `maxRangeDelivery` set, the shipping policy will not be shown on the checkout.
+ */
+maxRangeDelivery?: number
+/**
+ * Selected days for delivery, from `0` (Sunday) to `6` (Saturday).
+ */
+dayOfWeekForDelivery?: {
+/**
+ * Day of the week, from `0` (Sunday) to `6` (Saturday).
+ */
+dayOfWeek?: number
+/**
+ * Reservation window for scheduled delivery.
+ */
+deliveryRanges?: {
+/**
+ * Start time for day of the week in `hh:mm:ss` format.
+ */
+startTime?: string
+/**
+ * End time for day of the week in `hh:mm:ss` format.
+ */
+endTime?: string
+/**
+ * List price for day of the week.
+ */
+listPrice?: number
+/**
+ * Sets maximum [delivery capacity](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz) for a given reservation window for scheduled delivery.
+ */
+deliveryCapacity?: (null | {
+/**
+ * Defines how the delivery capacity is measured for this reservation window, by maximum number of orders (`ORDERS_QUANTITY`) or items (`SKUS_QUANTITY`).
+ */
+capacityType?: string
+/**
+ * Maximum number of orders or SKUs that the store is capable of fulfilling.
+ */
+maxValue?: number
+}[])
+}[]
+}[]
+/**
+ * @deprecated
+ * Defines if there are any days of the week that are blocked.
+ */
+dayOfWeekBlockeds?: (null | string[])
+}
+/**
+ * Schedule sent by the carrier to configure the shipping policy.
+ */
+carrierSchedule?: {
+/**
+ * Day of the week from `0` (Sunday) to `6` (Saturday).
+ */
+dayOfWeek?: number
+/**
+ * Time limit in `HH:MM:SS` format.
+ */
+timeLimit?: string
+}[]
+/**
+ * Settings for the cubic weight of a package, which accounts for the [package's volume](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128), and not only weight.
+ */
+cubicWeightSettings?: {
+/**
+ * Factor that will be used on the cubic weight calculation, usually given by the carrier.
+ */
+volumetricFactor?: number
+/**
+ * Packages' minimum acceptable [volumetric weight](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128).
+ */
+minimunAcceptableVolumetricWeight?: number
+}
+/**
+ * Configurations for the [modal](https://help.vtex.com/en/tutorial/how-does-the-modal-work--tutorials_125), which is the attachement of a specific product to a carrier specialized in delivering that type of product.
+ */
+modalSettings?: {
+/**
+ * Type of special freight.
+ */
+modals?: ("CHEMICALS" | "ELECTRONICS" | "FURNITURE" | "GLASS" | "LIQUID" | "MATTRESSES" | "REFRIGERATED" | "TIRES" | "WHITE_GOODS" | "FIREARMS")[]
+/**
+ * When set as `true`, the modal's configurations will apply only for items with a defined modal, when `false`, the modal configuration will not be set.
+ */
+useOnlyItemsWithDefinedModal?: boolean
+}
+/**
+ * Business hours configurations.
+ */
+businessHourSettings?: {
+/**
+ * Business hours configurations array for the days of the week.
+ */
+carrierBusinessHours?: {
+/**
+ * Opening time in `HH:MM:SS` format.
+ */
+openingTime?: string
+/**
+ * Closing time in `HH:MM:SS` format.
+ */
+closingTime?: string
+/**
+ * Day of the week from `0` (Sunday) to `6` (Saturday).
+ */
+dayOfWeek?: (0 | 1 | 2 | 3 | 4 | 5 | 6)
+}[]
+/**
+ * Defines if deliveries outside business hours are allowed (`true`) or not (`false`).
+ */
+isOpenOutsideBusinessHours?: boolean
+}
+/**
+ * [Pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) configurations of the shipping policy.
+ */
+pickupPointsSettings?: {
+/**
+ * Pickup point IDs configured for the shipping policy.
+ */
+pickupPointIds?: string[]
+/**
+ * Pickup points tags configured for the shipping policy.
+ */
+pickupPointTags?: string[]
+/**
+ * Sellers associated with [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) related to the shipping policy.
+ */
+sellers?: string[]
+}
+/**
+ * Shipping policy processing status.
+ */
+processingStatus?: {
+/**
+ * Shipping policy processing status code.
+ */
+status?: number
+/**
+ * Error message, when applicable.
+ */
+errorMessage?: (null | string)
+/**
+ * Error metadata, when applicable.
+ */
+errorsMetadata?: (null | string)
+}
+/**
+ * Defines if the shipping type is `delivery` or `pickup`.
+ */
+deliveryChannel?: string
+/**
+ * Shipping policy calculation type.
+ */
+calculationType?: number
+/**
+ * Defines if the shipping policy is active (`true`) or not (`false`).
+ */
+isActive?: boolean
+/**
+ * Date and time since the last [indexing](https://help.vtex.com/en/tutorial/understanding-how-indexation-works--tutorials_256), in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DD hh:mm:ss[.nnnnnnn]+hh:mm`.
+ */
+lastIndexedAt?: (null | string)
+/**
+ * Shipping hours settings configurations.
+ */
+shippingHoursSettings?: {
+/**
+ * Shipping hours settings array.
+ */
+shippingHours?: {
+/**
+ * Day of the week from `0` (Sunday) to `6` (Saturday).
+ */
+dayOfWeek?: number
+/**
+ * Opening time in `hh:mm:ss` format.
+ */
+openingTime?: string
+/**
+ * Closing time in `hh:mm:ss` format.
+ */
+closingTime?: string
+}[]
+/**
+ * Defines if the configuration that allows accepting orders outside shipping hours is active (`true`) or not (`false`).
+ */
+acceptOrdersOutsideShippingHours?: boolean
+}
+/**
+ * [Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) information.
+ */
+carrierInfo?: {
+/**
+ * VTEX store account name related to the shipping policy.
+ */
+carrierAccountName?: string
+/**
+ * Delivery agreement ID.
+ */
+deliveryAgreementId?: (null | string)
+/**
+ * Shipping policy [loading docks](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) valid for the carrier.
+ */
+linkedDocks?: {
+/**
+ * Loading dock ID.
+ */
+id?: string
+/**
+ * Loading dock name.
+ */
+name?: string
+}[]
+/**
+ * Defines if shipping configurations related to the carrier make them ready for shipping (`true`) or not (`false`).
+ */
+readyToUse?: boolean
+}
+}[]
+/**
+ * Pagination information.
+ */
+paging?: {
+/**
+ * Number of the current page of the response. By default, it returns page `1`.
+ */
+page?: number
+/**
+ * Number of shipping policies per page.
+ */
+perPage?: number
+/**
+ * Total number of existing shipping policies.
+ */
+total?: number
+/**
+ * Total number of pages, considering all shipping policies.
+ */
+pages?: number
+}
+}
+}
+/**
+ * Configure a new [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) for your store. 
+ * 
+ * >⚠️ While most endpoints return time fields in UTC format, this endpoint returns **Scheduled Delivery** related time fields adjusted to the time zone configured for the VTEX account. 
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics shipping full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics shipping full access |
+ * | OMS - Full access | Logistics shipping full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"POST /api/logistics/pvt/shipping-policies": {
+body: {
+/**
+ * ID of the shipping policy.
+ */
+id: string
+/**
+ * Name of the shipping policy.
+ */
+name: string
+/**
+ * Type of shipping available for this shipping policy (carrier). Options shown on freight simulation.
+ */
+shippingMethod: string
+/**
+ * If the shipping policy includes deliveries on weekends and holidays.
+ */
+weekendAndHolidays: {
+/**
+ * Defines if the shipping policy allows deliveries on Saturdays (`true`), or not (`false`).
+ */
+saturday: boolean
+/**
+ * Defines if the shipping policy allows deliveries on Sundays (`true`), or not (`false`).
+ */
+sunday: boolean
+/**
+ * Defines if the shipping policy allows deliveries on holidays (`true`), or not (`false`).
+ */
+holiday: boolean
+}
+/**
+ * Object containing attributes of maximum dimension permitted by the shipping policy (carrier).
+ */
+maxDimension: {
+/**
+ * Largest measure of the package.
+ */
+largestMeasure: number
+/**
+ * Sum of all maximum measures of the package.
+ */
+maxMeasureSum: number
+}
+/**
+ * Capacity of your store's logistics of shipment, determines number of items permitted per shipment.
+ */
+numberOfItemsPerShipment: number
+/**
+ * Minimum value accepted by the carrier, to realize the shipping.
+ */
+minimumValueAceptable: number
+/**
+ * Maximum value accepted by the carrier, to realize the shipping.
+ */
+maximumValueAceptable: number
+/**
+ * Settings for the Scheduled Delivery feature.
+ */
+deliveryScheduleSettings: {
+/**
+ * Select the Scheduled Delivery configuration.
+ */
+useDeliverySchedule: boolean
+/**
+ * Range of days available within a delivery window, for the customer to choose the scheduled delivery. For example, if the configured maxRangeDelivery is equal 7, and the customer buys something on a Tuesday, the options for scheduled delivery will be shown until the following Tuesday (7 days from the purchase day). If no options are available within the maxRangeDelivery set, this shipping policy won't be shown on the checkout.
+ */
+maxRangeDelivery: number
+/**
+ * Select the chosen days for delivery. Values for each day of the week are: `0` = Sunday, `1` = Monday, `2` = Tuesday, `3` = Wednesday, `4` = Thursday, `5` = Friday, `6` = Saturday. Make sure to add the available hours for the chosen days, following the example.
+ */
+dayOfWeekForDelivery: {
+/**
+ * Day of the week, from `0` (sunday) to `6` (saturday).
+ */
+dayOfWeek: number
+/**
+ * Reservation windows for scheduled delivery.
+ */
+deliveryRanges: {
+/**
+ * Start time for day of the week.
+ */
+startTime: string
+/**
+ * End time for day of the week.
+ */
+endTime: string
+/**
+ * List price for day of the week.
+ */
+listPrice: number
+/**
+ * Sets maximum delivery capacity for a given reservation window for scheduled delivery.
+ */
+deliveryCapacity?: {
+/**
+ * Defines how the delivery capacity is measured for this reservation window, by maximum number of orders (`"ORDERS_QUANTITY"`) or SKUs (`"SKUS_QUANTITY"`).
+ */
+capacityType: string
+/**
+ * Maximum number of orders or SKUs that the store is capable of fulfilling.
+ */
+maxValue: number
+}[]
+}[]
+}[]
+}
+/**
+ * Schedule sent by the carrier to configure the shipping policy.
+ */
+carrierSchedule?: {
+/**
+ * Day of the week, from `0` (sunday) to `6` (saturday).
+ */
+dayOfWeek?: number
+/**
+ * Time limit.
+ */
+timeLimit?: string
+}[]
+/**
+ * Measure including the [package's volume](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128), and not only weight.
+ */
+cubicWeightSettings: {
+/**
+ * Factor that will be used on the cubic weight calculation.
+ */
+volumetricFactor: number
+/**
+ * Packages' minimum acceptable [volumetric weight](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128).
+ */
+minimunAcceptableVolumetricWeight: number
+}
+/**
+ * Configurations for the [modal](https://help.vtex.com/en/tutorial/how-does-the-modal-work--tutorials_125), which is the attachement of a specific product to a carrier specialized in delivering that type of product.
+ */
+modalSettings: {
+/**
+ * Type of special freight.
+ */
+modals: ("CHEMICALS" | "ELECTRONICS" | "FURNITURE" | "GLASS" | "LIQUID" | "MATTRESSES" | "REFRIGERATED" | "TIRES" | "WHITE_GOODS" | "FIREARMS")[]
+/**
+ * Defines if the modal's configurations will apply only for items with a defined modal (`true`) or not (`false`).
+ */
+useOnlyItemsWithDefinedModal: boolean
+}
+/**
+ * Business hours configurations.
+ */
+businessHourSettings: {
+/**
+ * Carrier business hours configurations for the week.
+ */
+carrierBusinessHours: {
+/**
+ * Opening time.
+ */
+openingTime: string
+/**
+ * Closing time.
+ */
+closingTime: string
+/**
+ * Day of the week, from `0` (Sunday) to `6` (Saturday).
+ */
+dayOfWeek: number
+}[]
+/**
+ * Select whether the shipping policy allows deliveries outside business hours (`true`) or not (`false`).
+ */
+isOpenOutsideBusinessHours: boolean
+}
+/**
+ * Configuration for Pickup Points.
+ */
+pickupPointsSettings: (null | {
+/**
+ * Insert the IDs for pickup points previously configured in your store.
+ */
+pickupPointIds: string[]
+/**
+ * Insert the tags for pickup points previously configured in your store.
+ */
+pickupPointTags: string[]
+/**
+ * Sellers that will be associated with the [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) of the shipping policy being created.
+ */
+sellers: string[]
+})
+/**
+ * Defines if the shipping policy is active (`true`) or not (`false`).
+ */
+isActive: boolean
+}
+}
+/**
+ * Creates or updates freight values for your store's carriers. Learn more in [Shipping rate template](https://help.vtex.com/en/tutorial/shipping-rate-template--tutorials_127).
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics shipping full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics shipping full access |
+ * | OMS - Full access | Logistics shipping full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"POST /api/logistics/pvt/configuration/freights/:carrierId/values/update": {
+/**
+ * Array of objects, each containing information on a specific freight interval.
+ */
+body: {
+/**
+ * Fixed shipping cost to be charged in a decimal number.
+ */
+absoluteMoneyCost: string
+/**
+ * Three letter ISO code for the country where the delivery will take place.
+ */
+country: string
+/**
+ * Maximum volume that can be transported by the carrier in cm³.
+ */
+maxVolume: number
+/**
+ * Indicates desired action for the object. Possible values are `1` (Insert), `2` (Update) or `3`(Delete).
+ */
+operationType: number
+/**
+ * [Price-based additional shipping charge](https://help.vtex.com/en/tutorial/additional-shipping-costs--2vqGwMn0LabkOHY6zSHYNV), calculated based on the total price of the order, in decimal number. You must fill in this field with a percentage value. For example, for an additional charge of 10%, fill in the table with 10.
+ */
+pricePercent: number
+/**
+ * [Weight-based additional shipping charge](https://help.vtex.com/en/tutorial/additional-shipping-costs--2vqGwMn0LabkOHY6zSHYNV), calculated based on the total weight of the order.
+ */
+pricePercentByWeight: number
+/**
+ * Delivery time frame informed by the carrier, in the format `DD.HH:MM:SS`.
+ */
+timeCost: string
+/**
+ * Maximum weight allowed.
+ */
+weightEnd: number
+/**
+ * Minimum weight allowed.
+ */
+weightStart: number
+/**
+ * End of postal code interval.
+ */
+zipCodeEnd: string
+/**
+ * Start of postal code interval.
+ */
+zipCodeStart: string
+/**
+ * Polygon ID, according to the [geolocation](https://help.vtex.com/en/tutorial/registering-geolocation/) feature.
+ */
+polygon: string
+}[]
+}
+/**
+ * Lists freight values appointed to your store's carriers, searching by carrier ID and postal code (`cep`). The information is retrieved from your [shipping rate template](https://help.vtex.com/en/tutorial/shipping-rate-template--tutorials_127) configurations.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics viewer** |
+ * | Logistics | Logistics access | **Logistics shipping full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics viewer |
+ * | Logistics - Read only | Logistics viewer |
+ * | Logistics - Full access | Logistics shipping full access |
+ * | OMS - Full access | Logistics shipping full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"GET /api/logistics/pvt/configuration/freights/:carrierId/:cep/values": {
+/**
+ * List of freight values.
+ */
+response: {
+/**
+ * Postal code interval starting point.
+ */
+zipCodeStart: string
+/**
+ * Postal code interval ending point.
+ */
+zipCodeEnd: string
+/**
+ * Minimum weight allowed.
+ */
+weightStart: number
+/**
+ * Maximum weight allowed.
+ */
+weightEnd: number
+/**
+ * Fixed shipping cost to be charged, in a decimal number.
+ */
+absoluteMoneyCost: number
+/**
+ * [Price-based additional shipping charge](https://help.vtex.com/en/tutorial/additional-shipping-costs--2vqGwMn0LabkOHY6zSHYNV), calculated based on the total price of the order, in decimal number. You must fill in this field with a percentage value. For example, for an additional charge of 10%, fill in the table with `10`.
+ */
+pricePercent: number
+/**
+ * [Weight-based additional shipping charge](https://help.vtex.com/en/tutorial/additional-shipping-costs--2vqGwMn0LabkOHY6zSHYNV), calculated based on the total weight of the order.
+ */
+pricePercentByWeight: number
+/**
+ * Maximum volume that can be transported by the carrier in cm³.
+ */
+maxVolume: number
+/**
+ * Delivery time frame informed by the carrier, in the format `DD.HH:MM:SS`.
+ */
+timeCost: string
+/**
+ * Three letter ISO code for the country for the given postal code.
+ */
+country: string
+/**
+ * Indicates the operation type, which can be `1` (Insert), `2` (Update) or `3`(Delete).
+ */
+operationType: number
+/**
+ * List of postal codes where the delivery is restricted for the given carrier.
+ */
+restrictedFreights: (null | string[])
+/**
+ * Polygon ID, according to the [geolocation](https://help.vtex.com/en/tutorial/registering-geolocation/) feature.
+ */
+polygon: string
+/**
+ * Insurance minimum value.
+ */
+minimumValueInsurance: number
+}[]
+}
+/**
+ * Lists all blocked delivery windows of your store's shipping policies, searching by carrier ID.
+ * 
+ * 
>⚠️ While most of our API endpoints return time fields in UTC format, this endpoint returns **Scheduled Delivery** related time fields adjusted to the configured time zone of the account.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics viewer** |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics shipping full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics viewer |
+ * | Logistics - Read only | Logistics viewer |
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics shipping full access |
+ * | OMS - Full access | Logistics shipping full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"GET /api/logistics/pvt/configuration/carriers/:carrierId/getdayofweekblocked": {
+/**
+ * List of blocked delivery windows date and time.
+ */
+response: string[]
+}
+/**
+ * Adds blocked delivery windows for your store's shipping policies.
+ * 
+ * 
>⚠️ While most of our API endpoints return time fields in UTC format, this endpoint returns time adjusted to the configured time zone of the account.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics shipping full access** |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics shipping full access |
+ * | OMS - Full access | Logistics shipping full access |
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"POST /api/logistics/pvt/configuration/carriers/:carrierId/adddayofweekblocked": {
+/**
+ * Delivery window block starting date and time in the format `YYYY-MM-DDTHH:MM:SS`. The time zone is set according to the store account. Requests with incorrect values will be disconsidered by the system (for example, a date in the past), regardless of a successful response.
+ */
+body: string
+/**
+ * Successful requests return the message `true`.
+ */
+response: boolean
+}
+/**
+ * Removes blocked delivery windows configured for a shipping policy of your [shipping strategy](https://help.vtex.com/en/tutorial/shipping-strategy--58vLBDbjYVQzJ6rRc5QNz3).
+ * 
+ * 
>⚠️ While most of our endpoints return time values in UTC format, this endpoint returns time adjusted to the time zone set for the account.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics shipping full access** |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics shipping full access |
+ * | OMS - Full access | Logistics shipping full access |
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"POST /api/logistics/pvt/configuration/carriers/:carrierId/removedayofweekblocked": {
+/**
+ * Date and time of the delivery window block being removed, in the format `YYYY-MM-DDTHH:MM:SS`. The time zone is set according to the store account.
+ */
+body: string
+/**
+ * Successful requests return the message `true`.
+ */
+response: boolean
+}
+/**
+ * Retrieves information about all [loading docks](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) of your store's [shipping strategy](https://help.vtex.com/en/tutorial/shipping-strategy--58vLBDbjYVQzJ6rRc5QNz3).
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics viewer** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics viewer |
+ * | Logistics - Read only | Logistics viewer |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"GET /api/logistics/pvt/configuration/docks": {
+/**
+ * List with docks information.
+ */
+response: {
+/**
+ * @deprecated
+ * Information about a loading dock that was transformed into a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).
+ */
+pickupStoreInfo?: {
+/**
+ * @deprecated
+ * Defines if the shipping type was pickup (`true`) or not (`false`).
+ */
+isPickupStore?: (null | boolean)
+/**
+ * @deprecated
+ * Store ID for stores that acted as pickup points.
+ */
+storeId?: (null | string)
+/**
+ * @deprecated
+ * Name of the pickup point displayed at checkout.
+ */
+friendlyName?: (null | string)
+/**
+ * @deprecated
+ * Pickup point address information.
+ */
+address?: (null | {
+/**
+ * @deprecated
+ * Pickup point address postal code.
+ */
+postalCode?: string
+/**
+ * @deprecated
+ * Information about the pickup point address country.
+ */
+country?: {
+/**
+ * @deprecated
+ * Three-digit country code of the pickup point address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.
+ */
+acronym?: string
+/**
+ * @deprecated
+ * Country name of the pickup point address.
+ */
+name?: string
+}
+/**
+ * @deprecated
+ * Pickup point address city.
+ */
+city?: string
+/**
+ * @deprecated
+ * Pickup point address state.
+ */
+state?: string
+/**
+ * @deprecated
+ * Pickup point address neighborhood.
+ */
+neighborhood?: string
+/**
+ * @deprecated
+ * Pickup point address street.
+ */
+street?: string
+/**
+ * @deprecated
+ * Pickup point address number.
+ */
+number?: string
+/**
+ * @deprecated
+ * Pickup point address complement.
+ */
+complement?: (null | string)
+/**
+ * @deprecated
+ * Pickup point address reference point.
+ */
+reference?: (null | string)
+/**
+ * @deprecated
+ * Pickup point address geolocation coordinates.
+ */
+location?: {
+/**
+ * @deprecated
+ * Latitude coordinate.
+ */
+latitude?: number
+/**
+ * @deprecated
+ * Longitude coordinate.
+ */
+longitude?: number
+}
+})
+/**
+ * @deprecated
+ * Additional information about the delivery or the pickup point.
+ */
+additionalInfo?: (null | string)
+/**
+ * @deprecated
+ * ID of the [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj related to the delivery or the pickup point ID.
+ */
+dockId?: (null | string)
+/**
+ * @deprecated
+ * Distance in kilometers between the pickup point and the customer's address, measured as a straight line.
+ */
+distance?: (null | number)
+/**
+ * @deprecated
+ * Pickup point business hours configurations.
+ */
+businessHours?: (null | string)
+/**
+ * @deprecated
+ * Holiday's configurations applicable to the pickup point.
+ */
+pickupHolidays?: (null | string)
+/**
+ * @deprecated
+ * Seller ID.
+ */
+sellerId?: (null | string)
+/**
+ * @deprecated
+ * Defines if the pickup was third party (`true`) or not (`false`).
+ */
+isThirdPartyPickup?: boolean
+}
+/**
+ * Store ID.
+ */
+storeId?: (null | string)
+/**
+ * Information about the physical store as a pickup point.
+ */
+pickupInStoreInfo?: {
+/**
+ * Defines if the physical store is a pickup point (`true`) or not (`false`).
+ */
+isActice?: boolean
+/**
+ * Additional information of the store as a pickup point.
+ */
+additionalInfo?: (null | string)
+}
+/**
+ * Settings for delivery from a physical store.
+ */
+deliveryFromStoreInfo?: {
+/**
+ * Defines if the settings for delivery from physical stores are active (`true`) or inactive (`false`).
+ */
+isActice?: boolean
+/**
+ * Delivery radius.
+ */
+deliveryRadius?: number
+/**
+ * Delivery fee.
+ */
+deliveryFee?: number
+/**
+ * Delivery time in the format `DD.HH:MM:SS`.
+ */
+deliveryTime?: string
+/**
+ * Delivery maximum weight.
+ */
+maximumWeight?: number
+}
+/**
+ * Loading dock address.
+ */
+address?: {
+/**
+ * Loading dock address postal code.
+ */
+postalCode?: string
+/**
+ * Information about the loading dock address country.
+ */
+country?: {
+/**
+ * Three-digit country code of the loading dock address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.
+ */
+acronym?: string
+/**
+ * Country name of the loading dock address.
+ */
+name?: string
+}
+/**
+ * Loading dock address city.
+ */
+city?: string
+/**
+ * Loading dock address state.
+ */
+state?: string
+/**
+ * Loading dock address neighborhood.
+ */
+neighborhood?: string
+/**
+ * Loading dock address street.
+ */
+street?: string
+/**
+ * Loading dock address number.
+ */
+number?: string
+/**
+ * Loading dock address complement.
+ */
+complement?: (null | string)
+/**
+ * Loading dock address reference point.
+ */
+reference?: (null | string)
+/**
+ * Loading dock address geolocation coordinates.
+ */
+location?: {
+/**
+ * Latitude coordinate.
+ */
+latitude?: number
+/**
+ * Longitude coordinate.
+ */
+longitude?: number
+}
+}
+/**
+ * Loading dock location details.
+ */
+location?: (null | {
+/**
+ * Loading dock address postal code.
+ */
+zipCode?: string
+/**
+ * Three-digit country code of the loading dock address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.
+ */
+country?: string
+/**
+ * Information related to orders made via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc).
+ */
+inStore?: {
+/**
+ * Defines if orders can be placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) (`true`) or not (`false`).
+ */
+IsCheckedIn?: boolean
+/**
+ * ID of purchases made in the GoCommerce context.
+ */
+StoreId?: (null | string)
+}
+})
+/**
+ * Shipping rates providers information.
+ */
+shippingRatesProviders?: (null | string[])
+/**
+ * Delivery agreements IDs information.
+ */
+deliveryAgreementsIds?: (null | string[])
+/**
+ * [Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.
+ */
+id?: string
+/**
+ * Loading dock name.
+ */
+name?: string
+/**
+ * Value from `0` to `10` used as a tie-breaking rule for loading dock selecting. The greater the priority, the greater the possibility of the loading dock being chosen in [shipping calculation](https://help.vtex.com/en/tutorial/how-shipping-calculation-works--tutorials_116). When no priority was set, it corresponds to `0`.
+ */
+priority?: number
+/**
+ * [Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) processing time in the format `D.HH:MM:SS`. When not configured, it returns `00:00:00`.
+ */
+dockTimeFake?: string
+/**
+ * Time frame used to choose a loading dock when there is more than one loading dock with the same processing time. The lower the value entered in this field, the greater the possibility of the loading dock being chosen. 
+ * >ℹ️ This field is not considered when calculating the delivery time.
+ */
+timeFakeOverhead?: string
+/**
+ * Sales channels ([trade policies](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) associated with the loading dock.
+ */
+salesChannels?: string[]
+/**
+ * Main sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) associated with the loading dock.
+ */
+salesChannel?: string
+/**
+ * List with freight table IDs associated with the loading dock.
+ */
+freightTableIds?: string[]
+/**
+ * Endpoint for integrating an external Warehouse Management System (WMS).
+ */
+wmsEndPoint?: (null | string)
+/**
+ * Defines if the loading dock is active (`true`) or inactive (`false`).
+ */
+isActive?: boolean
+}[]
+}
+/**
+ * Creates a new [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) or updates an existing one for your store's [shipping strategy](https://help.vtex.com/en/tutorial/shipping-strategy--58vLBDbjYVQzJ6rRc5QNz3).
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"POST /api/logistics/pvt/configuration/docks": {
+body: {
+/**
+ * [Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.
+ */
+id: string
+/**
+ * Loading dock name.
+ */
+name: string
+/**
+ * Value used as a tie-breaking rule when selecting a loading dock.
+ */
+priority: number
+/**
+ * [Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) processing time in the format `D.HH:MM:SS`. When not configured, it returns `00:00:00`.
+ */
+dockTimeFake: string
+/**
+ * Time frame used to choose a loading dock when there is more than one loading dock with the same processing time. The lower the value entered in this field, the greater the possibility of the loading dock being chosen. 
+ * >ℹ️ This field is not considered when calculating the delivery time.
+ */
+timeFakeOverhead: string
+/**
+ * Sales channels ([trade policies](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) to associate with the loading dock.
+ */
+salesChannels: string[]
+/**
+ * Main sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) to associate with the loading dock.
+ */
+salesChannel: string
+/**
+ * List with freight table IDs.
+ */
+freightTableIds: string[]
+/**
+ * Warehouse Management System (WMS) fulfillment endpoint.
+ */
+wmsEndPoint: (null | string)
+/**
+ * Dock address object.
+ */
+address: {
+/**
+ * Dock address postal code.
+ */
+postalCode: string
+/**
+ * Dock address country object.
+ */
+country: {
+/**
+ * Three letter ISO code for the dock address country.
+ */
+acronym: string
+/**
+ * Dock address country name.
+ */
+name: string
+}
+/**
+ * Dock address city.
+ */
+city: string
+/**
+ * Dock address state.
+ */
+state: string
+/**
+ * Dock address neighborhood.
+ */
+neighborhood: string
+/**
+ * Dock address street.
+ */
+street: string
+/**
+ * Dock address number.
+ */
+number: string
+/**
+ * Dock address complement.
+ */
+complement: string
+/**
+ * Dock address geolocation coordinates.
+ */
+coordinates: number[][]
+}
+}
+/**
+ * Successful requests return the message `true`.
+ */
+response: boolean
+}
+/**
+ * Retrieves information about a [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) of your store's [shipping strategy](https://help.vtex.com/en/tutorial/shipping-strategy--58vLBDbjYVQzJ6rRc5QNz3), searching by dock ID.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics viewer** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics viewer |
+ * | Logistics - Read only | Logistics viewer |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"GET /api/logistics/pvt/configuration/docks/:dockId": {
+/**
+ * Loading dock information.
+ */
+response: {
+/**
+ * @deprecated
+ * Information about a loading dock that was transformed into a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).
+ */
+pickupStoreInfo?: {
+/**
+ * @deprecated
+ * Defines if the shipping type was pickup (`true`) or not (`false`).
+ */
+isPickupStore?: (null | boolean)
+/**
+ * @deprecated
+ * Store ID for stores that acted as pickup points.
+ */
+storeId?: (null | string)
+/**
+ * @deprecated
+ * Name of the pickup point displayed at checkout.
+ */
+friendlyName?: (null | string)
+/**
+ * @deprecated
+ * Pickup point address information.
+ */
+address?: (null | {
+/**
+ * @deprecated
+ * Pickup point address postal code.
+ */
+postalCode?: string
+/**
+ * @deprecated
+ * Information about the pickup point address country.
+ */
+country?: {
+/**
+ * @deprecated
+ * Three-digit country code of the pickup point address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.
+ */
+acronym?: string
+/**
+ * @deprecated
+ * Country name of the pickup point address.
+ */
+name?: string
+}
+/**
+ * @deprecated
+ * Pickup point address city.
+ */
+city?: string
+/**
+ * @deprecated
+ * Pickup point address state.
+ */
+state?: string
+/**
+ * @deprecated
+ * Pickup point address neighborhood.
+ */
+neighborhood?: string
+/**
+ * @deprecated
+ * Pickup point address street.
+ */
+street?: string
+/**
+ * @deprecated
+ * Pickup point address number.
+ */
+number?: string
+/**
+ * @deprecated
+ * Pickup point address complement.
+ */
+complement?: (null | string)
+/**
+ * @deprecated
+ * Pickup point address reference point.
+ */
+reference?: (null | string)
+/**
+ * @deprecated
+ * Pickup point address geolocation coordinates.
+ */
+location?: {
+/**
+ * @deprecated
+ * Latitude coordinate.
+ */
+latitude?: number
+/**
+ * @deprecated
+ * Longitude coordinate.
+ */
+longitude?: number
+}
+})
+/**
+ * @deprecated
+ * Additional information about the delivery or the pickup point.
+ */
+additionalInfo?: (null | string)
+/**
+ * @deprecated
+ * ID of the [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj related to the delivery or the pickup point ID.
+ */
+dockId?: (null | string)
+/**
+ * @deprecated
+ * Distance in kilometers between the pickup point and the customer's address, measured as a straight line.
+ */
+distance?: (null | number)
+/**
+ * @deprecated
+ * Pickup point business hours configurations.
+ */
+businessHours?: (null | string)
+/**
+ * @deprecated
+ * Holiday's configurations applicable to the pickup point.
+ */
+pickupHolidays?: (null | string)
+/**
+ * @deprecated
+ * Seller ID.
+ */
+sellerId?: (null | string)
+/**
+ * @deprecated
+ * Defines if the pickup was third party (`true`) or not (`false`).
+ */
+isThirdPartyPickup?: boolean
+}
+/**
+ * Store ID.
+ */
+storeId?: (null | string)
+/**
+ * Information about the physical store as a pickup point.
+ */
+pickupInStoreInfo?: {
+/**
+ * Defines if the physical store is a pickup point (`true`) or not (`false`).
+ */
+isActice?: boolean
+/**
+ * Additional information of the store as a pickup point.
+ */
+additionalInfo?: (null | string)
+}
+/**
+ * Settings for delivery from a physical store.
+ */
+deliveryFromStoreInfo?: {
+/**
+ * Defines if the settings for delivery from physical stores are active (`true`) or inactive (`false`).
+ */
+isActice?: boolean
+/**
+ * Delivery radius.
+ */
+deliveryRadius?: number
+/**
+ * Delivery fee.
+ */
+deliveryFee?: number
+/**
+ * Delivery time in the format `DD.HH:MM:SS`.
+ */
+deliveryTime?: string
+/**
+ * Delivery maximum weight.
+ */
+maximumWeight?: number
+}
+/**
+ * Loading dock address.
+ */
+address?: {
+/**
+ * Loading dock address postal code.
+ */
+postalCode?: string
+/**
+ * Information about the loading dock address country.
+ */
+country?: {
+/**
+ * Three-digit country code of the loading dock address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.
+ */
+acronym?: string
+/**
+ * Country name of the loading dock address.
+ */
+name?: string
+}
+/**
+ * Loading dock address city.
+ */
+city?: string
+/**
+ * Loading dock address state.
+ */
+state?: string
+/**
+ * Loading dock address neighborhood.
+ */
+neighborhood?: string
+/**
+ * Loading dock address street.
+ */
+street?: string
+/**
+ * Loading dock address number.
+ */
+number?: string
+/**
+ * Loading dock address complement.
+ */
+complement?: (null | string)
+/**
+ * Loading dock address reference point.
+ */
+reference?: (null | string)
+/**
+ * Loading dock address geolocation coordinates.
+ */
+location?: {
+/**
+ * Latitude coordinate.
+ */
+latitude?: number
+/**
+ * Longitude coordinate.
+ */
+longitude?: number
+}
+}
+/**
+ * Loading dock location details.
+ */
+location?: (null | {
+/**
+ * Loading dock address postal code.
+ */
+zipCode?: string
+/**
+ * Three-digit country code of the loading dock address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.
+ */
+country?: string
+/**
+ * Information related to orders made via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc).
+ */
+inStore?: {
+/**
+ * Defines if orders can be placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) (`true`) or not (`false`).
+ */
+IsCheckedIn?: boolean
+/**
+ * ID of purchases made in the GoCommerce context.
+ */
+StoreId?: (null | string)
+}
+})
+/**
+ * Shipping rates providers information.
+ */
+shippingRatesProviders?: (null | string[])
+/**
+ * Delivery agreements IDs information.
+ */
+deliveryAgreementsIds?: (null | string[])
+/**
+ * [Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.
+ */
+id?: string
+/**
+ * Loading dock name.
+ */
+name?: string
+/**
+ * Value from `0` to `10` used as a tie-breaking rule for loading dock selecting. The greater the priority, the greater the possibility of the loading dock being chosen in [shipping calculation](https://help.vtex.com/en/tutorial/how-shipping-calculation-works--tutorials_116). When no priority was set, it corresponds to `0`.
+ */
+priority?: number
+/**
+ * [Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) processing time in the format `D.HH:MM:SS`. When not configured, it returns `00:00:00`.
+ */
+dockTimeFake?: string
+/**
+ * Time frame used to choose a loading dock when there is more than one loading dock with the same processing time. The lower the value entered in this field, the greater the possibility of the loading dock being chosen. 
+ * >ℹ️ This field is not considered when calculating the delivery time.
+ */
+timeFakeOverhead?: string
+/**
+ * Sales channels ([trade policies](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) associated with the loading dock.
+ */
+salesChannels?: string[]
+/**
+ * Main sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) associated with the loading dock.
+ */
+salesChannel?: string
+/**
+ * List with freight table IDs associated with the loading dock.
+ */
+freightTableIds?: string[]
+/**
+ * Endpoint for integrating an external Warehouse Management System (WMS).
+ */
+wmsEndPoint?: (null | string)
+/**
+ * Defines if the loading dock is active (`true`) or inactive (`false`).
+ */
+isActive?: boolean
+}
+}
+/**
+ * Deletes a [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj), searching by dock ID.
+ * 
+ * Successful requests receive a `200 OK` status code with `true` in the response body.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"DELETE /api/logistics/pvt/configuration/docks/:dockId": {
+/**
+ * Successful requests return the message `true`.
+ */
+response: boolean
+}
+/**
+ * Activates a [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) of your store's [shipping strategy](https://help.vtex.com/en/tutorial/shipping-strategy--58vLBDbjYVQzJ6rRc5QNz3), searching by dock ID.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"POST /api/logistics/pvt/configuration/docks/:dockId/activation": {
+
+}
+/**
+ * Deactivates a [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) of your store's [shipping strategy](https://help.vtex.com/en/tutorial/shipping-strategy--58vLBDbjYVQzJ6rRc5QNz3), searching by dock ID.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"POST /api/logistics/pvt/configuration/docks/:dockId/deactivation": {
+
+}
+/**
+ * Lists all [warehouses](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) set up in your store.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics viewer** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics viewer |
+ * | Logistics - Read only | Logistics viewer |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"GET /api/logistics/pvt/configuration/warehouses": {
+response: {
+/**
+ * Warehouse ID.
+ */
+id?: string
+/**
+ * Warehouse name.
+ */
+name?: string
+/**
+ * List of [loading docks](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) related to the warehouse.
+ */
+warehouseDocks?: {
+/**
+ * Loading dock ID.
+ */
+dockId?: string
+/**
+ * Loading dock processing time in the format `D.HH:MM:SS`. When it was not configured, it returns `00:00:00`.
+ */
+time?: string
+/**
+ * Extra charges added to the shipping rate when **Additional shipping costs** are configured.
+ */
+cost?: number
+}[]
+/**
+ * List of [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) associated with the warehouse.
+ */
+pickupPointIds?: string[]
+/**
+ * Warehouse priority. When no priority was set, it corresponds to `0`.
+ */
+priority?: number
+/**
+ * Shows if the warehouse is active (`true`) or inactive (`false`).
+ */
+isActive?: boolean
+}[]
+}
+/**
+ * Creates or updates a [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"POST /api/logistics/pvt/configuration/warehouses": {
+/**
+ * [Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) to be created or updated.
+ */
+body: {
+/**
+ * Warehouse ID.
+ */
+id: string
+/**
+ * Warehouse name.
+ */
+name: string
+/**
+ * List of [loading docks](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) to associate with the warehouse.
+ */
+warehouseDocks: {
+/**
+ * Loading dock ID.
+ */
+dockId: string
+/**
+ * Loading dock name.
+ */
+name: string
+/**
+ * Loading dock processing time in the format `D.HH:MM:SS`. When it was not configured, it returns `00:00:00`.
+ */
+time: string
+/**
+ * Extra charges added to the shipping rate when **Additional shipping costs** are configured.
+ */
+cost: string
+/**
+ * Translate days.
+ */
+translateDays: string
+/**
+ * Cost to display.
+ */
+costToDisplay: string
+}[]
+/**
+ * Optional configuration of the warehouse priority. When no priority was set, it corresponds to `0`.
+ */
+priority?: number
+/**
+ * Defines if the warehous is active (`true`) or not (`false`).
+ */
+isActive?: boolean
+}
+}
+/**
+ * Retrieves information of a [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb), searching by warehouse ID.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics viewer** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics viewer |
+ * | Logistics - Read only | Logistics viewer |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"GET /api/logistics/pvt/configuration/warehouses/:warehouseId": {
+response: {
+/**
+ * [Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.
+ */
+id?: string
+/**
+ * Warehouse name.
+ */
+name?: string
+/**
+ * List of [loading docks](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) related to the warehouse.
+ */
+warehouseDocks?: {
+/**
+ * Loading dock ID.
+ */
+dockId?: string
+/**
+ * Loading dock processing time in the format `D.HH:MM:SS`. When it was not configured, it returns `00:00:00`.
+ */
+time?: string
+/**
+ * Extra charges added to the shipping rate when **Additional shipping costs** are configured.
+ */
+cost?: number
+}[]
+/**
+ * List of [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) associated with the warehouse.
+ */
+pickupPointIds?: string[]
+/**
+ * Warehouse priority. When no priority was set, it corresponds to `0`.
+ */
+priority?: number
+/**
+ * Shows if the warehouse is active (`true`) or inactive (`false`).
+ */
+isActive?: boolean
+}
+}
+/**
+ * Deletes a [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb), searching by warehouse ID.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"DELETE /api/logistics/pvt/configuration/warehouses/:warehouseId": {
+
+}
+/**
+ * Activates a [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb), searching by warehouse ID.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"POST /api/logistics/pvt/configuration/warehouses/:warehouseId/activation": {
+
+}
+/**
+ * Deactivates a [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb), searching by warehouse ID.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"POST /api/logistics/pvt/configuration/warehouses/:warehouseId/deactivation": {
+
+}
+/**
+ * Lists [inventory](https://help.vtex.com/en/tutorial/inventory-management--tutorials_139) information, searching by SKU ID.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics viewer** |
+ * | Logistics | Logistics access | **Logistics inventory full access** |
+ * | Logistics | Logistics access | **Logistics inventory read only** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics viewer |
+ * | Logistics - Read only | Logistics viewer |
+ * | Logistics - Full access | Logistics inventory full access |
+ * | OMS - Full access | Logistics inventory full access |
+ * | Logistics - Full access | Logistics inventory read only |
+ * | Logistics - Read only | Logistics inventory read only |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"GET /api/logistics/pvt/inventory/skus/:skuId": {
+response: {
+/**
+ * SKU ID.
+ */
+skuId?: string
+/**
+ * List with warehouses' inventory details.
+ */
+balance?: {
+/**
+ * [Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.
+ */
+warehouseId?: string
+/**
+ * Warehouse name.
+ */
+warehouseName?: string
+/**
+ * Total quantity of items of the given SKU.
+ */
+totalQuantity?: number
+/**
+ * SKU reserved quantity.
+ */
+reservedQuantity?: number
+/**
+ * When set as `false`, every sold unit decreases the item's available quantity. When set as `true`, the SKU from the warehouse is always available for sale. No matter how many units are sold, the SKU available quantity never decreases, and the SKU is never out of stock.
+ */
+hasUnlimitedQuantity?: boolean
+/**
+ * Time to refill.
+ */
+timeToRefill?: (null | string)
+/**
+ * Supply date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.
+ */
+dateOfSupplyUtc?: (null | string)
+/**
+ * [Lead time](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B) is an optional time configuration you can make for a SKU in a warehouse. It can be handling time, fabrication or how long it takes for the item to be available to be shipped to customers. The lead time is a part of the total shipping time and will be considered for shipping date calculation. The format is `DD.HH:MM:SS`.
+ */
+leadTime?: string
+}[]
+}
+}
+/**
+ * Lists [inventory](https://help.vtex.com/en/tutorial/inventory-management--tutorials_139) information, searching by [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics viewer** |
+ * | Logistics | Logistics access | **Logistics inventory full access** |
+ * | Logistics | Logistics access | **Logistics inventory read only** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics viewer |
+ * | Logistics - Read only | Logistics viewer |
+ * | Logistics - Full access | Logistics inventory full access |
+ * | OMS - Full access | Logistics inventory full access |
+ * | Logistics - Full access | Logistics inventory read only |
+ * | Logistics - Read only | Logistics inventory read only |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"GET /api/logistics/pvt/inventory/items/:skuId/warehouses/:warehouseId": {
+response: {
+/**
+ * SKU ID.
+ */
+skuId?: string
+/**
+ * Warehouse ID.
+ */
+warehouseId?: string
+/**
+ * Dock ID.
+ */
+dockId?: string
+/**
+ * Total quantity of SKU.
+ */
+totalQuantity?: number
+/**
+ * Reserved quantity of the SKU.
+ */
+reservedQuantity?: number
+/**
+ * Amount of items available for sale. Difference between total quantity and reserved quantity.
+ */
+availableQuantity?: number
+/**
+ * Indicates whether the SKU's availability is unlimited ("unlimited inventory").
+ */
+isUnlimited?: boolean
+/**
+ * List of sales channels ([trade policies](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV) associated.
+ */
+salesChannel?: string[]
+/**
+ * List of delivery channels available.
+ */
+deliveryChannel?: string[]
+/**
+ * @deprecated
+ * Time to refill.
+ */
+timeToRefill?: string
+/**
+ * Date of supply lot in UTC.
+ */
+dateOfSupplyUtc?: string
+/**
+ * Indicates whether SKU can continue to be sold after the available quantity gets to 0.
+ */
+keepSellingAfterExpiration?: boolean
+/**
+ * Transfer.
+ */
+transfer?: string
+}[]
+}
+/**
+ * Updates [inventory](https://help.vtex.com/en/tutorial/inventory-management--tutorials_139) quantity and [lead time](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B) for a given SKU in a warehouse.
+ * 
+ * >ℹ️ If you wish to configure lead time exclusively, use the [Update inventory lead time by SKU and warehouse](https://developers.vtex.com/docs/api-reference/logistics-api#patch-/api/logistics/pvt/inventory/skus/-skuId-/warehouses/-warehouseId-/lead-time) endpoint, and if the quantity only, use the [Update inventory quantity by SKU and warehouse](https://developers.vtex.com/docs/api-reference/logistics-api#patch-/api/logistics/pvt/inventory/skus/-skuId-/warehouses/-warehouseId-/quantity) endpoint. 
+ * 
+ * This endpoint allows you to: 
+ * 
+ * - **Define a quantity:** Indicate a specific number of items of a SKU from a warehouse, and it will decrease whenever an item is sold. When the last item is sold, the SKU will run out of stock. 
+ * 
+ * - **Set an unlimited inventory:** Always have items of a SKU from a warehouse considered available for sale. When this configuration is active, the SKU never goes out of stock. 
+ * 
+ * - **Configure lead time:** Set the [lead time](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B) for a given SKU from a warehouse, and this period will be added to the order total shipping time. This configuration is optional and by default it is set to `0` days. 
+ * 
+ * Successful requests receive a `200 OK` status code with `true` in the response body, and unsuccessful requests receive a `400 Bad Request` error code. 
+ * 
+ * >❗ Requests made with an incomplete response body can be successful and receive a `200 OK` message. However, sending the request body without the `leadTime` field sets the SKU [lead time](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B) to `0`. The same is valid for the `quantity` field, which, if not sent, makes the SKU count equal to `0`. 
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics inventory full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics inventory full access |
+ * | OMS - Full access | Logistics inventory full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication.
+ */
+"PUT /api/logistics/pvt/inventory/skus/:skuId/warehouses/:warehouseId": {
+body: {
+/**
+ * Quantity of SKU units you wish to update the [inventory](https://help.vtex.com/tutorial/inventory-management--tutorials_139) in the given [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb). Note that:
+ * 
+ * - Sending it as `null` sets the quantity to `0`.
+ * 
+ * - Not sending it sets the quantity to `0`.
+ * 
+ * - Sending `unlimitedQuantity` as `true` overrules the `quantity`.
+ */
+quantity: number
+/**
+ * When set as `true`, you make the SKU from the given warehouse permanently available for sales. No matter how many units are sold, the default quantity of `1000000` units does not decrease, and the store never runs out of stock. When set as `false`, every sold unit will decrease your inventory quantity. Note that:
+ * 
+ * - Sending this field as `null` sets the value to `false`.
+ * 
+ * - Not sending this field sets the value to `false`.
+ * 
+ * - Sending this field as `true` overrules the `quantity` field.
+ */
+unlimitedQuantity: boolean
+/**
+ * Defines the date and time of the warehouse when the SKU was updated. This can be useful for liberating handling order [reservations](https://help.vtex.com/en/tutorial/how-the-reservation-works--tutorials_92), for example. The format is [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`. 
+ * When the value is `null` or empty, the default will be the date and time of the request being made.
+ */
+dateUtcOnBalanceSystem?: string
+/**
+ * Defines the [lead time](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B), which is an optional time configuration you can make for a SKU in a warehouse. It can be handling time, fabrication or how long it takes for the item to be available to be shipped to customers.
+ * 
+ * The lead time is a part of the total shipping time and will be considered for shipping date calculation.
+ * 
+ * The format is `dd.hh:mm:ss` (days.hours:minutes:seconds). Note that:
+ * 
+ * - Sending this field as `null` sets the value to `0`.
+ * 
+ * - Not sending this field sets the value to `0`.
+ */
+leadTime: string
+}
+}
+/**
+ * Updates [inventory](https://help.vtex.com/en/tutorial/inventory-management--tutorials_139) with a SKU count and availability for a given [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb). You can do it in two ways: 
+ * 
+ * - **Define a quantity:** Indicate a specific number of items of a SKU from a warehouse, and it will decrease whenever an item is sold. When the last item is sold, the SKU will run out of stock. 
+ * 
+ * - **Set an unlimited inventory:** Always have items of a SKU from a warehouse considered available for sales. When this configuration is active, the SKU never runs out of stock. 
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics inventory full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics inventory full access |
+ * | OMS - Full access | Logistics inventory full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication.
+ */
+"PATCH /api/logistics/pvt/inventory/skus/:skuId/warehouses/:warehouseId/quantity": {
+body: {
+/**
+ * Number of items you wish to update in your [inventory](https://help.vtex.com/en/tutorial/inventory-management--tutorials_139) for a SKU from a given warehouse. 
+ * 
+ * Note that sending the field `unlimitedQuantity` as `true` overrules the `quantity`.
+ */
+quantity: number
+/**
+ * When set as `false`, every sold unit decreases the item's available quantity. When set as `true`, the SKU from the warehouse is always available for sale. No matter how many units are sold, the SKU available quantity never decreases, and the SKU is never out of stock. 
+ * 
+ * Note that sending this field as `true` overrules the `quantity`.
+ */
+unlimitedQuantity: boolean
+/**
+ * Defines the date and time of the warehouse when the SKU was updated. This can be useful for liberating handling order [reservations](https://help.vtex.com/en/tutorial/how-the-reservation-works--tutorials_92), for example. 
+ * 
+ * The format is [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`. When the value is `null` or empty, the default will be the date and time of the when the request being made.
+ */
+dateUtcOnBalanceSystem?: string
+}
+}
+/**
+ * Configures the [lead time](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B) for a SKU of a warehouse, and the period is added to the order's total shipping time.
+ * 
+ * Among other [main use cases](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B#main-use-cases), lead time can represent an item's manufacturing time or scenarios where there are third-party suppliers, for example.
+ * 
+ * Lead time is an optional configuration and by default is set to `0` days.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics inventory full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics inventory full access |
+ * | OMS - Full access | Logistics inventory full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"PATCH /api/logistics/pvt/inventory/skus/:skuId/warehouses/:warehouseId/lead-time": {
+body: {
+/**
+ * Defines the [lead time](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B), a configuration for shipping time at SKU level. You can set a shipping period for a warehouse SKU, and this time will be added to the order's total shipping time. Note that: 
+ * 
+ * - The format is `DD.HH:MM:SS`, or `DD`. The endpoint allows configuring hours and minutes, but the UI only shows days. 
+ * 
+ * - If you mistake hours for days, the system will accept the value as days. For example, sending `78:00:00` updates the lead time to 78 days. 
+ * 
+ * - Sending an empty field or a value in an incorrect format will result in a `400 Bad Request`.
+ */
+leadTime: string
+}
+}
+/**
+ * Lists inventory information, searching by [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics viewer** |
+ * | Logistics | Logistics access | **Logistics inventory full access** |
+ * | Logistics | Logistics access | **Logistics inventory read only** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics viewer |
+ * | Logistics - Read only | Logistics viewer |
+ * | Logistics - Full access | Logistics inventory full access |
+ * | OMS - Full access | Logistics inventory full access |
+ * | Logistics - Full access | Logistics inventory read only |
+ * | Logistics - Read only | Logistics inventory read only |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"GET /api/logistics/pvt/inventory/items/:skuId/docks/:dockId": {
+response: {
+/**
+ * SKU ID.
+ */
+skuId?: string
+/**
+ * Warehouse ID.
+ */
+warehouseId?: string
+/**
+ * Dock ID.
+ */
+dockId?: string
+/**
+ * Total quantity of SKU.
+ */
+totalQuantity?: number
+/**
+ * Reserved quantity of the SKU.
+ */
+reservedQuantity?: number
+/**
+ * Amount of items available for sales. Difference between total quantity and reserved quantity.
+ */
+availableQuantity?: number
+/**
+ * Indicates whether the SKU's availability is unlimited ("unlimited inventory").
+ */
+isUnlimited?: boolean
+/**
+ * List of sales channels ([trade policies](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV) associated.
+ */
+salesChannel?: string[]
+/**
+ * List of delivery channels available.
+ */
+deliveryChannel?: string[]
+/**
+ * @deprecated
+ * Time to refill.
+ */
+timeToRefill?: string
+/**
+ * Date of supply lot in UTC.
+ */
+dateOfSupplyUtc?: string
+/**
+ * Indicates whether SKU can continue to be sold after the available quantity gets to 0.
+ */
+keepSellingAfterExpiration?: boolean
+/**
+ * Transfer supply lot.
+ */
+transfer?: string
+}[]
+}
+/**
+ * Lists inventory information from the combination of a given [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) and a [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics viewer** |
+ * | Logistics | Logistics access | **Logistics inventory full access** |
+ * | Logistics | Logistics access | **Logistics inventory read only** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics viewer |
+ * | Logistics - Read only | Logistics viewer |
+ * | Logistics - Full access | Logistics inventory full access |
+ * | OMS - Full access | Logistics inventory full access |
+ * | Logistics - Full access | Logistics inventory read only |
+ * | Logistics - Read only | Logistics inventory read only |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"GET /api/logistics/pvt/inventory/items/:skuId/docks/:dockId/warehouses/:warehouseId": {
+response: {
+/**
+ * SKU ID.
+ */
+skuId?: string
+/**
+ * [Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.
+ */
+warehouseId?: string
+/**
+ * [Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.
+ */
+dockId?: string
+/**
+ * Total quantity of SKU.
+ */
+totalQuantity?: number
+/**
+ * Reserved quantity of the SKU.
+ */
+reservedQuantity?: number
+/**
+ * Amount of items available for sales. Difference between total quantity and reserved quantity.
+ */
+availableQuantity?: number
+/**
+ * Indicates if the unlimited inventory is activated so the SKU's availability is unlimited (`true`) or not (`false`).
+ */
+isUnlimited?: boolean
+/**
+ * List of sales channels ([trade policies](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV) associated.
+ */
+salesChannel?: string[]
+/**
+ * List of delivery channels available.
+ */
+deliveryChannel?: string[]
+/**
+ * Time to refill (deprecated).
+ */
+timeToRefill?: string
+/**
+ * Date of supply lot in UTC.
+ */
+dateOfSupplyUtc?: string
+/**
+ * Indicates whether SKU can continue to be sold after the available quantity gets to 0.
+ */
+keepSellingAfterExpiration?: boolean
+/**
+ * Transfer.
+ */
+transfer?: string
+}[]
+}
+/**
+ * [Reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) is the VTEX solution that prevents stores from selling the same item more than once. Adding products to the shopping cart does not create a reservation, this only happens after the shopper completes the purchase.
+ * 
+ * This endpoint lists your [inventory](https://help.vtex.com/en/tutorial/inventory-management--tutorials_139) information about dispatched reservations from a given warehouse. A reservation is considered dispatched after the order has passed the `authorize-fulfillment` status in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196) and is not canceled.
+ * 
+ * **Response 400 Bad Request:** When the store has more than 2.000 active reservations, you receive a `400 Bad Request` error with the message: _Too many active reservations_.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics viewer** |
+ * | Logistics | Logistics access | **Logistics inventory full access** |
+ * | Logistics | Logistics access | **Logistics inventory read only** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics viewer |
+ * | Logistics - Read only | Logistics viewer |
+ * | Logistics - Full access | Logistics inventory full access |
+ * | OMS - Full access | Logistics inventory full access |
+ * | Logistics - Full access | Logistics inventory read only |
+ * | Logistics - Read only | Logistics inventory read only |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"GET /api/logistics/pvt/inventory/items/:itemId/warehouses/:warehouseId/dispatched": {
+response: {
+/**
+ * SKU ID.
+ */
+skuId?: string
+/**
+ * Warehouse ID.
+ */
+warehouseId?: string
+/**
+ * SKU quantity.
+ */
+quantity?: number
+/**
+ * Indicates whether the SKU's availability is unlimited ("unlimited inventory").
+ */
+isUnlimitedQuantity?: boolean
+/**
+ * Total reserved quantity of the SKU.
+ */
+totalReservedQuantity?: number
+/**
+ * Dispatched reservations quantity.
+ */
+dispatchedReservationsQuantity?: number
+/**
+ * Available quantity.
+ */
+availableQuantity?: number
+}[]
+}
+/**
+ * Lists supply lots of a SKU in a given [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics viewer** |
+ * | Logistics | Logistics access | **Logistics inventory full access** |
+ * | Logistics | Logistics access | **Logistics inventory read only** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics viewer |
+ * | Logistics - Read only | Logistics viewer |
+ * | Logistics - Full access | Logistics inventory full access |
+ * | OMS - Full access | Logistics inventory full access |
+ * | Logistics - Full access | Logistics inventory read only |
+ * | Logistics - Read only | Logistics inventory read only |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"GET /api/logistics/pvt/inventory/items/:skuId/warehouses/:warehouseId/supplyLots": {
+response: {
+/**
+ * SKU ID related to the supply lot.
+ */
+skuId?: string
+/**
+ * [Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID where the SKU supply lot will arrive.
+ */
+warehouseId?: string
+/**
+ * [Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.
+ */
+dockId?: string
+/**
+ * Total quantity scheduled for the SKU in the supply lot.
+ */
+totalQuantity?: number
+/**
+ * Total [reserved quantity](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) scheduled for the SKU in the supply lot.
+ */
+reservedQuantity?: number
+/**
+ * Available quantity scheduled for the SKU in the supply lot.
+ */
+availableQuantity?: number
+/**
+ * Indicates if the unlimited inventory is activated so the SKU availability for sales is unlimited (`true`), or not (`false`).
+ */
+isUnlimited?: boolean
+/**
+ * List of sales channels ([trade policies](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV) associated with the supply lot.
+ */
+salesChannel?: string[]
+/**
+ * List of delivery channels type associated with the supply lot.
+ */
+deliveryChannels?: ("delivery" | "pickup")[]
+/**
+ * Time to refill in the format `HH:MM:SS`.
+ */
+timeToRefill?: (null | string)
+/**
+ * Date and time scheduled for the SKU from the warehouse to have quantity and availability for sales again. The format is [ISO 8601 time zone offset](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.
+ */
+dateOfSupplyUtc?: string
+/**
+ * Supply lot ID.
+ */
+supplyLotId?: string
+/**
+ * Defines if the SKU from the warehouse should be available for sales after running _out-of-stock_ (`true`), or not (`false`).
+ */
+keepSellingAfterExpiration?: boolean
+/**
+ * Transfer system.
+ */
+transfer?: (null | string)
+/**
+ * [Lead time](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B) is an optional time configuration for a SKU in a warehouse. It can be handling time, fabrication or how long it takes for the item to be available to be shipped to customers. The lead time is a part of the total shipping time and is considered for shipping date calculation. The format is `DD.HH:MM:SS`.
+ */
+leadTime?: (null | string)
+}[]
+}
+/**
+ * Creates a new supply lot, which allows you to sell a SKU that is currently _out-of-stock_ in your [inventory](https://help.vtex.com/en/tutorial/inventory-management--tutorials_139) and unavailable for sales. Creating a supply lot is useful when you know the date of when the SKU will have quantity and availability for sales again.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics inventory full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics inventory full access |
+ * | OMS - Full access | Logistics inventory full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"PUT /api/logistics/pvt/inventory/items/:skuId/warehouses/:warehouseId/supplyLots/:supplyLotId": {
+body: {
+/**
+ * Supply lot quantity for a SKU from a [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).
+ */
+quantity: number
+/**
+ * Date and time of when the SKU from the warehouse will have quantity and availability for sales again. The format is [ISO 8601 time zone offset](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`. Since it is a prevision, this field must be a future date.
+ */
+dateOfSupplyUtc: string
+/**
+ * Defines if the SKU from the warehouse should be available for sales after running _out-of-stock_ (`true`), or not (`false`).
+ */
+keepSellingAfterExpiration?: boolean
+}
+}
+/**
+ * Transfers a SKU from a supply lot to the currently available inventory.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics inventory full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics inventory full access |
+ * | OMS - Full access | Logistics inventory full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"POST /api/logistics/pvt/inventory/items/:skuId/warehouses/:warehouseId/supplyLots/:supplyLotId/transfer": {
+
+}
+/**
+ * Lists information about a [holiday](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk), searching by holiday ID.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics shipping full access** |
+ * | Logistics | Logistics access | **Logistics viewer** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics shipping full access |
+ * | OMS - Full access | Logistics shipping full access |
+ * | Logistics - Full access | Logistics viewer |
+ * | Logistics - Read only | Logistics viewer |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"GET /api/logistics/pvt/configuration/holidays/:holidayId": {
+
+}
+/**
+ * Creates or updates a [holiday](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk), searching by holiday ID.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics shipping full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics shipping full access |
+ * | OMS - Full access | Logistics shipping full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"PUT /api/logistics/pvt/configuration/holidays/:holidayId": {
+/**
+ * Holiday information.
+ */
+body: {
+/**
+ * [Holiday](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) ID.
+ */
+name: string
+/**
+ * Holiday starting date, in the format `YYYY-MM-DD`.
+ */
+startDate: string
+}
+}
+/**
+ * Deletes a [holiday](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) set up in your store, searching by holiday ID.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics shipping full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics shipping full access |
+ * | OMS - Full access | Logistics shipping full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"DELETE /api/logistics/pvt/configuration/holidays/:holidayId": {
+
+}
+/**
+ * Lists information about all [holidays](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) configured on your store.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics shipping full access** |
+ * | Logistics | Logistics access | **Logistics viewer** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics shipping full access |
+ * | OMS - Full access | Logistics shipping full access |
+ * | Logistics - Full access | Logistics viewer |
+ * | Logistics - Read only | Logistics viewer |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"GET /api/logistics/pvt/configuration/holidays": {
+
+}
+/**
+ * Creates a [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92).
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"POST /api/logistics/pvt/inventory/reservations": {
+/**
+ * Reservation sales channel information.
+ */
+body: {
+/**
+ * Sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) valid for the reservation.
+ */
+salesChannel: string
+/**
+ * [Reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) ID.
+ */
+lockId: (null | string)
+/**
+ * Duration before expiring the reservation, in the format `DD.HH:MM:SS`.
+ */
+autorizationExpirationTTL: string
+/**
+ * Array with information about reserved items.
+ */
+deliveryItemOptions: {
+/**
+ * Reserved item object.
+ */
+item: {
+/**
+ * SKU ID.
+ */
+id: string
+/**
+ * Quantity of items.
+ */
+quantity: number
+/**
+ * [Kit](https://help.vtex.com/en/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) items information, when applicable.
+ */
+kitItem: (null | string)[]
+/**
+ * Item price.
+ */
+price: number
+/**
+ * Type of [modal](https://help.vtex.com/en/tutorial/how-the-modal-works--tutorials_125), a special freight.
+ */
+modal?: (null | ("CHEMICALS" | "ELECTRONICS" | "FURNITURE" | "GLASS" | "LIQUID" | "MATTRESSES" | "REFRIGERATED" | "TIRES" | "WHITE_GOODS" | "FIREARMS"))
+/**
+ * Additional handling time in the format `DD.HH:MM:SS`.
+ */
+additionalHandlingTime: string
+/**
+ * Item dimensions.
+ */
+dimension: {
+/**
+ * Item weight.
+ */
+weight: number
+/**
+ * Item height.
+ */
+height: number
+/**
+ * Item width.
+ */
+width: number
+/**
+ * Item length.
+ */
+length: number
+}
+}
+/**
+ * SLA (Service Level Agreement) type.
+ */
+slaType: string
+/**
+ * SLA name.
+ */
+slaTypeName: string
+/**
+ * List price.
+ */
+listPrice: number
+/**
+ * Promotion price.
+ */
+promotionalPrice: number
+/**
+ * Transit time in the format `DD.HH:MM:SS`.
+ */
+transitTime: string
+/**
+ * [Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) processing time in the format `D.HH:MM:SS`. When it was not configured, it returns `00:00:00`.
+ */
+dockTime: string
+/**
+ * Time spent in loading dock plus `dockTime` in the format `D.HH:MM:SS`.
+ */
+timeToDockPlusDockTime: string
+/**
+ * Additional time blocked in the format `DD.HH:MM:SS`.
+ */
+aditionalTimeBlockedDays: string
+/**
+ * SLA total time in the format `DD.HH:MM:SS`.
+ */
+totalTime: string
+/**
+ * [Delivery windows](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz).
+ */
+deliveryWindows: (null | {
+/**
+ * Delivery window starting date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.
+ */
+startDateUtc?: string
+/**
+ * Delivery window ending date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.
+ */
+endDateUtc?: string
+/**
+ * List price.
+ */
+listPrice?: string
+}[])
+/**
+ * [Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.
+ */
+wareHouseId: (null | string)
+/**
+ * Loading dock ID.
+ */
+dockId: string
+/**
+ * Shipping location details.
+ */
+location: {
+/**
+ * Shipping address postal code.
+ */
+zipCode: string
+/**
+ * Three-digit country code of the shipping address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.
+ */
+country: string
+/**
+ * Information related to [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc).
+ */
+inStore: {
+/**
+ * This field is set as `true` when the order was placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) and `false` when it was not.
+ */
+IsCheckedIn: boolean
+/**
+ * ID of purchases made in the GoCommerce context.
+ */
+StoreId: (null | string)
+}
+}
+}[]
+}
+response: {
+/**
+ * Last update date and time in the format [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.
+ */
+LastUpdateDateUtc?: string
+/**
+ * Sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) valid for the reservation.
+ */
+SalesChannel?: string
+/**
+ * Reservation ID.
+ */
+LockId?: string
+/**
+ * Reservation date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.
+ */
+ReservationDateUtc?: string
+/**
+ * Maximum confirmation date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.
+ */
+MaximumConfirmationDateUtc?: string
+/**
+ * Reservation status, meaning:
+ * 
+ * - `0`: `NotCommitted`
+ * 
+ * - `1`: `Authorized`
+ * 
+ * - `2`: `Confirmed`
+ * 
+ * - `3`: `Canceled_AbortedCommitted`
+ * 
+ * - `4`: `Canceled_AuthorizationExpired`
+ * 
+ * - `5`: `Canceled_Manually`
+ */
+Status?: number
+/**
+ * SLA (Service Level Agreement) request information.
+ */
+SlaRequest?: {
+/**
+ * Information about the reserved item.
+ */
+item?: {
+/**
+ * SKU ID.
+ */
+id?: string
+/**
+ * Group item ID.
+ */
+groupItemId?: (null | string)
+/**
+ * Item quantity.
+ */
+quantity?: number
+/**
+ * Item price.
+ */
+price?: number
+/**
+ * Type of [modal](https://help.vtex.com/en/tutorial/how-the-modal-works--tutorials_125), a special freight.
+ */
+modal?: (null | ("CHEMICALS" | "ELECTRONICS" | "FURNITURE" | "GLASS" | "LIQUID" | "MATTRESSES" | "REFRIGERATED" | "TIRES" | "WHITE_GOODS" | "FIREARMS"))
+/**
+ * Additional handling time in the format `DD.HH:MM:SS`.
+ */
+additionalHandlingTime?: string
+/**
+ * Item dimensions.
+ */
+dimension?: {
+/**
+ * Item weight.
+ */
+weight?: number
+/**
+ * Item height.
+ */
+height?: number
+/**
+ * Item width.
+ */
+width?: number
+/**
+ * Item length.
+ */
+length?: number
+/**
+ * Maximum sum of dimensions.
+ */
+maxSumDimension?: number
+}
+/**
+ * [Kit](https://help.vtex.com/en/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) item information.
+ */
+kitItem?: (null | string[])
+/**
+ * When set as `false`, every sold unit decreases the item's available quantity. When set as `true`, the SKU from the warehouse is always available for sale. No matter how many units are sold, the SKU available quantity never decreases, and the SKU is never out of stock.
+ */
+unlimitedQuantity?: boolean
+}
+/**
+ * SLA (Service Level Agreement) type.
+ */
+slaType?: string
+/**
+ * SLA name.
+ */
+slaTypeName?: string
+/**
+ * [Shipping rate template](https://help.vtex.com/en/tutorial/shipping-rate-template--tutorials_127) name.
+ */
+freightTableName?: string
+/**
+ * Shipping rate template ID.
+ */
+freightTableId?: string
+/**
+ * List price.
+ */
+listPrice?: number
+/**
+ * Promotion price.
+ */
+promotionalPrice?: number
+/**
+ * Transit time in the format `DD.HH:MM:SS`.
+ */
+transitTime?: string
+/**
+ * [Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) processing time in the format `D.HH:MM:SS`. When it was not configured, it returns `00:00:00`.
+ */
+dockTime?: string
+/**
+ * Time spent in loading dock plus `dockTime` in the format `D.HH:MM:SS`.
+ */
+timeToDockPlusDockTime?: string
+/**
+ * SLA total time in the format `DD.HH:MM:SS`.
+ */
+totalTime?: string
+/**
+ * [Delivery windows](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz).
+ */
+deliveryWindows?: (null | {
+
+})
+/**
+ * [Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.
+ */
+wareHouseId?: string
+/**
+ * [Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.
+ */
+dockId?: string
+/**
+ * Warehouse Management System (WMS) fulfillment endpoint.
+ */
+wmsEndPoint?: (null | string)
+/**
+ * Shipping location information.
+ */
+location?: {
+/**
+ * Shipping address postal code.
+ */
+zipCode?: string
+/**
+ * Three-digit country code of the shipping address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.
+ */
+country?: string
+/**
+ * Delivery point ID.
+ */
+deliveryPointId?: (null | string)
+/**
+ * Location delivery point coordinates.
+ */
+point?: (null | number[])
+/**
+ * Information related to [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc).
+ */
+inStore?: {
+/**
+ * This field is set as `true` when the order was placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) and `false` when it was not.
+ */
+IsCheckedIn?: boolean
+/**
+ * ID of purchases made in the GoCommerce context.
+ */
+StoreId?: (null | string)
+}
+}
+/**
+ * Detailed information about a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).
+ */
+pickupStoreInfo?: (null | string)
+}[]
+/**
+ * (Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) item options.
+ */
+PickupPointItemOptions?: (null | string)
+/**
+ * Reservation canceled date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.
+ */
+CanceledDateUtc?: string
+/**
+ * Authorized date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.
+ */
+AuthorizedDateUtc?: string
+/**
+ * Confirmed date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.
+ */
+ConfirmedDateUtc?: string
+/**
+ * Errors details, if there are any.
+ */
+Errors?: (null | (null | string)[])
+/**
+ * Defines if the reservation was successful (`true`) or not (`false`).
+ */
+IsSucess?: boolean
+}
+}
+/**
+ * Lists information about a [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92), searching by reservation ID.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics viewer** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics viewer |
+ * | Logistics - Read only | Logistics viewer |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"GET /api/logistics/pvt/inventory/reservations/:reservationId": {
+response: {
+/**
+ * Last update date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.
+ */
+LastUpdateDateUtc?: string
+/**
+ * Sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) valid for the reservation.
+ */
+SalesChannel?: string
+/**
+ * Reservation ID.
+ */
+LockId?: string
+/**
+ * Reservation date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.
+ */
+ReservationDateUtc?: string
+/**
+ * Maximum confirmation date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.
+ */
+MaximumConfirmationDateUtc?: string
+/**
+ * Reservation status, meaning:
+ * 
+ * - `0`: `NotCommitted`
+ * 
+ * - `1`: `Authorized`
+ * 
+ * - `2`: `Confirmed`
+ * 
+ * - `3`: `Canceled_AbortedCommitted`
+ * 
+ * - `4`: `Canceled_AuthorizationExpired`
+ * 
+ * - `5`: `Canceled_Manually`
+ */
+Status?: number
+/**
+ * SLA (Service Level Agreement) request information.
+ */
+SlaRequest?: {
+/**
+ * Information about the reserved item.
+ */
+item?: {
+/**
+ * SKU ID.
+ */
+id?: string
+/**
+ * Group item ID.
+ */
+groupItemId?: (null | string)
+/**
+ * Item quantity.
+ */
+quantity?: number
+/**
+ * Item price.
+ */
+price?: number
+/**
+ * Type of [modal](https://help.vtex.com/en/tutorial/how-the-modal-works--tutorials_125), a special freight.
+ */
+modal?: (null | ("CHEMICALS" | "ELECTRONICS" | "FURNITURE" | "GLASS" | "LIQUID" | "MATTRESSES" | "REFRIGERATED" | "TIRES" | "WHITE_GOODS" | "FIREARMS"))
+/**
+ * Additional handling time in the format `DD.HH:MM:SS`.
+ */
+additionalHandlingTime?: string
+/**
+ * Item dimensions.
+ */
+dimension?: {
+/**
+ * Item weight.
+ */
+weight?: number
+/**
+ * Item height.
+ */
+height?: number
+/**
+ * Item width.
+ */
+width?: number
+/**
+ * Item length.
+ */
+length?: number
+/**
+ * Maximum sum of dimensions.
+ */
+maxSumDimension?: number
+}
+/**
+ * [Kit](https://help.vtex.com/en/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) item information.
+ */
+kitItem?: (null | string[])
+/**
+ * When set as `false`, every sold unit decreases the item's available quantity. When set as `true`, the SKU from the warehouse is always available for sale — no matter how many units are sold, the SKU available quantity never decreases, and the SKU is never out of stock.
+ */
+unlimitedQuantity?: boolean
+/**
+ * [Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.
+ */
+dockId?: string
+/**
+ * [Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.
+ */
+wareHouseId?: string
+/**
+ * SLA request provider.
+ */
+provider?: (null | string)
+}
+/**
+ * SLA (Service Level Agreement) type.
+ */
+slaType?: string
+/**
+ * SLA name.
+ */
+slaTypeName?: string
+/**
+ * [Shipping rate template](https://help.vtex.com/en/tutorial/shipping-rate-template--tutorials_127) name.
+ */
+freightTableName?: string
+/**
+ * Shipping rate template ID.
+ */
+freightTableId?: string
+/**
+ * List price.
+ */
+listPrice?: number
+/**
+ * Promotion price.
+ */
+promotionalPrice?: number
+/**
+ * Time to presale in the format `D.HH:MM:SS`.
+ */
+timeToPresale?: string
+/**
+ * Transit time in the format `DD.HH:MM:SS`.
+ */
+transitTime?: string
+/**
+ * [Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) processing time in the format `D.HH:MM:SS`. When it was not configured, it returns `00:00:00`.
+ */
+dockTime?: string
+/**
+ * Time spent in loading dock plus `dockTime` in the format `D.HH:MM:SS`.
+ */
+timeToDockPlusDockTime?: string
+/**
+ * SLA total time in the format `DD.HH:MM:SS`.
+ */
+totalTime?: string
+/**
+ * [Delivery windows](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz).
+ */
+deliveryWindows?: (null | {
+
+})
+/**
+ * [Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.
+ */
+wareHouseId?: string
+/**
+ * Kit reservation.
+ */
+kitReservation?: (null | string)
+/**
+ * [Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.
+ */
+dockId?: string
+/**
+ * Warehouse Management System (WMS) fulfillment endpoint.
+ */
+wmsEndPoint?: (null | string)
+/**
+ * Shipping location information.
+ */
+location?: {
+/**
+ * Shipping address postal code.
+ */
+zipCode?: string
+/**
+ * Three-digit country code of the shipping address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.
+ */
+country?: string
+/**
+ * Location delivery point coordinates.
+ */
+point?: (null | number[])
+/**
+ * Information related to [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc).
+ */
+inStore?: {
+/**
+ * This field is set as `true` when the order was placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) and `false` when it was not.
+ */
+IsCheckedIn?: boolean
+/**
+ * ID of purchases made in the GoCommerce context.
+ */
+StoreId?: (null | string)
+}
+}
+/**
+ * Detailed information about a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).
+ */
+pickupStoreInfo?: (null | string)
+/**
+ * Defines if the delivery on weekends configuration is active (`true`) or not (`false`).
+ */
+deliveryOnWeekends?: (null | boolean)
+/**
+ * Delivery on weekends and holidays information.
+ */
+weekendAndHolidays?: {
+/**
+ * Defines if the delivery on Saturday configuration is active (`true`) or not (`false`).
+ */
+saturday?: boolean
+/**
+ * Defines if the delivery on Sunday configuration is active (`true`) or not (`false`).
+ */
+sunday?: boolean
+/**
+ * Defines if the delivery on [holiday](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) configuration is active (`true`) or not (`false`).
+ */
+holiday?: boolean
+}
+/**
+ * Delivery estimate date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.
+ */
+estimateDate?: string
+/**
+ * Delivery channel.
+ */
+deliveryChannel?: string
+/**
+ * Total shipping time plus carrier schedule, in the format `DD.HH:MM:SS`.
+ */
+totalTimePlusCarrierSchedule?: string
+/**
+ * [Polygon](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) name.
+ */
+polygonName?: string
+/**
+ * SLA distance level.
+ */
+distanceLevel?: (null | string)
+/**
+ * Account carrier.
+ */
+accountCarrier?: string
+/**
+ * Supply date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.
+ */
+dateOfSupplyUtc?: (null | string)
+/**
+ * Supply lot ID.
+ */
+supplyLotId?: (null | string)
+/**
+ * Defines if the SLA request is external (`true`) or not (`false`).
+ */
+isExternal?: boolean
+}[]
+/**
+ * Reservation canceled date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.
+ */
+CanceledDateUtc?: string
+/**
+ * Authorized date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.
+ */
+AuthorizedDateUtc?: string
+/**
+ * Confirmed date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.
+ */
+ConfirmedDateUtc?: string
+/**
+ * Error details, if there are any.
+ */
+Errors?: (null | (null | string)[])
+/**
+ * Defines if the reservation was successful (`true`) or not (`false`).
+ */
+IsSucess?: boolean
+}
+}
+/**
+ * Confirms a [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92), searching by reservation ID.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"POST /api/logistics/pvt/inventory/reservations/:reservationId/confirm": {
+
+}
+/**
+ * Acknowledges a [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92), searching by reservation ID.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"POST /api/logistics/pvt/inventory/reservations/:reservationId/acknowledge": {
+
+}
+/**
+ * Cancels a [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92), searching by reservation ID.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"POST /api/logistics/pvt/inventory/reservations/:reservationId/cancel": {
+
+}
+/**
+ * Lists information about [reservations](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92), searching by a given [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID and SKU ID.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics viewer** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics viewer |
+ * | Logistics - Read only | Logistics viewer |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"GET /api/logistics/pvt/inventory/reservations/:warehouseId/:skuId": {
+
+}
+/**
+ * Checkout uses this endpoint to calculate a Service Level Agreement (SLA), a contract between the store and a customer about their order fulfillment conditions, such as the shipping estimated date.
+ * 
+ * The calculation of the estimated date considers the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) and [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) related to the order.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics viewer** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics viewer |
+ * | Logistics - Read only | Logistics viewer |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"POST /api/logistics/pvt/shipping/calculate": {
+body: {
+/**
+ * Items' shipping conditions to calculate the Service Level Agreement (SLA).
+ */
+items: {
+/**
+ * SKU ID.
+ */
+id: string
+/**
+ * SKU quantity.
+ */
+quantity: number
+/**
+ * Item price.
+ */
+price?: (null | number)
+/**
+ * [Modal](https://help.vtex.com/en/tutorial/how-the-modal-works--tutorials_125) is a special freight.
+ */
+modal?: (null | ("CHEMICALS" | "ELECTRONICS" | "FURNITURE" | "GLASS" | "LIQUID" | "MATTRESSES" | "REFRIGERATED" | "TIRES" | "WHITE_GOODS" | "FIREARMS"))
+/**
+ * Additional handling time in the format `DD.HH:MM:SS`.
+ */
+additionalHandlingTime?: string
+/**
+ * Item dimensions.
+ */
+dimension: {
+/**
+ * Item weight.
+ */
+weight?: number
+/**
+ * Item height.
+ */
+height?: number
+/**
+ * Item width.
+ */
+width?: number
+/**
+ * Item length.
+ */
+length?: number
+/**
+ * Maximum sum of dimensions.
+ */
+maxSumDimension?: number
+}
+/**
+ * [Kit](https://help.vtex.com/en/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) item information.
+ */
+kitItem?: (null | {
+/**
+ * Kit SKU ID.
+ */
+id: string
+/**
+ * Kit group item ID.
+ */
+groupItemId?: (null | string)
+/**
+ * Kit item list.
+ */
+kitItem?: (null | string[])
+/**
+ * Kit SKU quantity.
+ */
+quantity: number
+/**
+ * Kit SKU price.
+ */
+price?: number
+/**
+ * Kit item additional handling time in the format `DD.HH:MM:SS`.
+ */
+additionalHandlingTime?: string
+/**
+ * Kit item dimensions.
+ */
+dimension: {
+/**
+ * Kit item weight.
+ */
+weight?: number
+/**
+ * Kit item height.
+ */
+height?: number
+/**
+ * Kit item width.
+ */
+width?: number
+/**
+ * Kit item length.
+ */
+length?: number
+/**
+ * Maximum sum of dimensions.
+ */
+maxSumDimension?: number
+}
+}[])
+/**
+ * [Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.
+ */
+dockId?: (null | string)
+/**
+ * [Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.
+ */
+wareHouseId?: (null | string)
+}[]
+/**
+ * Shipping location information.
+ */
+location: {
+/**
+ * Shipping adress postal code.
+ */
+zipCode: string
+/**
+ * Three-digit country code of the shipping address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.
+ */
+country: string
+/**
+ * Shipping address coordinates, first longitude then latitude.
+ */
+point?: number[]
+/**
+ * Information related to [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc).
+ */
+inStore?: {
+/**
+ * This field is set as `true` when the order is placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) and `false` when it is not.
+ */
+IsCheckedIn?: boolean
+/**
+ * ID of purchases made in the GoCommerce context.
+ */
+StoreId?: (null | string)
+}
+}
+/**
+ * Sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) valid for the SLA calculation.
+ */
+salesChannel?: string
+/**
+ * Defines if the shipping type is `delivery` or `pickup`.
+ */
+deliveryChannel?: (null | string)
+}[]
+response: {
+/**
+ * SKU ID.
+ */
+itemId?: string
+/**
+ * SKU quantity.
+ */
+quantity?: number
+/**
+ * [Kit](https://help.vtex.com/en/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) items' information.
+ */
+kitItem?: {
+/**
+ * Kit SKU ID.
+ */
+id?: string
+/**
+ * Kit SKU quantity.
+ */
+quantity?: number
+/**
+ * [Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID where the kit SKU is stored.
+ */
+warehouseId?: string
+/**
+ * Kit SKU supply lot ID.
+ */
+supplyLotId?: (null | string)
+}[]
+/**
+ * SKU quantity available for sales. [Reserved](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) items do not count.
+ */
+availabilityQuantity?: number
+/**
+ * Sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) valid for the SLA calculation.
+ */
+salesChannel?: string
+/**
+ * Service Level Agreement (SLA) type.
+ */
+slaType?: string
+/**
+ * Service Level Agreement (SLA) name.
+ */
+slaTypeName?: string
+/**
+ * [Shipping rate template](https://help.vtex.com/en/tutorial/shipping-rate-template--tutorials_127) name.
+ */
+freightTableName?: string
+/**
+ * Shipping rate template ID.
+ */
+freightTableId?: string
+/**
+ * SKU list price.
+ */
+listPrice?: number
+/**
+ * Transit time in the format `DD.HH:MM:SS`.
+ */
+transitTime?: string
+/**
+ * [Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) processing time in the format `D.HH:MM:SS`. When it was not configured, it returns `00:00:00`.
+ */
+dockTime?: string
+/**
+ * Time spent in loading dock plus `dockTime` in the format `D.HH:MM:SS`.
+ */
+timeToDockPlusDockTime?: string
+/**
+ * Additional time blocked in the format `DD.HH:MM:SS`.
+ */
+aditionalTimeBlockedDays?: string
+/**
+ * [Lead time](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B) is an optional time configuration for a SKU in a warehouse. It can be handling time, fabrication or how long it takes for the item to be available to be shipped to customers. The lead time is a part of the total shipping time and is considered for shipping date calculation. The format is `DD.HH:MM:SS`.
+ */
+leadTime?: string
+/**
+ * SLA total time in the format `DD.HH:MM:SS`.
+ */
+totalTime?: string
+/**
+ * [Delivery windows](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz) configurations.
+ */
+deliveryWindows?: {
+/**
+ * Delivery window starting date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.
+ */
+startDateUtc?: string
+/**
+ * Delivery window ending date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.
+ */
+endDateUtc?: string
+/**
+ * List price.
+ */
+listPrice?: number
+}[]
+/**
+ * [Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.
+ */
+wareHouseId?: string
+/**
+ * [Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.
+ */
+dockId?: string
+/**
+ * Shipping location information.
+ */
+location?: {
+/**
+ * Shipping adress postal code.
+ */
+zipCode?: string
+/**
+ * Three-digit country code of the shipping address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.
+ */
+country?: string
+/**
+ * Shipping address coordinates, first longitude then latitude.
+ */
+point?: (null | number[])
+/**
+ * Information related to [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc).
+ */
+inStore?: {
+/**
+ * This field is set as `true` when the order is placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) and `false` when it is not.
+ */
+isCheckedIn?: boolean
+/**
+ * ID of purchases made in the GoCommerce context.
+ */
+storeId?: (null | string)
+}
+}
+/**
+ * Defines if the delivery on weekends configuration is active (`true`) or inactive (`false`).
+ */
+deliveryOnWeekends?: boolean
+/**
+ * Delivery on weekends and holidays information.
+ */
+weekendAndHolidays?: (null | {
+/**
+ * Defines if the delivery on Saturday configuration is active (`true`) or inactive (`false`).
+ */
+saturday?: boolean
+/**
+ * Defines if the delivery on Sunday configuration is active (`true`) or inactive (`false`).
+ */
+sunday?: boolean
+/**
+ * Defines if the delivery on [holiday](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) configuration is active (`true`) or inactive (`false`).
+ */
+holiday?: boolean
+})
+/**
+ * Schedule sent by the carrier.
+ */
+carrierSchedule?: {
+/**
+ * Day of the week, from `0` (Sunday) to `6` (Saturday).
+ */
+dayOfWeek?: (0 | 1 | 2 | 3 | 4 | 5 | 6)
+/**
+ * Time limit.
+ */
+timeLimit?: string
+}[]
+/**
+ * Total shipping time plus carrier schedule, in the format `DD.HH:MM:SS`.
+ */
+totalTimePlusCarrierSchedule?: string
+/**
+ * List of postal codes where the delivery is restricted for the carrier.
+ */
+restrictedFreight?: (null | (null | string)[])
+/**
+ * Shipping address geolocation coordinates, first longitude then latitude.
+ */
+coordinates?: (null | (null | number)[])
+/**
+ * @deprecated
+ * Information about a loading dock that was transformed into a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).
+ */
+pickupStoreInfo?: {
+/**
+ * @deprecated
+ * Defines if the shipping type was pickup (`true`) or not (`false`).
+ */
+isPickupStore?: (null | boolean)
+/**
+ * @deprecated
+ * Store ID for stores that acted as pickup points.
+ */
+storeId?: (null | string)
+/**
+ * @deprecated
+ * Name of the pickup point displayed at checkout.
+ */
+friendlyName?: (null | string)
+/**
+ * @deprecated
+ * Pickup point address information.
+ */
+address?: (null | {
+/**
+ * @deprecated
+ * Pickup point address postal code.
+ */
+postalCode?: string
+/**
+ * @deprecated
+ * Information about the pickup point address country.
+ */
+country?: {
+/**
+ * @deprecated
+ * Three-digit country code of the pickup point address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.
+ */
+acronym?: string
+/**
+ * @deprecated
+ * Country name of the pickup point address.
+ */
+name?: string
+}
+/**
+ * @deprecated
+ * Pickup point address city.
+ */
+city?: string
+/**
+ * @deprecated
+ * Pickup point address state.
+ */
+state?: string
+/**
+ * @deprecated
+ * Pickup point address neighborhood.
+ */
+neighborhood?: string
+/**
+ * @deprecated
+ * Pickup point address street.
+ */
+street?: string
+/**
+ * @deprecated
+ * Pickup point address number.
+ */
+number?: string
+/**
+ * @deprecated
+ * Pickup point address complement.
+ */
+complement?: (null | string)
+/**
+ * @deprecated
+ * Pickup point address reference point.
+ */
+reference?: (null | string)
+/**
+ * @deprecated
+ * Pickup point address geolocation coordinates.
+ */
+location?: {
+/**
+ * @deprecated
+ * Latitude coordinate.
+ */
+latitude?: number
+/**
+ * @deprecated
+ * Longitude coordinate.
+ */
+longitude?: number
+}
+})
+/**
+ * @deprecated
+ * Additional information about the delivery or the pickup point.
+ */
+additionalInfo?: (null | string)
+/**
+ * @deprecated
+ * ID of the [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj related to the delivery or the pickup point ID.
+ */
+dockId?: (null | string)
+/**
+ * @deprecated
+ * Distance in kilometers between the pickup point and the customer's address, measured as a straight line.
+ */
+distance?: (null | number)
+/**
+ * @deprecated
+ * Pickup point business hours configurations.
+ */
+businessHours?: (null | string)
+/**
+ * @deprecated
+ * Holiday's configurations applicable to the pickup point.
+ */
+pickupHolidays?: (null | string)
+/**
+ * @deprecated
+ * Seller ID.
+ */
+sellerId?: (null | string)
+/**
+ * @deprecated
+ * Defines if the pickup was third party (`true`) or not (`false`).
+ */
+isThirdPartyPickup?: boolean
+}
+/**
+ * Time to presale in the format `DD.HH:MM:SS`.
+ */
+timeToPresale?: string
+/**
+ * Defines if the shipping type is `delivery` or `pickup`.
+ */
+deliveryChannel?: string
+/**
+ * Availability and quantity by the given delivery channel.
+ */
+availabilityQuantityByDeliveryChannel?: number
+/**
+ * [Polygon](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) ID (same as the polygon name).
+ */
+polygonName?: string
+/**
+ * SLA distance level.
+ */
+distanceLevel?: string
+/**
+ * Account carrier.
+ */
+accountCarrier?: string
+/**
+ * Carrier business hours configurations for the week.
+ */
+carrierBusinessHours?: {
+/**
+ * Carrier opening time in `HH:MM:SS` format.
+ */
+openingTime?: string
+/**
+ * Carrier closing time in `HH:MM:SS` format.
+ */
+closingTime?: string
+/**
+ * Day of the week, from `0` (Sunday) to `6` (Saturday).
+ */
+dayOfWeek?: (0 | 1 | 2 | 3 | 4 | 5 | 6)
+}[]
+/**
+ * Provider system.
+ */
+provider?: (null | string)
+/**
+ * Supply date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.
+ */
+dateOfSupplyUtc?: (null | string)
+/**
+ * Delivery estimate date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.
+ */
+estimateDate?: string
+/**
+ * Supply lot ID.
+ */
+supplyLotId?: (null | string)
+/**
+ * Defines if the SLA request is external (`true`) or not (`false`).
+ */
+isExternal?: boolean
+}[][]
+}
+/**
+ * Retrieves information about your store [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).
+ * 
+ * >⚠️ The response is limited to 1.000 pickup points. If you need more results, you can use the [List paged pickup points](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/configuration/pickuppoints/_search) endpoint.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics viewer** |
+ * | Logistics | Logistics access | **Logistics shipping full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics viewer |
+ * | Logistics - Read only | Logistics viewer |
+ * | Logistics - Full access | Logistics shipping full access |
+ * | OMS - Full access | Logistics shipping full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"GET /api/logistics/pvt/configuration/pickuppoints": {
+/**
+ * List of pickup points, limited to 1.000 pickup points. If you need more than 1000 results, you can use the [List paged pickup points](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/configuration/pickuppoints/_search) endpoint.
+ */
+response: {
+/**
+ * [Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID.
+ */
+id?: string
+/**
+ * Pickup point name displayed to customers at checkout.
+ */
+name?: string
+/**
+ * Pickup point description displayed to customers at checkout.
+ */
+description?: string
+/**
+ * Instructions for customers when collecting their package.
+ */
+instructions?: string
+/**
+ * Formatted address.
+ */
+formatted_address?: (null | string)
+/**
+ * Pickup point address information.
+ */
+address?: {
+/**
+ * Pickup point address postal code.
+ */
+postalCode?: string
+/**
+ * Information about the pickup point address country.
+ */
+country?: {
+/**
+ * Three-digit country code of the pickup point address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.
+ */
+acronym?: string
+/**
+ * Country name of the pickup point address.
+ */
+name?: string
+}
+/**
+ * Pickup point address city.
+ */
+city?: string
+/**
+ * Pickup point address state.
+ */
+state?: string
+/**
+ * Pickup point address neighborhood.
+ */
+neighborhood?: string
+/**
+ * Pickup point address street.
+ */
+street?: string
+/**
+ * Pickup point address number.
+ */
+number?: string
+/**
+ * Pickup point address complement.
+ */
+complement?: string
+/**
+ * Reference point to help the customer find the pickup point.
+ */
+reference?: string
+/**
+ * Pickup point address geolocation coordinates.
+ */
+location?: {
+/**
+ * Latitude coordinate.
+ */
+latitude?: number
+/**
+ * Longitude coordinate.
+ */
+longitude?: number
+}
+}
+/**
+ * Defines if the pickup point is active (`true`) or inactive (`false`).
+ */
+isActive?: boolean
+/**
+ * Pickup point configured distance.
+ */
+distance?: number
+/**
+ * Seller that corresponds to the pickup point.
+ */
+seller?: string
+/**
+ * Sort array.
+ */
+_sort?: number[]
+/**
+ * Pickup point business hours configurations.
+ */
+businessHours?: {
+/**
+ * Day of the week identification, as in `1` = Monday, `2` = Tuesday, `3` = Wednesday, `4` = Thursday, and `5` = Friday.
+ */
+dayOfWeek?: number
+/**
+ * Opening time in `HH:MM:SS` format.
+ */
+openingTime?: string
+/**
+ * Closing time in `HH:MM:SS` format.
+ */
+closingTime?: string
+}[]
+/**
+ * Tags that identify a group of pickup points.
+ */
+tagsLabel?: string[]
+/**
+ * [Holidays](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) configured for the pickup point.
+ */
+pickupHolidays?: {
+/**
+ * Holiday date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.
+ */
+date?: string
+/**
+ * Holiday beginning time in `HH:MM` format.
+ */
+hourBegin?: string
+/**
+ * Holiday ending time in `HH:MM` format.
+ */
+hourEnd?: string
+}[]
+/**
+ * Defines if the pickup point is third-party (`true`) or not (`false`).
+ */
+isThirdPartyPickup?: boolean
+/**
+ * Account owner name.
+ */
+accountOwnerName?: string
+/**
+ * Account owner ID.
+ */
+accountOwnerId?: string
+/**
+ * Parent account name.
+ */
+parentAccountName?: string
+/**
+ * Original ID.
+ */
+originalId?: (null | string)
+}[]
+}
+/**
+ * Retrieves information about a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R), searching by pickup point ID.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics viewer** |
+ * | Logistics | Logistics access | **Logistics shipping full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics viewer |
+ * | Logistics - Read only | Logistics viewer |
+ * | Logistics - Full access | Logistics shipping full access |
+ * | OMS - Full access | Logistics shipping full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"GET /api/logistics/pvt/configuration/pickuppoints/:pickupPointId": {
+/**
+ * Pickup point information.
+ */
+response: {
+/**
+ * [Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID.
+ */
+id?: string
+/**
+ * Pickup point name displayed to customers at checkout.
+ */
+name?: string
+/**
+ * Pickup point description displayed to customers at checkout.
+ */
+description?: string
+/**
+ * Instructions for customers when collecting their package.
+ */
+instructions?: string
+/**
+ * Formatted address.
+ */
+formatted_address?: (null | string)
+/**
+ * Pickup point address information.
+ */
+address?: {
+/**
+ * Pickup point address postal code.
+ */
+postalCode?: string
+/**
+ * Information about the pickup point address country.
+ */
+country?: {
+/**
+ * Three-digit country code of the pickup point address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.
+ */
+acronym?: string
+/**
+ * Country name of the pickup point address.
+ */
+name?: string
+}
+/**
+ * Pickup point address city.
+ */
+city?: string
+/**
+ * Pickup point address state.
+ */
+state?: string
+/**
+ * Pickup point address neighborhood.
+ */
+neighborhood?: string
+/**
+ * Pickup point address street.
+ */
+street?: string
+/**
+ * Pickup point address number.
+ */
+number?: string
+/**
+ * Pickup point address complement.
+ */
+complement?: string
+/**
+ * Reference point to help the customer find the pickup point.
+ */
+reference?: string
+/**
+ * Pickup point address geolocation coordinates.
+ */
+location?: {
+/**
+ * Latitude coordinate.
+ */
+latitude?: number
+/**
+ * Longitude coordinate.
+ */
+longitude?: number
+}
+}
+/**
+ * Defines if the pickup point is active (`true`) or inactive (`false`).
+ */
+isActive?: boolean
+/**
+ * Pickup point configured distance.
+ */
+distance?: number
+/**
+ * Seller that corresponds to the pickup point.
+ */
+seller?: string
+/**
+ * Sort array.
+ */
+_sort?: number[]
+/**
+ * Pickup point business hours configurations.
+ */
+businessHours?: {
+/**
+ * Day of the week identification, as in `1` = Monday, `2` = Tuesday, `3` = Wednesday, `4` = Thursday, and `5` = Friday.
+ */
+dayOfWeek?: number
+/**
+ * Opening time in `HH:MM:SS` format.
+ */
+openingTime?: string
+/**
+ * Closing time in `HH:MM:SS` format.
+ */
+closingTime?: string
+}[]
+/**
+ * Tags that identify a group of pickup points.
+ */
+tagsLabel?: string[]
+/**
+ * [Holidays](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) configured for the pickup point.
+ */
+pickupHolidays?: {
+/**
+ * Holiday date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.
+ */
+date?: string
+/**
+ * Holiday beginning time in `HH:MM` format.
+ */
+hourBegin?: string
+/**
+ * Holiday ending time in `HH:MM` format.
+ */
+hourEnd?: string
+}[]
+/**
+ * Defines if the pickup point is third-party (`true`) or not (`false`).
+ */
+isThirdPartyPickup?: boolean
+/**
+ * Account owner name.
+ */
+accountOwnerName?: string
+/**
+ * Account owner ID.
+ */
+accountOwnerId?: string
+/**
+ * Parent account name.
+ */
+parentAccountName?: string
+/**
+ * Original ID.
+ */
+originalId?: (null | string)
+}
+}
+/**
+ * Creates or updates a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) of your store, searching by pickup point ID.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics shipping full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics shipping full access |
+ * | OMS - Full access | Logistics shipping full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"PUT /api/logistics/pvt/configuration/pickuppoints/:pickupPointId": {
+body: {
+/**
+ * [Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID. Cannot contain spaces.
+ */
+id: string
+/**
+ * Pickup point name displayed to customers at checkout.
+ */
+name: string
+/**
+ * Pickup point description.
+ */
+description: string
+/**
+ * Pickup point instructions.
+ */
+instructions: string
+/**
+ * Formatted address.
+ */
+formatted_address: string
+/**
+ * Pickup point address information.
+ */
+address: {
+/**
+ * Pickup point address postal code.
+ */
+postalCode: string
+/**
+ * Information about the pickup point address country.
+ */
+country: {
+/**
+ * Three-digit country code of the pickup point address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.
+ */
+acronym: string
+/**
+ * Country name of the pickup point address.
+ */
+name: string
+}
+/**
+ * Pickup point address city.
+ */
+city: string
+/**
+ * Pickup point address state.
+ */
+state: string
+/**
+ * Pickup point address neighborhood.
+ */
+neighborhood: string
+/**
+ * Pickup point address street.
+ */
+street: string
+/**
+ * Pickup point address number.
+ */
+number: string
+/**
+ * Pickup point address complement.
+ */
+complement: string
+/**
+ * Reference point to help the customer find the pickup point.
+ */
+reference: string
+/**
+ * Pickup point address geolocation coordinates.
+ */
+location: {
+/**
+ * Latitude coordinate.
+ */
+latitude: number
+/**
+ * Longitude coordinate.
+ */
+longitude: number
+}
+}
+/**
+ * Defines if the pickup point is active (`true`) or inactive (`false`).
+ */
+isActive: boolean
+/**
+ * Pickup point business hours configurations.
+ */
+businessHours: {
+/**
+ * Day of the week identification, as in `1` = Monday, `2` = Tuesday, `3` = Wednesday, `4` = Thursday, and `5` = Friday.
+ */
+dayOfWeek: (1 | 2 | 3 | 4 | 5)
+/**
+ * Opening time in `HH:MM:SS` format.
+ */
+openingTime: string
+/**
+ * Closing time in `HH:MM:SS` format.
+ */
+closingTime: string
+}[]
+/**
+ * Tags that identify a group of pickup points.
+ */
+tagsLabel: string[]
+/**
+ * Defines if the pickup point is third-party (`true`) or not (`false`).
+ */
+isThirdPartyPickup?: boolean
+}
+/**
+ * Pickup point information.
+ */
+response: {
+/**
+ * [Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID.
+ */
+id?: string
+/**
+ * Pickup point name displayed to customers at checkout.
+ */
+name?: string
+/**
+ * Pickup point description displayed to customers at checkout.
+ */
+description?: string
+/**
+ * Instructions for customers when collecting their package.
+ */
+instructions?: string
+/**
+ * Formatted address.
+ */
+formatted_address?: (null | string)
+/**
+ * Pickup point address information.
+ */
+address?: {
+/**
+ * Pickup point address postal code.
+ */
+postalCode?: string
+/**
+ * Information about the pickup point address country.
+ */
+country?: {
+/**
+ * Three-digit country code of the pickup point address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.
+ */
+acronym?: string
+/**
+ * Country name of the pickup point address.
+ */
+name?: string
+}
+/**
+ * Pickup point address city.
+ */
+city?: string
+/**
+ * Pickup point address state.
+ */
+state?: string
+/**
+ * Pickup point address neighborhood.
+ */
+neighborhood?: string
+/**
+ * Pickup point address street.
+ */
+street?: string
+/**
+ * Pickup point address number.
+ */
+number?: string
+/**
+ * Pickup point address complement.
+ */
+complement?: string
+/**
+ * Reference point to help the customer find the pickup point.
+ */
+reference?: string
+/**
+ * Pickup point address geolocation coordinates.
+ */
+location?: {
+/**
+ * Latitude coordinate.
+ */
+latitude?: number
+/**
+ * Longitude coordinate.
+ */
+longitude?: number
+}
+}
+/**
+ * Defines if the pickup point is active (`true`) or inactive (`false`).
+ */
+isActive?: boolean
+/**
+ * Pickup point configured distance.
+ */
+distance?: number
+/**
+ * Seller that corresponds to the pickup point.
+ */
+seller?: string
+/**
+ * Sort array.
+ */
+_sort?: number[]
+/**
+ * Pickup point business hours configurations.
+ */
+businessHours?: {
+/**
+ * Day of the week identification, as in `1` = Monday, `2` = Tuesday, `3` = Wednesday, `4` = Thursday, and `5` = Friday.
+ */
+dayOfWeek?: number
+/**
+ * Opening time in `HH:MM:SS` format.
+ */
+openingTime?: string
+/**
+ * Closing time in `HH:MM:SS` format.
+ */
+closingTime?: string
+}[]
+/**
+ * Tags that identify a group of pickup points.
+ */
+tagsLabel?: string[]
+/**
+ * [Holidays](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) configured for the pickup point.
+ */
+pickupHolidays?: {
+/**
+ * Holiday date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.
+ */
+date?: string
+/**
+ * Holiday beginning time in `HH:MM` format.
+ */
+hourBegin?: string
+/**
+ * Holiday ending time in `HH:MM` format.
+ */
+hourEnd?: string
+}[]
+/**
+ * Defines if the pickup point is third-party (`true`) or not (`false`).
+ */
+isThirdPartyPickup?: boolean
+/**
+ * Account owner name.
+ */
+accountOwnerName?: string
+/**
+ * Account owner ID.
+ */
+accountOwnerId?: string
+/**
+ * Parent account name.
+ */
+parentAccountName?: string
+/**
+ * Original ID.
+ */
+originalId?: (null | string)
+}
+}
+/**
+ * Deletes a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) of your store, searching by pickup point ID.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics shipping full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics shipping full access |
+ * | OMS - Full access | Logistics shipping full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"DELETE /api/logistics/pvt/configuration/pickuppoints/:pickupPointId": {
+
+}
+/**
+ * Lists paged [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) of your store.
+ * 
+ * >⚠️ The response is limited to 100 pages.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics viewer** |
+ * | Logistics | Logistics access | **Logistics shipping full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics viewer |
+ * | Logistics - Read only | Logistics viewer |
+ * | Logistics - Full access | Logistics shipping full access |
+ * | OMS - Full access | Logistics shipping full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"GET /api/logistics/pvt/configuration/pickuppoints/_search": {
+searchParams: {
+/**
+ * Number of the page of the response. When not informed, the default page returned is `1`, but you can use this parameter to retrieve a specific page. The response is limited to 100 pages.
+ */
+page?: number
+/**
+ * Number of [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) per page.
+ */
+pageSize?: number
+/**
+ * Search pickup points by using a keyword.
+ */
+keyword?: string
+}
+/**
+ * Paged pickup points list.
+ */
+response: {
+/**
+ * List of pickup points.
+ */
+items?: {
+/**
+ * [Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID.
+ */
+id?: string
+/**
+ * Pickup point name displayed to customers at checkout.
+ */
+name?: string
+/**
+ * Pickup point description displayed to customers at checkout.
+ */
+description?: string
+/**
+ * Instructions for customers when collecting their package.
+ */
+instructions?: string
+/**
+ * Formatted address.
+ */
+formatted_address?: (null | string)
+/**
+ * Pickup point address information.
+ */
+address?: {
+/**
+ * Pickup point address postal code.
+ */
+postalCode?: string
+/**
+ * Information about the pickup point address country.
+ */
+country?: {
+/**
+ * Three-digit country code of the pickup point address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.
+ */
+acronym?: string
+/**
+ * Country name of the pickup point address.
+ */
+name?: string
+}
+/**
+ * Pickup point address city.
+ */
+city?: string
+/**
+ * Pickup point address state.
+ */
+state?: string
+/**
+ * Pickup point address neighborhood.
+ */
+neighborhood?: string
+/**
+ * Pickup point address street.
+ */
+street?: string
+/**
+ * Pickup point address number.
+ */
+number?: string
+/**
+ * Pickup point address complement.
+ */
+complement?: string
+/**
+ * Reference point to help the customer find the pickup point.
+ */
+reference?: string
+/**
+ * Pickup point address geolocation coordinates.
+ */
+location?: {
+/**
+ * Latitude coordinate.
+ */
+latitude?: number
+/**
+ * Longitude coordinate.
+ */
+longitude?: number
+}
+}
+/**
+ * Defines if the pickup point is active (`true`) or inactive (`false`).
+ */
+isActive?: boolean
+/**
+ * Pickup point configured distance.
+ */
+distance?: number
+/**
+ * Seller that corresponds to the pickup point.
+ */
+seller?: string
+/**
+ * Sort array.
+ */
+_sort?: number[]
+/**
+ * Pickup point business hours configurations.
+ */
+businessHours?: {
+/**
+ * Day of the week identification, as in `1` = Monday, `2` = Tuesday, `3` = Wednesday, `4` = Thursday, and `5` = Friday.
+ */
+dayOfWeek?: number
+/**
+ * Opening time in `HH:MM:SS` format.
+ */
+openingTime?: string
+/**
+ * Closing time in `HH:MM:SS` format.
+ */
+closingTime?: string
+}[]
+/**
+ * Tags that identify a group of pickup points.
+ */
+tagsLabel?: string[]
+/**
+ * [Holidays](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) configured for the pickup point.
+ */
+pickupHolidays?: {
+/**
+ * Holiday date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.
+ */
+date?: string
+/**
+ * Holiday beginning time in `HH:MM` format.
+ */
+hourBegin?: string
+/**
+ * Holiday ending time in `HH:MM` format.
+ */
+hourEnd?: string
+}[]
+/**
+ * Defines if the pickup point is third-party (`true`) or not (`false`).
+ */
+isThirdPartyPickup?: boolean
+/**
+ * Account owner name.
+ */
+accountOwnerName?: string
+/**
+ * Account owner ID.
+ */
+accountOwnerId?: string
+/**
+ * Parent account name.
+ */
+parentAccountName?: string
+/**
+ * Original ID.
+ */
+originalId?: (null | string)
+}[]
+/**
+ * Pagination information.
+ */
+paging?: {
+/**
+ * Number of the current page of the response. By default, it returns page `1`, unless a different value is informed in the `page` query parameter.
+ */
+page?: number
+/**
+ * Number of pickup points per page.
+ */
+perPage?: number
+/**
+ * Total number of existing pickup points.
+ */
+total?: number
+/**
+ * Total number of pages, considering the total number of pickup points. Even though there might be other results, the maximum value of this field will be `100`, because the response is limited to 100 pages.
+ */
+pages?: number
+}
+}
+}
+/**
+ * Lists paged [polygons](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) of your store.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics viewer** |
+ * | Logistics | Logistics access | **Logistics shipping full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics viewer |
+ * | Logistics - Read only | Logistics viewer |
+ * | Logistics - Full access | Logistics shipping full access |
+ * | OMS - Full access | Logistics shipping full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"GET /api/logistics/pvt/configuration/geoshape": {
+searchParams: {
+/**
+ * Number of the page of the response.
+ */
+page?: number
+/**
+ * Number of [polygons](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) per page.
+ */
+perPage?: number
+}
+response: {
+/**
+ * Polygons list.
+ */
+items?: string[]
+/**
+ * Pagination information.
+ */
+paging?: {
+/**
+ * Number of the current page of the response. By default, it returns page `1`.
+ */
+page?: number
+/**
+ * Number of polygons per page.
+ */
+perPage?: number
+/**
+ * Total number of existing polygons.
+ */
+total?: number
+/**
+ * Total number of pages, considering the total number of polygons.
+ */
+pages?: number
+}
+}
+}
+/**
+ * Creates or updates a [polygon](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) of your store, using geolocation coordinates.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics shipping full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics shipping full access |
+ * | OMS - Full access | Logistics shipping full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"PUT /api/logistics/pvt/configuration/geoshape": {
+body: {
+/**
+ * Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) being created or updated.
+ */
+name: string
+/**
+ * Polygon geolocation coordinates.
+ */
+geoShape: {
+/**
+ * List of geolocation coordinates that make part of the polygon.
+ */
+coordinates: number[][][]
+}
+}
+/**
+ * Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) created or updated.
+ */
+response: string
+}
+/**
+ * Retrieves information about a [polygon](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) of your store, searching by polygon ID.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics viewer** |
+ * | Logistics | Logistics access | **Logistics shipping full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics viewer |
+ * | Logistics - Read only | Logistics viewer |
+ * | Logistics - Full access | Logistics shipping full access |
+ * | OMS - Full access | Logistics shipping full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"GET /api/logistics/pvt/configuration/geoshape/:polygonName": {
+response: {
+/**
+ * Defines if the polygon is active (`true`) or inactive (`false`).
+ */
+isActive?: boolean
+/**
+ * [Polygon](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) ID, which is the same as the polygon name.
+ */
+name?: string
+/**
+ * Polygon geolocation coordinates.
+ */
+geoShape?: {
+/**
+ * List of geolocation coordinates that make part of the polygon.
+ */
+coordinates?: number[][][]
+/**
+ * Polygon identification.
+ */
+type?: string
+}
+}
+}
+/**
+ * Deletes a [polygon](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) of your store, searching by polygon ID.
+ * 
+ * Successful requests receive a `200 OK` status code with `true` in the response body.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics shipping full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics shipping full access |
+ * | OMS - Full access | Logistics shipping full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"DELETE /api/logistics/pvt/configuration/geoshape/:polygonName": {
+/**
+ * Successful requests return the message `true`.
+ */
+response: boolean
+}
+/**
+ * Retrieves information of all [capacity reservations](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz) made to scheduled delivery windows in a given time range.
+ * 
+ * >⚠️ While most of our API endpoints return time fields in UTC format, this endpoint returns time adjusted to the configured time zone of the VTEX account.
+ * 
+ * 
> Note that the combined string `carrier@{capacityType}@{shippingPolicyId}` can be referred to as a `resource` in request messages.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics viewer** |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics shipping full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics viewer |
+ * | Logistics - Read only | Logistics viewer |
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics shipping full access |
+ * | OMS - Full access | Logistics shipping full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"GET /api/logistics-capacity/resources/carrier@:capacityType@:shippingPolicyId/time-frames": {
+searchParams: {
+/**
+ * Starting date range in the format `YYYY-MM-DD`.
+ */
+rangeStart: string
+/**
+ * Ending date range in the format `YYYY-MM-DD`.
+ */
+rangeEnd: string
+}
+/**
+ * Information about the [capacity reservation](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz) of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).
+ */
+response: {
+/**
+ * Capacity reservation ID generated by the request.
+ */
+id?: string
+/**
+ * Combined string `carrier@{capacityType}@{shippingPolicyId}` used in the request.
+ */
+resourceId?: string
+/**
+ * Starting date and time of the period considered for the request, in the format `YYYY-MM-DDTHH:MM:SSZ`. The time zone is set according to the store account.
+ */
+startDate?: string
+/**
+ * Ending date and time of the period considered for the request, in the format `YYYY-MM-DDTHH:MM:SSZ`. The time zone is set according to the store account.
+ */
+endDate?: string
+/**
+ * Delivery capacity available, which is the total capacity minus the reserved orders or items, according to the capacity type set.
+ */
+ownMaxCapacity?: number
+/**
+ * Maximum delivery capacity of orders or items.
+ */
+resourceMaxCapacity?: number
+/**
+ * Orders or items reserved from the delivery capacity.
+ */
+reservedValue?: number
+/**
+ * List of [reservations](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92).
+ */
+reservations?: {
+/**
+ * Reservation ID.
+ */
+id?: string
+/**
+ * Reservation number of items or orders, according to the capacity type set.
+ */
+value?: number
+}[]
+/**
+ * System processing information.
+ */
+log?: {
+/**
+ * Delivery capacity alteration date and time, in the format `YYYY-MM-DDTHH:MM:SSZ`. The time zone is set according to the store account.
+ */
+when?: string
+/**
+ * Who altered the delivery capacity.
+ */
+who?: string
+/**
+ * Reason for the alteration.
+ */
+why?: string
+/**
+ * Situation of the corresponding [delivery window](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi#delivery-window), which can be `Blocked` or `Unblocked`.
+ */
+what?: string
+}[]
+}
+}
+/**
+ * Retrieves capacity usage of a specific [scheduled delivery](https://help.vtex.com/en/tutorial/entrega-agendada--22g3HAVCGLFiU7xugShOBi) reservation window.
+ * 
+ * 
>⚠️ While most API endpoints return time fields in UTC format, this endpoint returns time adjusted to the configured time zone of the VTEX account.
+ * 
+ * 
> Note that the combined string `carrier@{capacityType}@{shippingPolicyId}` can be referred to as a "resource" in the API's messages.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Logistics | Logistics access | **Logistics viewer** |
+ * | Logistics | Logistics access | **Logistics full access** |
+ * | Logistics | Logistics access | **Logistics shipping full access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Logistics - Full access | Logistics viewer |
+ * | Logistics - Read only | Logistics viewer |
+ * | Logistics - Full access | Logistics full access |
+ * | OMS - Full access | Logistics full access |
+ * | Logistics - Full access | Logistics shipping full access |
+ * | OMS - Full access | Logistics shipping full access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"GET /api/logistics-capacity/resources/carrier@:capacityType@:shippingPolicyId/time-frames/:windowDayF:windowStartTimeT:windowEndTime": {
+/**
+ * Information about the [capacity reservation](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz) of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).
+ */
+response: {
+/**
+ * Capacity reservation ID generated by the request.
+ */
+id?: string
+/**
+ * Combined string `carrier@{capacityType}@{shippingPolicyId}` used in the request.
+ */
+resourceId?: string
+/**
+ * Starting date and time of the period considered for the request, in the format `YYYY-MM-DDTHH:MM:SSZ`. The time zone is set according to the store account.
+ */
+startDate?: string
+/**
+ * Ending date and time of the period considered for the request, in the format `YYYY-MM-DDTHH:MM:SSZ`. The time zone is set according to the store account.
+ */
+endDate?: string
+/**
+ * Delivery capacity available, which is the total capacity minus the reserved orders or items, according to the capacity type set.
+ */
+ownMaxCapacity?: number
+/**
+ * Maximum delivery capacity of orders or items.
+ */
+resourceMaxCapacity?: number
+/**
+ * Orders or items reserved from the delivery capacity.
+ */
+reservedValue?: number
+/**
+ * List of [reservations](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92).
+ */
+reservations?: {
+/**
+ * Reservation ID.
+ */
+id?: string
+/**
+ * Reservation number of items or orders, according to the capacity type set.
+ */
+value?: number
+}[]
+/**
+ * System processing information.
+ */
+log?: {
+/**
+ * Delivery capacity alteration date and time, in the format `YYYY-MM-DDTHH:MM:SSZ`. The time zone is set according to the store account.
+ */
+when?: string
+/**
+ * Who altered the delivery capacity.
+ */
+who?: string
+/**
+ * Reason for the alteration.
+ */
+why?: string
+/**
+ * Situation of the corresponding [delivery window](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi#delivery-window), which can be `Blocked` or `Unblocked`.
+ */
+what?: string
+}[]
+}
+}
+}
diff --git a/vtex/utils/openapi/logistics.openapi.json b/vtex/utils/openapi/logistics.openapi.json
new file mode 100644
index 000000000..caa7b98a6
--- /dev/null
+++ b/vtex/utils/openapi/logistics.openapi.json
@@ -0,0 +1,12352 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "Logistics API",
+    "description": "[Logistics or fulfillment](https://help.vtex.com/en/tutorial/logistics--53udnvI5eBy8DKo8FOjMoP) is the process of planning and executing the transportation, storage of merchandise, and shipping orders to customers. You can accomplish all of this with the VTEX platform, which allows you to manage your inventory, shipping rates, pickup points and more.\r\n\r\n## Logistics API Index\r\n\r\n### Shipping Policies\r\n\r\n- `GET` [Retrieve shipping policy by ID](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/shipping-policies/-id-)\r\n- `DELETE` [Delete shipping policies by ID](https://developers.vtex.com/docs/api-reference/logistics-api#delete-/api/logistics/pvt/shipping-policies/-id-)\r\n- `PUT` [Update shipping policy](https://developers.vtex.com/docs/api-reference/logistics-api#put-/api/logistics/pvt/shipping-policies/-id-)\r\n- `GET` [List shipping policies](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/shipping-policies)\r\n- `POST` [Create shipping policy](https://developers.vtex.com/docs/api-reference/logistics-api#post-/api/logistics/pvt/shipping-policies)\r\n\r\n### Freight Values\r\n\r\n- `POST` [Create/update freight values](https://developers.vtex.com/docs/api-reference/logistics-api#post-/api/logistics/pvt/configuration/freights/-carrierId-/values/update)\r\n- `GET` [List freight values](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/configuration/freights/-carrierId-/-cep-/values)\r\n\r\n### Scheduled Delivery\r\n\r\n- `GET` [Retrieve blocked delivery windows](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/configuration/carriers/-carrierId-/getdayofweekblocked)\r\n- `POST` [Add blocked delivery windows](https://developers.vtex.com/docs/api-reference/logistics-api#post-/api/logistics/pvt/configuration/carriers/-carrierId-/adddayofweekblocked)\r\n- `POST` [Remove blocked delivery windows](https://developers.vtex.com/docs/api-reference/logistics-api#post-/api/logistics/pvt/configuration/carriers/-carrierId-/removedayofweekblocked)\r\n- `GET` [Search capacity reservations in time range](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics-capacity/resources/carrier@-capacityType-@-shippingPolicyId-/time-frames)\r\n- `GET` [Get capacity reservation usage by window](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics-capacity/resources/carrier@-capacityType-@-shippingPolicyId-/time-frames/-windowDay-F-windowStartTime-T-windowEndTime-)\r\n\r\n### Docks\r\n\r\n- `POST` [Create/update dock](https://developers.vtex.com/docs/api-reference/logistics-api#post-/api/logistics/pvt/configuration/docks)\r\n- `GET` [List all docks](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/configuration/docks)\r\n- `GET` [List dock by ID](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/configuration/docks/-dockId-)\r\n- `DELETE` [Delete dock](https://developers.vtex.com/docs/api-reference/logistics-api#delete-/api/logistics/pvt/configuration/docks/-dockId-)\r\n- `POST` [Activate dock](https://developers.vtex.com/docs/api-reference/logistics-api#post-/api/logistics/pvt/configuration/docks/-dockId-/activation)\r\n- `POST` [Deactivate dock](https://developers.vtex.com/docs/api-reference/logistics-api#post-/api/logistics/pvt/configuration/docks/-dockId-/deactivation)\r\n\r\n### Warehouses\r\n\r\n- `POST` [Create/update warehouse](https://developers.vtex.com/docs/api-reference/logistics-api#post-/api/logistics/pvt/configuration/warehouses)\r\n- `GET` [List all warehouses](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/configuration/warehouses)\r\n- `GET` [List warehouse by ID](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/configuration/warehouses/-warehouseId-)\r\n- `DELETE` [Remove warehouse](https://developers.vtex.com/docs/api-reference/logistics-api#delete-/api/logistics/pvt/configuration/warehouses/-warehouseId-)\r\n- `POST` [Activate warehouse](https://developers.vtex.com/docs/api-reference/logistics-api#post-/api/logistics/pvt/configuration/warehouses/-warehouseId-/activation)\r\n- `POST` [Deactivate warehouse](https://developers.vtex.com/docs/api-reference/logistics-api#post-/api/logistics/pvt/configuration/warehouses/-warehouseId-/deactivation)\r\n\r\n### Inventory\r\n\r\n- `GET` [List inventory by SKU](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/inventory/skus/-skuId-)\r\n- `GET` [List inventory per warehouse](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/inventory/items/-skuId-/warehouses/-warehouseId-)\r\n- `PUT` [Update inventory by SKU and warehouse](https://developers.vtex.com/docs/api-reference/logistics-api#put-/api/logistics/pvt/inventory/skus/-skuId-/warehouses/-warehouseId-)\r\n- `PATCH` [Update inventory quantity by SKU and warehouse](https://developers.vtex.com/docs/api-reference/logistics-api#patch-/api/logistics/pvt/inventory/skus/-skuId-/warehouses/-warehouseId-/quantity)\r\n- `PATCH` [Update inventory lead time by SKU and warehouse](https://developers.vtex.com/docs/api-reference/logistics-api#patch-/api/logistics/pvt/inventory/skus/-skuId-/warehouses/-warehouseId-/lead-time)\r\n- `GET` [List inventory per dock](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/inventory/items/-skuId-/docks/-dockId-)\r\n- `GET` [List inventory per dock and warehouse](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/inventory/items/-skuId-/docks/-dockId-/warehouses/-warehouseId-)\r\n- `GET` [List inventory with dispatched reservations](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/inventory/items/-itemId-/warehouses/-warehouseId-/dispatched)\r\n- `GET` [List supply lots](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/inventory/items/-skuId-/warehouses/-warehouseId-/supplyLots)\r\n- `PUT` [Save supply lot](https://developers.vtex.com/docs/api-reference/logistics-api#put-/api/logistics/pvt/inventory/items/-skuId-/warehouses/-warehouseId-/supplyLots/-supplyLotId-)\r\n- `POST` [Transfer supply lot](https://developers.vtex.com/docs/api-reference/logistics-api#post-/api/logistics/pvt/inventory/items/-skuId-/warehouses/-warehouseId-/supplyLots/-supplyLotId-/transfer)\r\n\r\n### Holidays\r\n\r\n- `PUT` [Create/update holiday](https://developers.vtex.com/docs/api-reference/logistics-api#put-/api/logistics/pvt/configuration/holidays/-holidayId-)\r\n- `GET` [List holiday by ID](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/configuration/holidays/-holidayId-)\r\n- `DELETE` [Delete holiday](https://developers.vtex.com/docs/api-reference/logistics-api#delete-/api/logistics/pvt/configuration/holidays/-holidayId-)\r\n- `GET` [List all holidays](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/configuration/holidays)\r\n\r\n### Reservations\r\n\r\n- `POST` [Create reservation](https://developers.vtex.com/docs/api-reference/logistics-api#post-/api/logistics/pvt/inventory/reservations)\r\n- `GET` [List reservation by ID](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/inventory/reservations/-reservationId-)\r\n- `POST` [Confirm reservation](https://developers.vtex.com/docs/api-reference/logistics-api#post-/api/logistics/pvt/inventory/reservations/-reservationId-/confirm)\r\n- `POST` [Acknowledgment reservation](https://developers.vtex.com/docs/api-reference/logistics-api#post-/api/logistics/pvt/inventory/reservations/-reservationId-/acknowledge)\r\n- `POST` [Cancel reservation](https://developers.vtex.com/docs/api-reference/logistics-api#post-/api/logistics/pvt/inventory/reservations/-reservationId-/cancel)\r\n- `GET` [List reservation by warehouse and SKU](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/inventory/reservations/-warehouseId-/-skuId-)\r\n\r\n### SLA\r\n\r\n- `POST` [Calculate SLA](https://developers.vtex.com/docs/api-reference/logistics-api#post-/api/logistics/pvt/shipping/calculate)\r\n\r\n### Pickup points\r\n\r\n- `GET` [List pickup points](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/configuration/pickuppoints)\r\n- `PUT` [Create/Update Pickup Point](https://developers.vtex.com/docs/api-reference/logistics-api#put-/api/logistics/pvt/configuration/pickuppoints/-pickupPointId-)\r\n- `GET` [List Pickup Point By ID](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/configuration/pickuppoints/-pickupPointId-)\r\n- `DELETE` [Delete Pickup Point](https://developers.vtex.com/docs/api-reference/logistics-api#delete-/api/logistics/pvt/configuration/pickuppoints/-pickupPointId-)\r\n- `GET` [List paged Pickup Points](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/configuration/pickuppoints/_search)\r\n\r\n### Polygons\r\n\r\n- `GET` [List paged polygons](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/configuration/geoshape)\r\n- `PUT` [Create/update polygon](https://developers.vtex.com/docs/api-reference/logistics-api#put-/api/logistics/pvt/configuration/geoshape)\r\n- `GET` [List polygon by ID](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/configuration/geoshape/-polygonName-)\r\n- `DELETE` [Delete polygon](https://developers.vtex.com/docs/api-reference/logistics-api#delete-/api/logistics/pvt/configuration/geoshape/-polygonName-) \r\n\r\n## Common parameters\r\n\r\n| **Parameter name** | **Description** | **Type** |\r\n| :---: | :--- | :--- |\r\n| `{{accountName}}` | Name of the VTEX account. Used as part of the URL. | Server variable. |\r\n| `{{environment}}` | Environment to use. Used as part of the URL. The default value is `vtexcommercestable`. | Server variable. |\r\n| `X-VTEX-API-AppKey` | Unique identifier of the [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys). | Authentication header. Must be used together with `X-VTEX-API-AppToken`. Not necessary when using `VtexIdclientAutCookie`. |\r\n| `X-VTEX-API-AppToken` | Secret token of the [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys). | Authentication header. Must be used together with X-VTEX-API-AppKey. Not necessary when using `VtexIdclientAutCookie`. |\r\n| `VtexIdclientAutCookie` | [User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours. | Authentication header. Not necessary when using `X-VTEX-API-AppKey` and `X-VTEX-API-AppToken`. |",
+    "contact": {},
+    "version": "1.0"
+  },
+  "servers": [
+    {
+      "url": "https://{accountName}.{environment}.com.br",
+      "description": "VTEX server URL.",
+      "variables": {
+        "accountName": {
+          "description": "Name of the VTEX account. Used as part of the URL.",
+          "default": "apiexamples"
+        },
+        "environment": {
+          "description": "Environment to use. Used as part of the URL.",
+          "enum": [
+            "vtexcommercestable"
+          ],
+          "default": "vtexcommercestable"
+        }
+      }
+    }
+  ],
+  "paths": {
+    "/api/logistics/pvt/shipping-policies/{id}": {
+      "get": {
+        "tags": [
+          "Shipping policies"
+        ],
+        "summary": "Retrieve shipping policy by ID",
+        "description": "Retrieves information from a [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) from your store, searching by shipping policy ID.\r\n\r\n>⚠️ While most endpoints return time fields in UTC format, this endpoint returns **Scheduled Delivery** related time fields adjusted to the time zone configured for the VTEX account.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "description": "[Shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) ID.",
+            "schema": {
+              "type": "string",
+              "example": "sp12"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "description": "Details about a given shipping policy.",
+                  "properties": {
+                    "id": {
+                      "type": "string",
+                      "description": "[Shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) ID."
+                    },
+                    "name": {
+                      "type": "string",
+                      "description": "[Shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) name."
+                    },
+                    "shippingMethod": {
+                      "type": "string",
+                      "description": "Type of shipping available for this shipping policy (carrier). Options are shown on [shipping simulation](https://help.vtex.com/en/tutorial/shipping-simulation--tutorials_144)."
+                    },
+                    "weekendAndHolidays": {
+                      "type": "object",
+                      "description": "If the shipping policy includes deliveries on weekends and holidays.",
+                      "properties": {
+                        "saturday": {
+                          "type": "boolean",
+                          "description": "Defines if shipping on Saturdays is valid (`true`) or not (`false`)."
+                        },
+                        "sunday": {
+                          "type": "boolean",
+                          "description": "Defines if shipping on Sundays is valid (`true`) or not (`false`)."
+                        },
+                        "holiday": {
+                          "type": "boolean",
+                          "description": "Defines if shipping on holidays is valid (`true`) or not (`false`)."
+                        }
+                      }
+                    },
+                    "maxDimension": {
+                      "type": "object",
+                      "description": "Object containing attributes of maximum dimension permitted by the shipping policy (carrier).",
+                      "properties": {
+                        "largestMeasure": {
+                          "type": "number",
+                          "description": "Largest measure acceptable of the package."
+                        },
+                        "maxMeasureSum": {
+                          "type": "number",
+                          "description": "Limit for the sum of all maximum measures of the package."
+                        }
+                      }
+                    },
+                    "numberOfItemsPerShipment": {
+                      "type": "integer",
+                      "description": "Determines the number of items allowed per shipment."
+                    },
+                    "minimumValueAceptable": {
+                      "type": "number",
+                      "description": "Minimum value accepted by the carrier for delivering."
+                    },
+                    "maximumValueAceptable": {
+                      "type": "number",
+                      "description": "Maximum value accepted by the carrier for delivering."
+                    },
+                    "additionalTime": {
+                      "type": "string",
+                      "description": "Additional time configured in `HH:MM:SS` format.",
+                      "deprecated": true
+                    },
+                    "additionalPrice": {
+                      "type": "object",
+                      "description": "Additional price object.",
+                      "properties": {
+                        "method": {
+                          "type": "integer",
+                          "description": "Additional price method.",
+                          "deprecated": true
+                        },
+                        "value": {
+                          "type": "number",
+                          "description": "Payment value.",
+                          "deprecated": true
+                        }
+                      },
+                      "deprecated": true
+                    },
+                    "deliveryScheduleSettings": {
+                      "type": "object",
+                      "description": "[Scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) settings.",
+                      "properties": {
+                        "useDeliverySchedule": {
+                          "type": "boolean",
+                          "description": "Defines if the scheduled delivery configuration is active (`true`) or not (`false`)."
+                        },
+                        "maxRangeDelivery": {
+                          "type": "number",
+                          "description": "Range of days available within a delivery window, for the customer to choose the scheduled delivery. For example, if the configured `maxRangeDelivery` is equal `7`, and the customer buys something on a Tuesday, the options for scheduled delivery will be shown until the following Tuesday (7 days from the purchase day). If no options are available within the `maxRangeDelivery` set, the shipping policy will not be shown on the checkout."
+                        },
+                        "dayOfWeekForDelivery": {
+                          "type": "array",
+                          "description": "Selected days for delivery, from `0` (Sunday) to `6` (Saturday).",
+                          "items": {
+                            "type": "object",
+                            "description": "Selected days for delivery objects.",
+                            "properties": {
+                              "dayOfWeek": {
+                                "type": "integer",
+                                "description": "Day of the week, from `0` (Sunday) to `6` (Saturday)."
+                              },
+                              "deliveryRanges": {
+                                "type": "array",
+                                "description": "Reservation window for scheduled delivery.",
+                                "items": {
+                                  "type": "object",
+                                  "description": "Reservation window for scheduled delivery object.",
+                                  "properties": {
+                                    "startTime": {
+                                      "type": "string",
+                                      "description": "Start time for day of the week in `hh:mm:ss` format."
+                                    },
+                                    "endTime": {
+                                      "type": "string",
+                                      "description": "End time for day of the week in `hh:mm:ss` format."
+                                    },
+                                    "listPrice": {
+                                      "type": "number",
+                                      "description": "List price for day of the week."
+                                    },
+                                    "deliveryCapacity": {
+                                      "type": "array",
+                                      "description": "Sets maximum [delivery capacity](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz) for a given reservation window for scheduled delivery.",
+                                      "nullable": true,
+                                      "items": {
+                                        "type": "object",
+                                        "description": "Object with the maximum delivery capacity for a reservation window.",
+                                        "properties": {
+                                          "capacityType": {
+                                            "type": "string",
+                                            "description": "Defines how the delivery capacity is measured for this reservation window, by maximum number of orders (`ORDERS_QUANTITY`) or items (`SKUS_QUANTITY`)."
+                                          },
+                                          "maxValue": {
+                                            "type": "number",
+                                            "description": "Maximum number of orders or SKUs that the store is capable of fulfilling."
+                                          }
+                                        }
+                                      }
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "dayOfWeekBlockeds": {
+                          "type": "array",
+                          "description": "Defines if there are any days of the week that are blocked.",
+                          "items": {
+                            "type": "string",
+                            "description": "Date and time of the blocked day in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss`."
+                          },
+                          "nullable": true,
+                          "deprecated": true
+                        }
+                      }
+                    },
+                    "carrierSchedule": {
+                      "type": "array",
+                      "description": "Schedule sent by the carrier to configure the shipping policy.",
+                      "items": {
+                        "type": "object",
+                        "description": "Carrier schedule for configuring the shipping policy object.",
+                        "properties": {
+                          "dayOfWeek": {
+                            "type": "integer",
+                            "description": "Day of the week from `0` (Sunday) to `6` (Saturday)."
+                          },
+                          "timeLimit": {
+                            "type": "string",
+                            "description": "Time limit in `HH:MM:SS` format."
+                          }
+                        }
+                      }
+                    },
+                    "cubicWeightSettings": {
+                      "type": "object",
+                      "description": "Settings for the cubic weight of a package, which accounts for the [package's volume](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128), and not only weight.",
+                      "properties": {
+                        "volumetricFactor": {
+                          "type": "number",
+                          "description": "Factor that will be used on the cubic weight calculation, usually given by the carrier."
+                        },
+                        "minimunAcceptableVolumetricWeight": {
+                          "type": "number",
+                          "description": "Packages' minimum acceptable [volumetric weight](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128)."
+                        }
+                      }
+                    },
+                    "modalSettings": {
+                      "type": "object",
+                      "description": "Configurations for the [modal](https://help.vtex.com/en/tutorial/how-does-the-modal-work--tutorials_125), which is the attachement of a specific product to a carrier specialized in delivering that type of product.",
+                      "properties": {
+                        "modals": {
+                          "type": "array",
+                          "description": "Type of special freight.",
+                          "items": {
+                            "type": "string",
+                            "enum": [
+                              "CHEMICALS",
+                              "ELECTRONICS",
+                              "FURNITURE",
+                              "GLASS",
+                              "LIQUID",
+                              "MATTRESSES",
+                              "REFRIGERATED",
+                              "TIRES",
+                              "WHITE_GOODS",
+                              "FIREARMS"
+                            ],
+                            "description": "Modal values assigned to the special freight."
+                          }
+                        },
+                        "useOnlyItemsWithDefinedModal": {
+                          "type": "boolean",
+                          "description": "When set as `true`, the modal's configurations will apply only for items with a defined modal, when `false`, the modal configuration will not be set."
+                        }
+                      }
+                    },
+                    "businessHourSettings": {
+                      "type": "object",
+                      "description": "Business hours configurations.",
+                      "properties": {
+                        "carrierBusinessHours": {
+                          "type": "array",
+                          "description": "Business hours configurations array for the days of the week.",
+                          "items": {
+                            "type": "object",
+                            "description": "Business hours configurations for a single day of the week.",
+                            "properties": {
+                              "openingTime": {
+                                "type": "string",
+                                "description": "Opening time in `HH:MM:SS` format."
+                              },
+                              "closingTime": {
+                                "type": "string",
+                                "description": "Closing time in `HH:MM:SS` format."
+                              },
+                              "dayOfWeek": {
+                                "type": "integer",
+                                "description": "Day of the week from `0` (Sunday) to `6` (Saturday).",
+                                "enum": [
+                                  0,
+                                  1,
+                                  2,
+                                  3,
+                                  4,
+                                  5,
+                                  6
+                                ]
+                              }
+                            }
+                          }
+                        },
+                        "isOpenOutsideBusinessHours": {
+                          "type": "boolean",
+                          "description": "Defines if deliveries outside business hours are allowed (`true`) or not (`false`)."
+                        }
+                      }
+                    },
+                    "pickupPointsSettings": {
+                      "type": "object",
+                      "description": "[Pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) configurations of the shipping policy.",
+                      "properties": {
+                        "pickupPointIds": {
+                          "type": "array",
+                          "description": "Pickup point IDs configured for the shipping policy.",
+                          "items": {
+                            "type": "string",
+                            "description": "Pickup point ID."
+                          }
+                        },
+                        "pickupPointTags": {
+                          "type": "array",
+                          "description": "Pickup points tags configured for the shipping policy.",
+                          "items": {
+                            "type": "string",
+                            "description": "Tag identification."
+                          }
+                        },
+                        "sellers": {
+                          "type": "array",
+                          "description": "Sellers associated with [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) related to the shipping policy.",
+                          "items": {
+                            "type": "string",
+                            "description": "Sellers IDS."
+                          }
+                        }
+                      }
+                    },
+                    "processingStatus": {
+                      "type": "object",
+                      "description": "Shipping policy processing status.",
+                      "properties": {
+                        "status": {
+                          "type": "integer",
+                          "format": "int32",
+                          "description": "Shipping policy processing status code."
+                        },
+                        "errorMessage": {
+                          "type": "string",
+                          "description": "Error message, when applicable.",
+                          "nullable": true
+                        },
+                        "errorsMetadata": {
+                          "type": "string",
+                          "description": "Error metadata, when applicable.",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "deliveryChannel": {
+                      "type": "string",
+                      "description": "Defines if the shipping type is `delivery` or `pickup`."
+                    },
+                    "calculationType": {
+                      "type": "integer",
+                      "description": "Shipping policy calculation type."
+                    },
+                    "isActive": {
+                      "type": "boolean",
+                      "description": "Defines if the shipping policy is active (`true`) or not (`false`)."
+                    },
+                    "lastIndexedAt": {
+                      "type": "string",
+                      "description": "Date and time since the last [indexing](https://help.vtex.com/en/tutorial/understanding-how-indexation-works--tutorials_256), in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DD hh:mm:ss[.nnnnnnn]+hh:mm`.",
+                      "nullable": true
+                    },
+                    "shippingHoursSettings": {
+                      "type": "object",
+                      "description": "Shipping hours settings configurations.",
+                      "properties": {
+                        "shippingHours": {
+                          "type": "array",
+                          "description": "Shipping hours settings array.",
+                          "items": {
+                            "type": "object",
+                            "description": "Object with details on shipping hours settings.",
+                            "properties": {
+                              "dayOfWeek": {
+                                "type": "integer",
+                                "description": "Day of the week from `0` (Sunday) to `6` (Saturday)."
+                              },
+                              "openingTime": {
+                                "type": "string",
+                                "description": "Opening time in `hh:mm:ss` format."
+                              },
+                              "closingTime": {
+                                "type": "string",
+                                "description": "Closing time in `hh:mm:ss` format."
+                              }
+                            }
+                          }
+                        },
+                        "acceptOrdersOutsideShippingHours": {
+                          "type": "boolean",
+                          "description": "Defines if the configuration that allows accepting orders outside shipping hours is active (`true`) or not (`false`)."
+                        }
+                      }
+                    },
+                    "carrierInfo": {
+                      "type": "object",
+                      "description": "[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) information.",
+                      "properties": {
+                        "carrierAccountName": {
+                          "type": "string",
+                          "description": "VTEX store account name related to the shipping policy."
+                        },
+                        "deliveryAgreementId": {
+                          "type": "string",
+                          "description": "Delivery agreement ID.",
+                          "nullable": true
+                        },
+                        "linkedDocks": {
+                          "type": "array",
+                          "description": "Shipping policy [loading docks](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) valid for the carrier.",
+                          "items": {
+                            "type": "object",
+                            "description": "Loading dock object.",
+                            "properties": {
+                              "id": {
+                                "type": "string",
+                                "description": "Loading dock ID."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Loading dock name."
+                              }
+                            }
+                          }
+                        },
+                        "readyToUse": {
+                          "type": "boolean",
+                          "description": "Defines if shipping configurations related to the carrier make them ready for shipping (`true`) or not (`false`)."
+                        }
+                      }
+                    }
+                  }
+                },
+                "example": {
+                  "id": "store-sp-01",
+                  "name": "store-sp-01",
+                  "shippingMethod": "normal delivery",
+                  "weekendAndHolidays": {
+                    "saturday": true,
+                    "sunday": true,
+                    "holiday": true
+                  },
+                  "maxDimension": {
+                    "largestMeasure": 0,
+                    "maxMeasureSum": 1100
+                  },
+                  "numberOfItemsPerShipment": 1,
+                  "minimumValueAceptable": 0,
+                  "maximumValueAceptable": 0,
+                  "additionalTime": "00:00:00",
+                  "additionalPrice": {
+                    "method": 0,
+                    "value": 0
+                  },
+                  "deliveryScheduleSettings": {
+                    "useDeliverySchedule": true,
+                    "dayOfWeekForDelivery": [
+                      {
+                        "dayOfWeek": 1,
+                        "deliveryRanges": [
+                          {
+                            "startTime": "00:00:00",
+                            "endTime": "23:59:59",
+                            "listPrice": 0,
+                            "deliveryCapacity": null
+                          }
+                        ]
+                      },
+                      {
+                        "dayOfWeek": 2,
+                        "deliveryRanges": [
+                          {
+                            "startTime": "00:00:00",
+                            "endTime": "23:59:59",
+                            "listPrice": 0,
+                            "deliveryCapacity": null
+                          }
+                        ]
+                      },
+                      {
+                        "dayOfWeek": 3,
+                        "deliveryRanges": [
+                          {
+                            "startTime": "00:00:00",
+                            "endTime": "23:59:59",
+                            "listPrice": 0,
+                            "deliveryCapacity": null
+                          }
+                        ]
+                      },
+                      {
+                        "dayOfWeek": 4,
+                        "deliveryRanges": [
+                          {
+                            "startTime": "00:00:00",
+                            "endTime": "23:59:59",
+                            "listPrice": 0,
+                            "deliveryCapacity": null
+                          }
+                        ]
+                      },
+                      {
+                        "dayOfWeek": 5,
+                        "deliveryRanges": [
+                          {
+                            "startTime": "00:00:00",
+                            "endTime": "23:59:59",
+                            "listPrice": 0,
+                            "deliveryCapacity": null
+                          }
+                        ]
+                      },
+                      {
+                        "dayOfWeek": 6,
+                        "deliveryRanges": [
+                          {
+                            "startTime": "00:00:00",
+                            "endTime": "23:59:59",
+                            "listPrice": 0,
+                            "deliveryCapacity": null
+                          }
+                        ]
+                      },
+                      {
+                        "dayOfWeek": 0,
+                        "deliveryRanges": [
+                          {
+                            "startTime": "00:00:00",
+                            "endTime": "23:59:59",
+                            "listPrice": 0,
+                            "deliveryCapacity": null
+                          }
+                        ]
+                      }
+                    ],
+                    "maxRangeDelivery": 1,
+                    "dayOfWeekBlockeds": [
+                      "2024-02-13T09:00:00",
+                      "2024-06-09T09:00:00"
+                    ]
+                  },
+                  "carrierSchedule": [
+                    {
+                      "dayOfWeek": 0,
+                      "timeLimit": "time_limit"
+                    }
+                  ],
+                  "cubicWeightSettings": {
+                    "volumetricFactor": 0.2,
+                    "minimunAcceptableVolumetricWeight": 0
+                  },
+                  "modalSettings": {
+                    "modals": [
+                      "LIQUID"
+                    ],
+                    "useOnlyItemsWithDefinedModal": false
+                  },
+                  "businessHourSettings": {
+                    "carrierBusinessHours": [
+                      {
+                        "dayOfWeek": 1,
+                        "openingTime": "00:00:00",
+                        "closingTime": "23:59:59"
+                      },
+                      {
+                        "dayOfWeek": 2,
+                        "openingTime": "00:00:00",
+                        "closingTime": "23:59:59"
+                      },
+                      {
+                        "dayOfWeek": 3,
+                        "openingTime": "00:00:00",
+                        "closingTime": "23:59:59"
+                      },
+                      {
+                        "dayOfWeek": 4,
+                        "openingTime": "00:00:00",
+                        "closingTime": "23:59:59"
+                      },
+                      {
+                        "dayOfWeek": 5,
+                        "openingTime": "00:00:00",
+                        "closingTime": "23:59:59"
+                      },
+                      {
+                        "dayOfWeek": 6,
+                        "openingTime": "00:00:00",
+                        "closingTime": "23:59:59"
+                      },
+                      {
+                        "dayOfWeek": 0,
+                        "openingTime": "00:00:00",
+                        "closingTime": "23:59:59"
+                      }
+                    ],
+                    "isOpenOutsideBusinessHours": true
+                  },
+                  "pickupPointsSettings": {
+                    "pickupPointIds": [
+                      "Id1",
+                      "Id2"
+                    ],
+                    "pickupPointTags": [
+                      "Tag1",
+                      "Tag2"
+                    ],
+                    "sellers": [
+                      "Seller1"
+                    ]
+                  },
+                  "processingStatus": {
+                    "status": 1,
+                    "errorMessage": null,
+                    "errorsMetadata": null
+                  },
+                  "deliveryChannel": "delivery",
+                  "calculationType": 0,
+                  "isActive": true,
+                  "lastIndexedAt": "2024-05-30T14:13:34.158121+00:00",
+                  "shippingHoursSettings": {
+                    "shippingHours": [
+                      {
+                        "dayOfWeek": 1,
+                        "openingTime": "00:00:00",
+                        "closingTime": "23:59:59"
+                      },
+                      {
+                        "dayOfWeek": 2,
+                        "openingTime": "00:00:00",
+                        "closingTime": "23:59:59"
+                      },
+                      {
+                        "dayOfWeek": 3,
+                        "openingTime": "00:00:00",
+                        "closingTime": "23:59:59"
+                      },
+                      {
+                        "dayOfWeek": 4,
+                        "openingTime": "00:00:00",
+                        "closingTime": "23:59:59"
+                      },
+                      {
+                        "dayOfWeek": 5,
+                        "openingTime": "00:00:00",
+                        "closingTime": "23:59:59"
+                      },
+                      {
+                        "dayOfWeek": 6,
+                        "openingTime": "00:00:00",
+                        "closingTime": "23:59:59"
+                      },
+                      {
+                        "dayOfWeek": 0,
+                        "openingTime": "00:00:00",
+                        "closingTime": "23:59:59"
+                      }
+                    ],
+                    "acceptOrdersOutsideShippingHours": true
+                  },
+                  "carrierInfo": {
+                    "carrierAccountName": "vtexcorreios",
+                    "deliveryAgreementId": "d91dee11-6afb-4835-99bc-5r671a578076",
+                    "linkedDocks": [
+                      {
+                        "id": "2656",
+                        "name": "CORREIOS 2656"
+                      }
+                    ],
+                    "readyToUse": true
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
+      "delete": {
+        "tags": [
+          "Shipping policies"
+        ],
+        "summary": "Delete shipping policy by ID",
+        "description": "Deletes a [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) of your store, searching by shipping policy ID. \r\n\r\n>⚠️ While most endpoints return time fields in UTC format, this endpoint returns **Scheduled Delivery** related time fields adjusted to the time zone configured for the VTEX account. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "parameters": [
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "description": "ID of the shipping policy.",
+            "schema": {
+              "type": "string",
+              "example": "id"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      },
+      "put": {
+        "tags": [
+          "Shipping policies"
+        ],
+        "summary": "Update shipping policy by ID",
+        "description": "Updates information about a [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) of your store, searching by shipping policy ID. \r\n\r\n>⚠️ While most endpoints return time fields in UTC format, this endpoint returns **Scheduled Delivery** related time fields adjusted to the time zone configured for the VTEX account. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "parameters": [
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "description": "Shipping policy ID.",
+            "schema": {
+              "type": "string",
+              "example": "shippingpolicyid1"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        },
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "required": [
+                  "name",
+                  "shippingMethod",
+                  "deliveryOnWeekends",
+                  "maxDimension",
+                  "isActive"
+                ],
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "[Shipping policy]((https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) name.",
+                    "example": "Correios PAC"
+                  },
+                  "shippingMethod": {
+                    "type": "string",
+                    "description": "Type of shipping available for this shipping policy (carrier). Options are shown on [shipping simulation](https://help.vtex.com/en/tutorial/shipping-simulation--tutorials_144).",
+                    "example": "Normal"
+                  },
+                  "deliveryOnWeekends": {
+                    "type": "boolean",
+                    "description": "Defines if the delivery on weekends configuration is active (`true`) or not (`false`).",
+                    "example": false
+                  },
+                  "maxDimension": {
+                    "type": "object",
+                    "description": "Object containing attributes of maximum dimension permitted by the shipping policy (carrier).",
+                    "example": {
+                      "largestMeasure": 10,
+                      "maxMeasureSum": 30
+                    },
+                    "required": [
+                      "largestMeasure",
+                      "maxMeasureSum"
+                    ],
+                    "properties": {
+                      "largestMeasure": {
+                        "type": "number",
+                        "description": "Largest measure acceptable of the package.",
+                        "example": 0
+                      },
+                      "maxMeasureSum": {
+                        "type": "number",
+                        "description": "Sum of all maximum measures of the package.",
+                        "example": 0
+                      }
+                    }
+                  },
+                  "cubicWeightSettings": {
+                    "type": "object",
+                    "description": "Settings for the cubic weight of a package, which accounts for the [package's volume](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128), and not only weight.",
+                    "properties": {
+                      "volumetricFactor": {
+                        "type": "number",
+                        "description": "Factor that will be used on the cubic weight calculation, usually given by the carrier.",
+                        "example": 0.2
+                      },
+                      "minimunAcceptableVolumetricWeight": {
+                        "type": "number",
+                        "description": "Packages' minimum acceptable [volumetric weight](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128).",
+                        "example": 0
+                      }
+                    }
+                  },
+                  "modalSettings": {
+                    "type": "object",
+                    "description": "Configurations for the [modal](https://help.vtex.com/en/tutorial/how-does-the-modal-work--tutorials_125), which is the attachement of a specific product to a carrier specialized in delivering that type of product.",
+                    "properties": {
+                      "modals": {
+                        "type": "array",
+                        "description": "Type of special freight.",
+                        "items": {
+                          "type": "string",
+                          "enum": [
+                            "CHEMICALS",
+                            "ELECTRONICS",
+                            "FURNITURE",
+                            "GLASS",
+                            "LIQUID",
+                            "MATTRESSES",
+                            "REFRIGERATED",
+                            "TIRES",
+                            "WHITE_GOODS",
+                            "FIREARMS"
+                          ],
+                          "description": "Modal values assigned to the special freight.",
+                          "example": "LIQUID"
+                        }
+                      },
+                      "useOnlyItemsWithDefinedModal": {
+                        "type": "boolean",
+                        "description": "When set as `true`, the modal's configurations will apply only for items with a defined modal, when `false`, the modal configuration will not be set.",
+                        "example": false
+                      }
+                    }
+                  },
+                  "isActive": {
+                    "type": "boolean",
+                    "description": "Defines if the shipping policy is active (`true`) or inactive (`false`).",
+                    "example": true
+                  },
+                  "deliveryScheduleSettings": {
+                    "type": "object",
+                    "description": "[Scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) settings.",
+                    "required": [
+                      "useDeliverySchedule",
+                      "dayOfWeekForDelivery",
+                      "maxRangeDelivery"
+                    ],
+                    "properties": {
+                      "useDeliverySchedule": {
+                        "type": "boolean",
+                        "description": "Defines if the scheduled delivery configuration is active (`true`) or inactive (`false`).",
+                        "example": true
+                      },
+                      "maxRangeDelivery": {
+                        "type": "number",
+                        "description": "Range of days available within a delivery window, for the customer to choose the scheduled delivery. For example, if the configured maxRangeDelivery is equal 7, and the customer buys something on a Tuesday, the options for scheduled delivery will be shown until the following Tuesday (7 days from the purchase day). If no options are available within the maxRangeDelivery set, this shipping policy won't be shown on the checkout.",
+                        "example": 0
+                      },
+                      "dayOfWeekForDelivery": {
+                        "type": "array",
+                        "description": "Select the chosen days of the week for delivery, from `0` (sunday) to `6` (saturday). Make sure to add the available hours, as shown in the example.",
+                        "items": {
+                          "type": "object",
+                          "description": "Configuration for delivery for a single day of the week.",
+                          "required": [
+                            "dayOfWeek",
+                            "deliveryRanges"
+                          ],
+                          "properties": {
+                            "dayOfWeek": {
+                              "type": "integer",
+                              "description": "Day of the week, from `0` (Sunday) to `6` (Saturday).",
+                              "enum": [
+                                0,
+                                1,
+                                2,
+                                3,
+                                4,
+                                5,
+                                6
+                              ],
+                              "example": 2
+                            },
+                            "deliveryRanges": {
+                              "type": "array",
+                              "description": "Reservation windows for scheduled delivery.",
+                              "items": {
+                                "type": "object",
+                                "description": "Delivery ranges object.",
+                                "required": [
+                                  "startTime",
+                                  "endTime",
+                                  "listPrice"
+                                ],
+                                "properties": {
+                                  "startTime": {
+                                    "type": "string",
+                                    "description": "Start time for day of the week.",
+                                    "example": "11:00:00"
+                                  },
+                                  "endTime": {
+                                    "type": "string",
+                                    "description": "End time for day of the week.",
+                                    "example": "12:30:00"
+                                  },
+                                  "listPrice": {
+                                    "type": "number",
+                                    "description": "List price for day of the week.",
+                                    "example": 0
+                                  },
+                                  "deliveryCapacity": {
+                                    "type": "array",
+                                    "description": "Sets maximum delivery capacity for a given reservation window for scheduled delivery.",
+                                    "items": {
+                                      "type": "object",
+                                      "description": "Delivery capacity object.",
+                                      "required": [
+                                        "capacityType",
+                                        "maxValue"
+                                      ],
+                                      "properties": {
+                                        "capacityType": {
+                                          "type": "string",
+                                          "description": "Defines how the delivery capacity is measured for this reservation window, by maximum number of orders (`\"ORDERS_QUANTITY\"`) or SKUs (`\"SKUS_QUANTITY\"`).",
+                                          "example": "ORDERS_QUANTITY"
+                                        },
+                                        "maxValue": {
+                                          "type": "number",
+                                          "description": "Maximum number of orders or SKUs that the store is capable of fulfilling.",
+                                          "example": 0
+                                        }
+                                      }
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/shipping-policies": {
+      "get": {
+        "tags": [
+          "Shipping policies"
+        ],
+        "summary": "List shipping policies",
+        "description": "Lists all [shipping policies](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) from your store.\r\n\r\n>⚠️ While most endpoints return time fields in UTC format, this endpoint returns **Scheduled Delivery** related time fields adjusted to the time zone configured for the VTEX account.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "parameters": [
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "page",
+            "in": "query",
+            "required": false,
+            "description": "Number of the starting page of the response. When no value is sent, it starts in page `1`.",
+            "schema": {
+              "type": "integer",
+              "example": 1
+            }
+          },
+          {
+            "name": "perPage",
+            "in": "query",
+            "required": false,
+            "description": "Desired number of items per page, to retrieve information from your shipping policies.",
+            "schema": {
+              "type": "integer",
+              "example": 15
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "description": "Paged shipping policies list.",
+                  "properties": {
+                    "items": {
+                      "type": "array",
+                      "description": "List of shipping policies related to the account.",
+                      "items": {
+                        "type": "object",
+                        "description": "Details about a given shipping policy.",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "[Shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) ID."
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "[Shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) name."
+                          },
+                          "shippingMethod": {
+                            "type": "string",
+                            "description": "Type of shipping available for this shipping policy (carrier). Options are shown on [shipping simulation](https://help.vtex.com/en/tutorial/shipping-simulation--tutorials_144)."
+                          },
+                          "weekendAndHolidays": {
+                            "type": "object",
+                            "description": "If the shipping policy includes deliveries on weekends and holidays.",
+                            "properties": {
+                              "saturday": {
+                                "type": "boolean",
+                                "description": "Defines if shipping on Saturdays is valid (`true`) or not (`false`)."
+                              },
+                              "sunday": {
+                                "type": "boolean",
+                                "description": "Defines if shipping on Sundays is valid (`true`) or not (`false`)."
+                              },
+                              "holiday": {
+                                "type": "boolean",
+                                "description": "Defines if shipping on holidays is valid (`true`) or not (`false`)."
+                              }
+                            }
+                          },
+                          "maxDimension": {
+                            "type": "object",
+                            "description": "Object containing attributes of maximum dimension permitted by the shipping policy (carrier).",
+                            "properties": {
+                              "largestMeasure": {
+                                "type": "number",
+                                "description": "Largest measure acceptable of the package."
+                              },
+                              "maxMeasureSum": {
+                                "type": "number",
+                                "description": "Limit for the sum of all maximum measures of the package."
+                              }
+                            }
+                          },
+                          "numberOfItemsPerShipment": {
+                            "type": "integer",
+                            "description": "Determines the number of items allowed per shipment."
+                          },
+                          "minimumValueAceptable": {
+                            "type": "number",
+                            "description": "Minimum value accepted by the carrier for delivering."
+                          },
+                          "maximumValueAceptable": {
+                            "type": "number",
+                            "description": "Maximum value accepted by the carrier for delivering."
+                          },
+                          "additionalTime": {
+                            "type": "string",
+                            "description": "Additional time configured in `HH:MM:SS` format.",
+                            "deprecated": true
+                          },
+                          "additionalPrice": {
+                            "type": "object",
+                            "description": "Additional price object.",
+                            "properties": {
+                              "method": {
+                                "type": "integer",
+                                "description": "Additional price method.",
+                                "deprecated": true
+                              },
+                              "value": {
+                                "type": "number",
+                                "description": "Payment value.",
+                                "deprecated": true
+                              }
+                            },
+                            "deprecated": true
+                          },
+                          "deliveryScheduleSettings": {
+                            "type": "object",
+                            "description": "[Scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) settings.",
+                            "properties": {
+                              "useDeliverySchedule": {
+                                "type": "boolean",
+                                "description": "Defines if the scheduled delivery configuration is active (`true`) or not (`false`)."
+                              },
+                              "maxRangeDelivery": {
+                                "type": "number",
+                                "description": "Range of days available within a delivery window, for the customer to choose the scheduled delivery. For example, if the configured `maxRangeDelivery` is equal `7`, and the customer buys something on a Tuesday, the options for scheduled delivery will be shown until the following Tuesday (7 days from the purchase day). If no options are available within the `maxRangeDelivery` set, the shipping policy will not be shown on the checkout."
+                              },
+                              "dayOfWeekForDelivery": {
+                                "type": "array",
+                                "description": "Selected days for delivery, from `0` (Sunday) to `6` (Saturday).",
+                                "items": {
+                                  "type": "object",
+                                  "description": "Selected days for delivery objects.",
+                                  "properties": {
+                                    "dayOfWeek": {
+                                      "type": "integer",
+                                      "description": "Day of the week, from `0` (Sunday) to `6` (Saturday)."
+                                    },
+                                    "deliveryRanges": {
+                                      "type": "array",
+                                      "description": "Reservation window for scheduled delivery.",
+                                      "items": {
+                                        "type": "object",
+                                        "description": "Reservation window for scheduled delivery object.",
+                                        "properties": {
+                                          "startTime": {
+                                            "type": "string",
+                                            "description": "Start time for day of the week in `hh:mm:ss` format."
+                                          },
+                                          "endTime": {
+                                            "type": "string",
+                                            "description": "End time for day of the week in `hh:mm:ss` format."
+                                          },
+                                          "listPrice": {
+                                            "type": "number",
+                                            "description": "List price for day of the week."
+                                          },
+                                          "deliveryCapacity": {
+                                            "type": "array",
+                                            "description": "Sets maximum [delivery capacity](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz) for a given reservation window for scheduled delivery.",
+                                            "nullable": true,
+                                            "items": {
+                                              "type": "object",
+                                              "description": "Object with the maximum delivery capacity for a reservation window.",
+                                              "properties": {
+                                                "capacityType": {
+                                                  "type": "string",
+                                                  "description": "Defines how the delivery capacity is measured for this reservation window, by maximum number of orders (`ORDERS_QUANTITY`) or items (`SKUS_QUANTITY`)."
+                                                },
+                                                "maxValue": {
+                                                  "type": "number",
+                                                  "description": "Maximum number of orders or SKUs that the store is capable of fulfilling."
+                                                }
+                                              }
+                                            }
+                                          }
+                                        }
+                                      }
+                                    }
+                                  }
+                                }
+                              },
+                              "dayOfWeekBlockeds": {
+                                "type": "array",
+                                "description": "Defines if there are any days of the week that are blocked.",
+                                "items": {
+                                  "type": "string",
+                                  "description": "Date and time of the blocked day in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss`."
+                                },
+                                "nullable": true,
+                                "deprecated": true
+                              }
+                            }
+                          },
+                          "carrierSchedule": {
+                            "type": "array",
+                            "description": "Schedule sent by the carrier to configure the shipping policy.",
+                            "items": {
+                              "type": "object",
+                              "description": "Carrier schedule for configuring the shipping policy object.",
+                              "properties": {
+                                "dayOfWeek": {
+                                  "type": "integer",
+                                  "description": "Day of the week from `0` (Sunday) to `6` (Saturday)."
+                                },
+                                "timeLimit": {
+                                  "type": "string",
+                                  "description": "Time limit in `HH:MM:SS` format."
+                                }
+                              }
+                            }
+                          },
+                          "cubicWeightSettings": {
+                            "type": "object",
+                            "description": "Settings for the cubic weight of a package, which accounts for the [package's volume](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128), and not only weight.",
+                            "properties": {
+                              "volumetricFactor": {
+                                "type": "number",
+                                "description": "Factor that will be used on the cubic weight calculation, usually given by the carrier."
+                              },
+                              "minimunAcceptableVolumetricWeight": {
+                                "type": "number",
+                                "description": "Packages' minimum acceptable [volumetric weight](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128)."
+                              }
+                            }
+                          },
+                          "modalSettings": {
+                            "type": "object",
+                            "description": "Configurations for the [modal](https://help.vtex.com/en/tutorial/how-does-the-modal-work--tutorials_125), which is the attachement of a specific product to a carrier specialized in delivering that type of product.",
+                            "properties": {
+                              "modals": {
+                                "type": "array",
+                                "description": "Type of special freight.",
+                                "items": {
+                                  "type": "string",
+                                  "enum": [
+                                    "CHEMICALS",
+                                    "ELECTRONICS",
+                                    "FURNITURE",
+                                    "GLASS",
+                                    "LIQUID",
+                                    "MATTRESSES",
+                                    "REFRIGERATED",
+                                    "TIRES",
+                                    "WHITE_GOODS",
+                                    "FIREARMS"
+                                  ],
+                                  "description": "Modal values assigned to the special freight."
+                                }
+                              },
+                              "useOnlyItemsWithDefinedModal": {
+                                "type": "boolean",
+                                "description": "When set as `true`, the modal's configurations will apply only for items with a defined modal, when `false`, the modal configuration will not be set."
+                              }
+                            }
+                          },
+                          "businessHourSettings": {
+                            "type": "object",
+                            "description": "Business hours configurations.",
+                            "properties": {
+                              "carrierBusinessHours": {
+                                "type": "array",
+                                "description": "Business hours configurations array for the days of the week.",
+                                "items": {
+                                  "type": "object",
+                                  "description": "Business hours configurations for a single day of the week.",
+                                  "properties": {
+                                    "openingTime": {
+                                      "type": "string",
+                                      "description": "Opening time in `HH:MM:SS` format."
+                                    },
+                                    "closingTime": {
+                                      "type": "string",
+                                      "description": "Closing time in `HH:MM:SS` format."
+                                    },
+                                    "dayOfWeek": {
+                                      "type": "integer",
+                                      "description": "Day of the week from `0` (Sunday) to `6` (Saturday).",
+                                      "enum": [
+                                        0,
+                                        1,
+                                        2,
+                                        3,
+                                        4,
+                                        5,
+                                        6
+                                      ]
+                                    }
+                                  }
+                                }
+                              },
+                              "isOpenOutsideBusinessHours": {
+                                "type": "boolean",
+                                "description": "Defines if deliveries outside business hours are allowed (`true`) or not (`false`)."
+                              }
+                            }
+                          },
+                          "pickupPointsSettings": {
+                            "type": "object",
+                            "description": "[Pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) configurations of the shipping policy.",
+                            "properties": {
+                              "pickupPointIds": {
+                                "type": "array",
+                                "description": "Pickup point IDs configured for the shipping policy.",
+                                "items": {
+                                  "type": "string",
+                                  "description": "Pickup point ID."
+                                }
+                              },
+                              "pickupPointTags": {
+                                "type": "array",
+                                "description": "Pickup points tags configured for the shipping policy.",
+                                "items": {
+                                  "type": "string",
+                                  "description": "Tag identification."
+                                }
+                              },
+                              "sellers": {
+                                "type": "array",
+                                "description": "Sellers associated with [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) related to the shipping policy.",
+                                "items": {
+                                  "type": "string",
+                                  "description": "Sellers IDS."
+                                }
+                              }
+                            }
+                          },
+                          "processingStatus": {
+                            "type": "object",
+                            "description": "Shipping policy processing status.",
+                            "properties": {
+                              "status": {
+                                "type": "integer",
+                                "format": "int32",
+                                "description": "Shipping policy processing status code."
+                              },
+                              "errorMessage": {
+                                "type": "string",
+                                "description": "Error message, when applicable.",
+                                "nullable": true
+                              },
+                              "errorsMetadata": {
+                                "type": "string",
+                                "description": "Error metadata, when applicable.",
+                                "nullable": true
+                              }
+                            }
+                          },
+                          "deliveryChannel": {
+                            "type": "string",
+                            "description": "Defines if the shipping type is `delivery` or `pickup`."
+                          },
+                          "calculationType": {
+                            "type": "integer",
+                            "description": "Shipping policy calculation type."
+                          },
+                          "isActive": {
+                            "type": "boolean",
+                            "description": "Defines if the shipping policy is active (`true`) or not (`false`)."
+                          },
+                          "lastIndexedAt": {
+                            "type": "string",
+                            "description": "Date and time since the last [indexing](https://help.vtex.com/en/tutorial/understanding-how-indexation-works--tutorials_256), in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DD hh:mm:ss[.nnnnnnn]+hh:mm`.",
+                            "nullable": true
+                          },
+                          "shippingHoursSettings": {
+                            "type": "object",
+                            "description": "Shipping hours settings configurations.",
+                            "properties": {
+                              "shippingHours": {
+                                "type": "array",
+                                "description": "Shipping hours settings array.",
+                                "items": {
+                                  "type": "object",
+                                  "description": "Object with details on shipping hours settings.",
+                                  "properties": {
+                                    "dayOfWeek": {
+                                      "type": "integer",
+                                      "description": "Day of the week from `0` (Sunday) to `6` (Saturday)."
+                                    },
+                                    "openingTime": {
+                                      "type": "string",
+                                      "description": "Opening time in `hh:mm:ss` format."
+                                    },
+                                    "closingTime": {
+                                      "type": "string",
+                                      "description": "Closing time in `hh:mm:ss` format."
+                                    }
+                                  }
+                                }
+                              },
+                              "acceptOrdersOutsideShippingHours": {
+                                "type": "boolean",
+                                "description": "Defines if the configuration that allows accepting orders outside shipping hours is active (`true`) or not (`false`)."
+                              }
+                            }
+                          },
+                          "carrierInfo": {
+                            "type": "object",
+                            "description": "[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) information.",
+                            "properties": {
+                              "carrierAccountName": {
+                                "type": "string",
+                                "description": "VTEX store account name related to the shipping policy."
+                              },
+                              "deliveryAgreementId": {
+                                "type": "string",
+                                "description": "Delivery agreement ID.",
+                                "nullable": true
+                              },
+                              "linkedDocks": {
+                                "type": "array",
+                                "description": "Shipping policy [loading docks](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) valid for the carrier.",
+                                "items": {
+                                  "type": "object",
+                                  "description": "Loading dock object.",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "Loading dock ID."
+                                    },
+                                    "name": {
+                                      "type": "string",
+                                      "description": "Loading dock name."
+                                    }
+                                  }
+                                }
+                              },
+                              "readyToUse": {
+                                "type": "boolean",
+                                "description": "Defines if shipping configurations related to the carrier make them ready for shipping (`true`) or not (`false`)."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "paging": {
+                      "type": "object",
+                      "description": "Pagination information.",
+                      "properties": {
+                        "page": {
+                          "type": "integer",
+                          "description": "Number of the current page of the response. By default, it returns page `1`."
+                        },
+                        "perPage": {
+                          "type": "integer",
+                          "description": "Number of shipping policies per page."
+                        },
+                        "total": {
+                          "type": "integer",
+                          "description": "Total number of existing shipping policies."
+                        },
+                        "pages": {
+                          "type": "integer",
+                          "description": "Total number of pages, considering all shipping policies."
+                        }
+                      }
+                    }
+                  }
+                },
+                "example": {
+                  "items": [
+                    {
+                      "id": "store-sp-01",
+                      "name": "store-sp-01",
+                      "shippingMethod": "normal delivery",
+                      "weekendAndHolidays": {
+                        "saturday": true,
+                        "sunday": true,
+                        "holiday": true
+                      },
+                      "maxDimension": {
+                        "largestMeasure": 0,
+                        "maxMeasureSum": 1100
+                      },
+                      "numberOfItemsPerShipment": 1,
+                      "minimumValueAceptable": 0,
+                      "maximumValueAceptable": 0,
+                      "additionalTime": "00:00:00",
+                      "additionalPrice": {
+                        "method": 0,
+                        "value": 0
+                      },
+                      "deliveryScheduleSettings": {
+                        "useDeliverySchedule": true,
+                        "dayOfWeekForDelivery": [
+                          {
+                            "dayOfWeek": 1,
+                            "deliveryRanges": [
+                              {
+                                "startTime": "00:00:00",
+                                "endTime": "23:59:59",
+                                "listPrice": 0,
+                                "deliveryCapacity": null
+                              }
+                            ]
+                          },
+                          {
+                            "dayOfWeek": 2,
+                            "deliveryRanges": [
+                              {
+                                "startTime": "00:00:00",
+                                "endTime": "23:59:59",
+                                "listPrice": 0,
+                                "deliveryCapacity": null
+                              }
+                            ]
+                          },
+                          {
+                            "dayOfWeek": 3,
+                            "deliveryRanges": [
+                              {
+                                "startTime": "00:00:00",
+                                "endTime": "23:59:59",
+                                "listPrice": 0,
+                                "deliveryCapacity": null
+                              }
+                            ]
+                          },
+                          {
+                            "dayOfWeek": 4,
+                            "deliveryRanges": [
+                              {
+                                "startTime": "00:00:00",
+                                "endTime": "23:59:59",
+                                "listPrice": 0,
+                                "deliveryCapacity": null
+                              }
+                            ]
+                          },
+                          {
+                            "dayOfWeek": 5,
+                            "deliveryRanges": [
+                              {
+                                "startTime": "00:00:00",
+                                "endTime": "23:59:59",
+                                "listPrice": 0,
+                                "deliveryCapacity": null
+                              }
+                            ]
+                          },
+                          {
+                            "dayOfWeek": 6,
+                            "deliveryRanges": [
+                              {
+                                "startTime": "00:00:00",
+                                "endTime": "23:59:59",
+                                "listPrice": 0,
+                                "deliveryCapacity": null
+                              }
+                            ]
+                          },
+                          {
+                            "dayOfWeek": 0,
+                            "deliveryRanges": [
+                              {
+                                "startTime": "00:00:00",
+                                "endTime": "23:59:59",
+                                "listPrice": 0,
+                                "deliveryCapacity": null
+                              }
+                            ]
+                          }
+                        ],
+                        "maxRangeDelivery": 1,
+                        "dayOfWeekBlockeds": [
+                          "2024-02-13T09:00:00",
+                          "2024-06-09T09:00:00"
+                        ]
+                      },
+                      "carrierSchedule": [
+                        {
+                          "dayOfWeek": 0,
+                          "timeLimit": "time_limit"
+                        }
+                      ],
+                      "cubicWeightSettings": {
+                        "volumetricFactor": 0.2,
+                        "minimunAcceptableVolumetricWeight": 0
+                      },
+                      "modalSettings": {
+                        "modals": [
+                          "LIQUID"
+                        ],
+                        "useOnlyItemsWithDefinedModal": false
+                      },
+                      "businessHourSettings": {
+                        "carrierBusinessHours": [
+                          {
+                            "dayOfWeek": 1,
+                            "openingTime": "00:00:00",
+                            "closingTime": "23:59:59"
+                          },
+                          {
+                            "dayOfWeek": 2,
+                            "openingTime": "00:00:00",
+                            "closingTime": "23:59:59"
+                          },
+                          {
+                            "dayOfWeek": 3,
+                            "openingTime": "00:00:00",
+                            "closingTime": "23:59:59"
+                          },
+                          {
+                            "dayOfWeek": 4,
+                            "openingTime": "00:00:00",
+                            "closingTime": "23:59:59"
+                          },
+                          {
+                            "dayOfWeek": 5,
+                            "openingTime": "00:00:00",
+                            "closingTime": "23:59:59"
+                          },
+                          {
+                            "dayOfWeek": 6,
+                            "openingTime": "00:00:00",
+                            "closingTime": "23:59:59"
+                          },
+                          {
+                            "dayOfWeek": 0,
+                            "openingTime": "00:00:00",
+                            "closingTime": "23:59:59"
+                          }
+                        ],
+                        "isOpenOutsideBusinessHours": true
+                      },
+                      "pickupPointsSettings": {
+                        "pickupPointIds": [
+                          "Id1",
+                          "Id2"
+                        ],
+                        "pickupPointTags": [
+                          "Tag1",
+                          "Tag2"
+                        ],
+                        "sellers": [
+                          "Seller1"
+                        ]
+                      },
+                      "processingStatus": {
+                        "status": 1,
+                        "errorMessage": null,
+                        "errorsMetadata": null
+                      },
+                      "deliveryChannel": "delivery",
+                      "calculationType": 0,
+                      "isActive": true,
+                      "lastIndexedAt": "2024-05-30T14:13:34.158121+00:00",
+                      "shippingHoursSettings": {
+                        "shippingHours": [
+                          {
+                            "dayOfWeek": 1,
+                            "openingTime": "00:00:00",
+                            "closingTime": "23:59:59"
+                          },
+                          {
+                            "dayOfWeek": 2,
+                            "openingTime": "00:00:00",
+                            "closingTime": "23:59:59"
+                          },
+                          {
+                            "dayOfWeek": 3,
+                            "openingTime": "00:00:00",
+                            "closingTime": "23:59:59"
+                          },
+                          {
+                            "dayOfWeek": 4,
+                            "openingTime": "00:00:00",
+                            "closingTime": "23:59:59"
+                          },
+                          {
+                            "dayOfWeek": 5,
+                            "openingTime": "00:00:00",
+                            "closingTime": "23:59:59"
+                          },
+                          {
+                            "dayOfWeek": 6,
+                            "openingTime": "00:00:00",
+                            "closingTime": "23:59:59"
+                          },
+                          {
+                            "dayOfWeek": 0,
+                            "openingTime": "00:00:00",
+                            "closingTime": "23:59:59"
+                          }
+                        ],
+                        "acceptOrdersOutsideShippingHours": true
+                      },
+                      "carrierInfo": {
+                        "carrierAccountName": "vtexcorreios",
+                        "deliveryAgreementId": "d91dee11-6afb-4835-99bc-5r671a578076",
+                        "linkedDocks": [
+                          {
+                            "id": "2656",
+                            "name": "CORREIOS 2656"
+                          }
+                        ],
+                        "readyToUse": true
+                      }
+                    }
+                  ],
+                  "paging": {
+                    "page": 1,
+                    "perPage": 15,
+                    "total": 43,
+                    "pages": 3
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
+      "post": {
+        "tags": [
+          "Shipping policies"
+        ],
+        "summary": "Create shipping policy",
+        "description": "Configure a new [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) for your store. \r\n\r\n>⚠️ While most endpoints return time fields in UTC format, this endpoint returns **Scheduled Delivery** related time fields adjusted to the time zone configured for the VTEX account. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "parameters": [
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        },
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "required": [
+                  "id",
+                  "name",
+                  "shippingMethod",
+                  "weekendAndHolidays",
+                  "maxDimension",
+                  "numberOfItemsPerShipment",
+                  "minimumValueAceptable",
+                  "maximumValueAceptable",
+                  "deliveryScheduleSettings",
+                  "cubicWeightSettings",
+                  "modalSettings",
+                  "businessHourSettings",
+                  "pickupPointsSettings",
+                  "isActive"
+                ],
+                "properties": {
+                  "id": {
+                    "type": "string",
+                    "description": "ID of the shipping policy.",
+                    "example": "123"
+                  },
+                  "name": {
+                    "type": "string",
+                    "description": "Name of the shipping policy.",
+                    "example": "Normal"
+                  },
+                  "shippingMethod": {
+                    "type": "string",
+                    "description": "Type of shipping available for this shipping policy (carrier). Options shown on freight simulation.",
+                    "example": "Normal"
+                  },
+                  "weekendAndHolidays": {
+                    "type": "object",
+                    "description": "If the shipping policy includes deliveries on weekends and holidays.",
+                    "example": {
+                      "saturday": false,
+                      "sunday": false,
+                      "holiday": false
+                    },
+                    "required": [
+                      "saturday",
+                      "sunday",
+                      "holiday"
+                    ],
+                    "properties": {
+                      "saturday": {
+                        "type": "boolean",
+                        "description": "Defines if the shipping policy allows deliveries on Saturdays (`true`), or not (`false`).",
+                        "example": false
+                      },
+                      "sunday": {
+                        "type": "boolean",
+                        "description": "Defines if the shipping policy allows deliveries on Sundays (`true`), or not (`false`).",
+                        "example": false
+                      },
+                      "holiday": {
+                        "type": "boolean",
+                        "description": "Defines if the shipping policy allows deliveries on holidays (`true`), or not (`false`).",
+                        "example": false
+                      }
+                    }
+                  },
+                  "maxDimension": {
+                    "type": "object",
+                    "description": "Object containing attributes of maximum dimension permitted by the shipping policy (carrier).",
+                    "example": {
+                      "largestMeasure": 15,
+                      "maxMeasureSum": 25
+                    },
+                    "required": [
+                      "largestMeasure",
+                      "maxMeasureSum"
+                    ],
+                    "properties": {
+                      "largestMeasure": {
+                        "type": "number",
+                        "description": "Largest measure of the package.",
+                        "example": 0
+                      },
+                      "maxMeasureSum": {
+                        "type": "number",
+                        "description": "Sum of all maximum measures of the package.",
+                        "example": 0
+                      }
+                    }
+                  },
+                  "numberOfItemsPerShipment": {
+                    "type": "integer",
+                    "description": "Capacity of your store's logistics of shipment, determines number of items permitted per shipment.",
+                    "example": 5
+                  },
+                  "minimumValueAceptable": {
+                    "type": "number",
+                    "description": "Minimum value accepted by the carrier, to realize the shipping.",
+                    "example": 0
+                  },
+                  "maximumValueAceptable": {
+                    "type": "number",
+                    "description": "Maximum value accepted by the carrier, to realize the shipping.",
+                    "example": 0
+                  },
+                  "deliveryScheduleSettings": {
+                    "type": "object",
+                    "description": "Settings for the Scheduled Delivery feature.",
+                    "required": [
+                      "useDeliverySchedule",
+                      "dayOfWeekForDelivery",
+                      "maxRangeDelivery"
+                    ],
+                    "properties": {
+                      "useDeliverySchedule": {
+                        "type": "boolean",
+                        "description": "Select the Scheduled Delivery configuration.",
+                        "example": true
+                      },
+                      "maxRangeDelivery": {
+                        "type": "number",
+                        "description": "Range of days available within a delivery window, for the customer to choose the scheduled delivery. For example, if the configured maxRangeDelivery is equal 7, and the customer buys something on a Tuesday, the options for scheduled delivery will be shown until the following Tuesday (7 days from the purchase day). If no options are available within the maxRangeDelivery set, this shipping policy won't be shown on the checkout.",
+                        "example": 0
+                      },
+                      "dayOfWeekForDelivery": {
+                        "type": "array",
+                        "description": "Select the chosen days for delivery. Values for each day of the week are: `0` = Sunday, `1` = Monday, `2` = Tuesday, `3` = Wednesday, `4` = Thursday, `5` = Friday, `6` = Saturday. Make sure to add the available hours for the chosen days, following the example.",
+                        "items": {
+                          "type": "object",
+                          "description": "Day of the week for delivery object.",
+                          "required": [
+                            "dayOfWeek",
+                            "deliveryRanges"
+                          ],
+                          "properties": {
+                            "dayOfWeek": {
+                              "type": "integer",
+                              "description": "Day of the week, from `0` (sunday) to `6` (saturday).",
+                              "example": 2
+                            },
+                            "deliveryRanges": {
+                              "type": "array",
+                              "description": "Reservation windows for scheduled delivery.",
+                              "items": {
+                                "type": "object",
+                                "description": "Delivery ranges object.",
+                                "required": [
+                                  "startTime",
+                                  "endTime",
+                                  "listPrice"
+                                ],
+                                "properties": {
+                                  "startTime": {
+                                    "type": "string",
+                                    "description": "Start time for day of the week.",
+                                    "example": "11:00:00"
+                                  },
+                                  "endTime": {
+                                    "type": "string",
+                                    "description": "End time for day of the week.",
+                                    "example": "12:30:00"
+                                  },
+                                  "listPrice": {
+                                    "type": "number",
+                                    "description": "List price for day of the week.",
+                                    "example": 0
+                                  },
+                                  "deliveryCapacity": {
+                                    "type": "array",
+                                    "description": "Sets maximum delivery capacity for a given reservation window for scheduled delivery.",
+                                    "items": {
+                                      "type": "object",
+                                      "description": "Delivery capacity object.",
+                                      "required": [
+                                        "capacityType",
+                                        "maxValue"
+                                      ],
+                                      "properties": {
+                                        "capacityType": {
+                                          "type": "string",
+                                          "description": "Defines how the delivery capacity is measured for this reservation window, by maximum number of orders (`\"ORDERS_QUANTITY\"`) or SKUs (`\"SKUS_QUANTITY\"`).",
+                                          "example": "ORDERS_QUANTITY"
+                                        },
+                                        "maxValue": {
+                                          "type": "number",
+                                          "description": "Maximum number of orders or SKUs that the store is capable of fulfilling.",
+                                          "example": 55
+                                        }
+                                      }
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    }
+                  },
+                  "carrierSchedule": {
+                    "type": "array",
+                    "description": "Schedule sent by the carrier to configure the shipping policy.",
+                    "items": {
+                      "type": "object",
+                      "description": "Carrier schedule object.",
+                      "properties": {
+                        "dayOfWeek": {
+                          "type": "integer",
+                          "description": "Day of the week, from `0` (sunday) to `6` (saturday).",
+                          "example": 0
+                        },
+                        "timeLimit": {
+                          "type": "string",
+                          "description": "Time limit.",
+                          "example": "time_limit"
+                        }
+                      }
+                    }
+                  },
+                  "cubicWeightSettings": {
+                    "type": "object",
+                    "description": "Measure including the [package's volume](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128), and not only weight.",
+                    "required": [
+                      "volumetricFactor",
+                      "minimunAcceptableVolumetricWeight"
+                    ],
+                    "properties": {
+                      "volumetricFactor": {
+                        "type": "number",
+                        "description": "Factor that will be used on the cubic weight calculation.",
+                        "example": 3
+                      },
+                      "minimunAcceptableVolumetricWeight": {
+                        "type": "number",
+                        "description": "Packages' minimum acceptable [volumetric weight](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128).",
+                        "example": 5
+                      }
+                    }
+                  },
+                  "modalSettings": {
+                    "type": "object",
+                    "description": "Configurations for the [modal](https://help.vtex.com/en/tutorial/how-does-the-modal-work--tutorials_125), which is the attachement of a specific product to a carrier specialized in delivering that type of product.",
+                    "required": [
+                      "modals",
+                      "useOnlyItemsWithDefinedModal"
+                    ],
+                    "properties": {
+                      "modals": {
+                        "type": "array",
+                        "description": "Type of special freight.",
+                        "items": {
+                          "type": "string",
+                          "enum": [
+                            "CHEMICALS",
+                            "ELECTRONICS",
+                            "FURNITURE",
+                            "GLASS",
+                            "LIQUID",
+                            "MATTRESSES",
+                            "REFRIGERATED",
+                            "TIRES",
+                            "WHITE_GOODS",
+                            "FIREARMS"
+                          ],
+                          "description": "Modal values assigned to the special freight.",
+                          "example": "ELECTRONICS"
+                        }
+                      },
+                      "useOnlyItemsWithDefinedModal": {
+                        "type": "boolean",
+                        "description": "Defines if the modal's configurations will apply only for items with a defined modal (`true`) or not (`false`).",
+                        "example": false
+                      }
+                    }
+                  },
+                  "businessHourSettings": {
+                    "type": "object",
+                    "description": "Business hours configurations.",
+                    "required": [
+                      "carrierBusinessHours",
+                      "isOpenOutsideBusinessHours"
+                    ],
+                    "properties": {
+                      "carrierBusinessHours": {
+                        "type": "array",
+                        "description": "Carrier business hours configurations for the week.",
+                        "items": {
+                          "type": "object",
+                          "description": "Carrier business hours configurations for a day of the week.",
+                          "required": [
+                            "openingTime",
+                            "closingTime",
+                            "dayOfWeek"
+                          ],
+                          "properties": {
+                            "openingTime": {
+                              "type": "string",
+                              "description": "Opening time.",
+                              "example": "00:00:00"
+                            },
+                            "closingTime": {
+                              "type": "string",
+                              "description": "Closing time.",
+                              "example": "23:59:59"
+                            },
+                            "dayOfWeek": {
+                              "type": "integer",
+                              "description": "Day of the week, from `0` (Sunday) to `6` (Saturday).",
+                              "example": 1
+                            }
+                          }
+                        }
+                      },
+                      "isOpenOutsideBusinessHours": {
+                        "type": "boolean",
+                        "description": "Select whether the shipping policy allows deliveries outside business hours (`true`) or not (`false`).",
+                        "example": true
+                      }
+                    }
+                  },
+                  "pickupPointsSettings": {
+                    "type": "object",
+                    "description": "Configuration for Pickup Points.",
+                    "nullable": true,
+                    "required": [
+                      "pickupPointIds",
+                      "pickupPointTags",
+                      "sellers"
+                    ],
+                    "properties": {
+                      "pickupPointIds": {
+                        "type": "array",
+                        "description": "Insert the IDs for pickup points previously configured in your store.",
+                        "items": {
+                          "type": "string",
+                          "description": "Pickup point IDs.",
+                          "example": "Id1"
+                        }
+                      },
+                      "pickupPointTags": {
+                        "type": "array",
+                        "description": "Insert the tags for pickup points previously configured in your store.",
+                        "example": [
+                          "Tag1",
+                          "Tag2"
+                        ],
+                        "items": {
+                          "type": "string",
+                          "description": "Tag IDs.",
+                          "example": "Tag1"
+                        }
+                      },
+                      "sellers": {
+                        "type": "array",
+                        "description": "Sellers that will be associated with the [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) of the shipping policy being created.",
+                        "items": {
+                          "type": "string",
+                          "description": "Seller names.",
+                          "example": "Seller1"
+                        }
+                      }
+                    }
+                  },
+                  "isActive": {
+                    "type": "boolean",
+                    "description": "Defines if the shipping policy is active (`true`) or not (`false`).",
+                    "example": false
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/configuration/freights/{carrierId}/values/update": {
+      "post": {
+        "tags": [
+          "Freight values"
+        ],
+        "summary": "Create or update freight values",
+        "description": "Creates or updates freight values for your store's carriers. Learn more in [Shipping rate template](https://help.vtex.com/en/tutorial/shipping-rate-template--tutorials_127).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "Create/UpdateFreightValues",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "carrierId",
+            "in": "path",
+            "description": "Carrier ID.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "carrier123"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "array",
+                "description": "Array of objects, each containing information on a specific freight interval.",
+                "items": {
+                  "required": [
+                    "absoluteMoneyCost",
+                    "country",
+                    "maxVolume",
+                    "operationType",
+                    "pricePercent",
+                    "pricePercentByWeight",
+                    "timeCost",
+                    "weightEnd",
+                    "weightStart",
+                    "zipCodeEnd",
+                    "zipCodeStart",
+                    "polygon"
+                  ],
+                  "type": "object",
+                  "description": "Freight interval object.",
+                  "properties": {
+                    "absoluteMoneyCost": {
+                      "type": "string",
+                      "description": "Fixed shipping cost to be charged in a decimal number.",
+                      "example": "1.00"
+                    },
+                    "country": {
+                      "type": "string",
+                      "description": "Three letter ISO code for the country where the delivery will take place.",
+                      "example": "BRA"
+                    },
+                    "maxVolume": {
+                      "type": "integer",
+                      "description": "Maximum volume that can be transported by the carrier in cm³.",
+                      "example": 1000000000
+                    },
+                    "operationType": {
+                      "type": "integer",
+                      "description": "Indicates desired action for the object. Possible values are `1` (Insert), `2` (Update) or `3`(Delete).",
+                      "example": 1
+                    },
+                    "pricePercent": {
+                      "type": "integer",
+                      "description": "[Price-based additional shipping charge](https://help.vtex.com/en/tutorial/additional-shipping-costs--2vqGwMn0LabkOHY6zSHYNV), calculated based on the total price of the order, in decimal number. You must fill in this field with a percentage value. For example, for an additional charge of 10%, fill in the table with 10.",
+                      "example": 10
+                    },
+                    "pricePercentByWeight": {
+                      "type": "integer",
+                      "description": "[Weight-based additional shipping charge](https://help.vtex.com/en/tutorial/additional-shipping-costs--2vqGwMn0LabkOHY6zSHYNV), calculated based on the total weight of the order.",
+                      "example": 0
+                    },
+                    "timeCost": {
+                      "type": "string",
+                      "description": "Delivery time frame informed by the carrier, in the format `DD.HH:MM:SS`.",
+                      "example": "2.00:00:00"
+                    },
+                    "weightEnd": {
+                      "type": "integer",
+                      "description": "Maximum weight allowed.",
+                      "example": 1000
+                    },
+                    "weightStart": {
+                      "type": "integer",
+                      "description": "Minimum weight allowed.",
+                      "example": 1
+                    },
+                    "zipCodeEnd": {
+                      "type": "string",
+                      "description": "End of postal code interval.",
+                      "example": "1234500"
+                    },
+                    "zipCodeStart": {
+                      "type": "string",
+                      "description": "Start of postal code interval.",
+                      "example": "1000000"
+                    },
+                    "polygon": {
+                      "type": "string",
+                      "description": "Polygon ID, according to the [geolocation](https://help.vtex.com/en/tutorial/registering-geolocation/) feature.",
+                      "example": "polygon2"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/configuration/freights/{carrierId}/{cep}/values": {
+      "get": {
+        "tags": [
+          "Freight values"
+        ],
+        "summary": "List freight values",
+        "description": "Lists freight values appointed to your store's carriers, searching by carrier ID and postal code (`cep`). The information is retrieved from your [shipping rate template](https://help.vtex.com/en/tutorial/shipping-rate-template--tutorials_127) configurations.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "FreightValues",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "carrierId",
+            "in": "path",
+            "description": "Carrier ID.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "carrier-123"
+            }
+          },
+          {
+            "name": "cep",
+            "in": "path",
+            "description": "Postal code of the area in which you wish to retrieve freight values for a given carrier, according to your [shipping rate template](https://help.vtex.com/en/tutorial/shipping-rate-template--tutorials_127) configurations.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "12345000"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "description": "List of freight values.",
+                  "items": {
+                    "required": [
+                      "zipCodeStart",
+                      "zipCodeEnd",
+                      "weightStart",
+                      "weightEnd",
+                      "absoluteMoneyCost",
+                      "pricePercent",
+                      "pricePercentByWeight",
+                      "maxVolume",
+                      "timeCost",
+                      "country",
+                      "operationType",
+                      "restrictedFreights",
+                      "polygon",
+                      "minimumValueInsurance"
+                    ],
+                    "type": "object",
+                    "description": "Freight values object.",
+                    "properties": {
+                      "zipCodeStart": {
+                        "type": "string",
+                        "description": "Postal code interval starting point."
+                      },
+                      "zipCodeEnd": {
+                        "type": "string",
+                        "description": "Postal code interval ending point."
+                      },
+                      "weightStart": {
+                        "type": "number",
+                        "description": "Minimum weight allowed."
+                      },
+                      "weightEnd": {
+                        "type": "number",
+                        "description": "Maximum weight allowed."
+                      },
+                      "absoluteMoneyCost": {
+                        "type": "number",
+                        "description": "Fixed shipping cost to be charged, in a decimal number."
+                      },
+                      "pricePercent": {
+                        "type": "number",
+                        "description": "[Price-based additional shipping charge](https://help.vtex.com/en/tutorial/additional-shipping-costs--2vqGwMn0LabkOHY6zSHYNV), calculated based on the total price of the order, in decimal number. You must fill in this field with a percentage value. For example, for an additional charge of 10%, fill in the table with `10`."
+                      },
+                      "pricePercentByWeight": {
+                        "type": "number",
+                        "description": "[Weight-based additional shipping charge](https://help.vtex.com/en/tutorial/additional-shipping-costs--2vqGwMn0LabkOHY6zSHYNV), calculated based on the total weight of the order."
+                      },
+                      "maxVolume": {
+                        "type": "number",
+                        "description": "Maximum volume that can be transported by the carrier in cm³."
+                      },
+                      "timeCost": {
+                        "type": "string",
+                        "description": "Delivery time frame informed by the carrier, in the format `DD.HH:MM:SS`."
+                      },
+                      "country": {
+                        "type": "string",
+                        "description": "Three letter ISO code for the country for the given postal code."
+                      },
+                      "operationType": {
+                        "type": "integer",
+                        "description": "Indicates the operation type, which can be `1` (Insert), `2` (Update) or `3`(Delete)."
+                      },
+                      "restrictedFreights": {
+                        "type": "array",
+                        "items": {
+                          "type": "string",
+                          "description": "Restricted freight postal codes."
+                        },
+                        "description": "List of postal codes where the delivery is restricted for the given carrier.",
+                        "nullable": true
+                      },
+                      "polygon": {
+                        "type": "string",
+                        "description": "Polygon ID, according to the [geolocation](https://help.vtex.com/en/tutorial/registering-geolocation/) feature."
+                      },
+                      "minimumValueInsurance": {
+                        "type": "number",
+                        "description": "Insurance minimum value."
+                      }
+                    }
+                  }
+                },
+                "example": [
+                  {
+                    "zipCodeStart": "01000001",
+                    "zipCodeEnd": "05999999",
+                    "weightStart": 250.001,
+                    "weightEnd": 300,
+                    "absoluteMoneyCost": 329.9,
+                    "pricePercent": 0,
+                    "pricePercentByWeight": 0,
+                    "maxVolume": 100000000,
+                    "timeCost": "2.00:00:00",
+                    "country": "BRA",
+                    "operationType": 0,
+                    "restrictedFreights": [
+                      "01056051"
+                    ],
+                    "polygon": "central_RJ",
+                    "minimumValueInsurance": 0
+                  },
+                  {
+                    "zipCodeStart": "01230020",
+                    "zipCodeEnd": "06959949",
+                    "weightStart": 1001.001,
+                    "weightEnd": 10000,
+                    "absoluteMoneyCost": 15,
+                    "pricePercent": 0,
+                    "pricePercentByWeight": 0,
+                    "maxVolume": 900000000,
+                    "timeCost": "1.00:00:00",
+                    "country": "BRA",
+                    "operationType": 0,
+                    "restrictedFreights": [],
+                    "polygon": "zone_RJ",
+                    "minimumValueInsurance": 0
+                  }
+                ]
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/configuration/carriers/{carrierId}/getdayofweekblocked": {
+      "get": {
+        "tags": [
+          "Scheduled delivery"
+        ],
+        "summary": "Retrieve blocked delivery windows",
+        "description": "Lists all blocked delivery windows of your store's shipping policies, searching by carrier ID.\n\r\n\r>⚠️ While most of our API endpoints return time fields in UTC format, this endpoint returns **Scheduled Delivery** related time fields adjusted to the configured time zone of the account.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "RetrieveBlockedDeliveryWindows",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "carrierId",
+            "in": "path",
+            "description": "[Shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) ID (carrier ID).",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "carrier-123"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "description": "List of blocked delivery windows date and time.",
+                  "items": {
+                    "type": "string",
+                    "description": "Blocked delivery windows date and time in the format `YYYY-MM-DDTHH:MM:SS`. The time zone is set according to the store account."
+                  }
+                },
+                "example": [
+                  "2024-12-09T08:00:00",
+                  "2025-12-09T08:00:00"
+                ]
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/configuration/carriers/{carrierId}/adddayofweekblocked": {
+      "post": {
+        "tags": [
+          "Scheduled delivery"
+        ],
+        "summary": "Add blocked delivery windows",
+        "description": "Adds blocked delivery windows for your store's shipping policies.\n\r\n\r>⚠️ While most of our API endpoints return time fields in UTC format, this endpoint returns time adjusted to the configured time zone of the account.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "AddBlockedDeliveryWindows",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "carrierId",
+            "in": "path",
+            "description": "[Shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) ID (carrier ID).",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "carrier-123"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "string",
+                "description": "Delivery window block starting date and time in the format `YYYY-MM-DDTHH:MM:SS`. The time zone is set according to the store account. Requests with incorrect values will be disconsidered by the system (for example, a date in the past), regardless of a successful response.",
+                "example": "2025-12-09T08:00:00"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "boolean",
+                  "description": "Successful requests return the message `true`."
+                },
+                "example": true
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/configuration/carriers/{carrierId}/removedayofweekblocked": {
+      "post": {
+        "tags": [
+          "Scheduled delivery"
+        ],
+        "summary": "Remove blocked delivery windows",
+        "description": "Removes blocked delivery windows configured for a shipping policy of your [shipping strategy](https://help.vtex.com/en/tutorial/shipping-strategy--58vLBDbjYVQzJ6rRc5QNz3).\n\r\n\r>⚠️ While most of our endpoints return time values in UTC format, this endpoint returns time adjusted to the time zone set for the account.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "RemoveBlockedDeliveryWindows",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "carrierId",
+            "in": "path",
+            "description": "[Shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) ID (carrier ID).",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "carrier-123"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "string",
+                "description": "Date and time of the delivery window block being removed, in the format `YYYY-MM-DDTHH:MM:SS`. The time zone is set according to the store account.",
+                "example": "2024-12-09T08:00:00"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "boolean",
+                  "description": "Successful requests return the message `true`."
+                },
+                "example": true
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/configuration/docks": {
+      "post": {
+        "tags": [
+          "Docks"
+        ],
+        "summary": "Create or update dock",
+        "description": "Creates a new [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) or updates an existing one for your store's [shipping strategy](https://help.vtex.com/en/tutorial/shipping-strategy--58vLBDbjYVQzJ6rRc5QNz3).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "Create/UpdateDock",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "required": [
+                  "id",
+                  "name",
+                  "priority",
+                  "dockTimeFake",
+                  "timeFakeOverhead",
+                  "salesChannels",
+                  "salesChannel",
+                  "freightTableIds",
+                  "wmsEndPoint",
+                  "address"
+                ],
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string",
+                    "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.",
+                    "example": "1a8bce3"
+                  },
+                  "name": {
+                    "type": "string",
+                    "description": "Loading dock name.",
+                    "example": "Catete dock_3"
+                  },
+                  "priority": {
+                    "type": "integer",
+                    "description": "Value used as a tie-breaking rule when selecting a loading dock.",
+                    "example": 0
+                  },
+                  "dockTimeFake": {
+                    "type": "string",
+                    "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) processing time in the format `D.HH:MM:SS`. When not configured, it returns `00:00:00`.",
+                    "example": "00:00:00"
+                  },
+                  "timeFakeOverhead": {
+                    "type": "string",
+                    "description": "Time frame used to choose a loading dock when there is more than one loading dock with the same processing time. The lower the value entered in this field, the greater the possibility of the loading dock being chosen. \r\n>ℹ️ This field is not considered when calculating the delivery time.",
+                    "example": "00:00:00"
+                  },
+                  "salesChannels": {
+                    "type": "array",
+                    "items": {
+                      "type": "string",
+                      "description": "Sales channel (trade policy) numbers.",
+                      "example": "3"
+                    },
+                    "description": "Sales channels ([trade policies](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) to associate with the loading dock."
+                  },
+                  "salesChannel": {
+                    "type": "string",
+                    "description": "Main sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) to associate with the loading dock.",
+                    "example": "1"
+                  },
+                  "freightTableIds": {
+                    "type": "array",
+                    "description": "List with freight table IDs.",
+                    "items": {
+                      "type": "string",
+                      "description": "Freight table IDs.",
+                      "example": "11cc4b6"
+                    }
+                  },
+                  "wmsEndPoint": {
+                    "type": "string",
+                    "description": "Warehouse Management System (WMS) fulfillment endpoint.",
+                    "example": null,
+                    "nullable": true
+                  },
+                  "address": {
+                    "type": "object",
+                    "description": "Dock address object.",
+                    "required": [
+                      "postalCode",
+                      "country",
+                      "city",
+                      "state",
+                      "neighborhood",
+                      "street",
+                      "number",
+                      "complement",
+                      "coordinates"
+                    ],
+                    "properties": {
+                      "postalCode": {
+                        "type": "string",
+                        "description": "Dock address postal code.",
+                        "example": "02220070"
+                      },
+                      "country": {
+                        "required": [
+                          "acronym",
+                          "name"
+                        ],
+                        "type": "object",
+                        "description": "Dock address country object.",
+                        "properties": {
+                          "acronym": {
+                            "type": "string",
+                            "description": "Three letter ISO code for the dock address country.",
+                            "example": "BRA"
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Dock address country name.",
+                            "example": "Brazil"
+                          }
+                        }
+                      },
+                      "city": {
+                        "type": "string",
+                        "description": "Dock address city.",
+                        "example": "Rio de Janeiro"
+                      },
+                      "state": {
+                        "type": "string",
+                        "description": "Dock address state.",
+                        "example": "RJ"
+                      },
+                      "neighborhood": {
+                        "type": "string",
+                        "description": "Dock address neighborhood.",
+                        "example": "Catete"
+                      },
+                      "street": {
+                        "type": "string",
+                        "description": "Dock address street.",
+                        "example": "Artur Bernardes Street"
+                      },
+                      "number": {
+                        "type": "string",
+                        "description": "Dock address number.",
+                        "example": "100"
+                      },
+                      "complement": {
+                        "type": "string",
+                        "description": "Dock address complement.",
+                        "example": "apartment"
+                      },
+                      "coordinates": {
+                        "type": "array",
+                        "description": "Dock address geolocation coordinates.",
+                        "items": {
+                          "type": "array",
+                          "description": "Geolocation coordinates, first longitude then latitude.",
+                          "example": [
+                            -34.82939147949219,
+                            -7.115228652954102
+                          ],
+                          "items": {
+                            "type": "number",
+                            "description": "Longitude or latitude.",
+                            "example": -34.82939147949219
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "boolean",
+                  "description": "Successful requests return the message `true`."
+                },
+                "example": true
+              }
+            }
+          }
+        }
+      },
+      "get": {
+        "tags": [
+          "Docks"
+        ],
+        "summary": "List all docks",
+        "description": "Retrieves information about all [loading docks](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) of your store's [shipping strategy](https://help.vtex.com/en/tutorial/shipping-strategy--58vLBDbjYVQzJ6rRc5QNz3).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "AllDocks",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "description": "List with docks information.",
+                  "items": {
+                    "type": "object",
+                    "description": "Loading dock information.",
+                    "properties": {
+                      "pickupStoreInfo": {
+                        "type": "object",
+                        "description": "Information about a loading dock that was transformed into a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).",
+                        "deprecated": true,
+                        "properties": {
+                          "isPickupStore": {
+                            "type": "boolean",
+                            "description": "Defines if the shipping type was pickup (`true`) or not (`false`).",
+                            "nullable": true,
+                            "deprecated": true
+                          },
+                          "storeId": {
+                            "type": "string",
+                            "description": "Store ID for stores that acted as pickup points.",
+                            "nullable": true,
+                            "deprecated": true
+                          },
+                          "friendlyName": {
+                            "type": "string",
+                            "description": "Name of the pickup point displayed at checkout.",
+                            "nullable": true,
+                            "deprecated": true
+                          },
+                          "address": {
+                            "type": "object",
+                            "description": "Pickup point address information.",
+                            "nullable": true,
+                            "deprecated": true,
+                            "properties": {
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Pickup point address postal code.",
+                                "deprecated": true
+                              },
+                              "country": {
+                                "type": "object",
+                                "description": "Information about the pickup point address country.",
+                                "deprecated": true,
+                                "properties": {
+                                  "acronym": {
+                                    "type": "string",
+                                    "description": "Three-digit country code of the pickup point address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.",
+                                    "deprecated": true
+                                  },
+                                  "name": {
+                                    "type": "string",
+                                    "description": "Country name of the pickup point address.",
+                                    "deprecated": true
+                                  }
+                                }
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "Pickup point address city.",
+                                "deprecated": true
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "Pickup point address state.",
+                                "deprecated": true
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Pickup point address neighborhood.",
+                                "deprecated": true
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Pickup point address street.",
+                                "deprecated": true
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Pickup point address number.",
+                                "deprecated": true
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Pickup point address complement.",
+                                "deprecated": true,
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Pickup point address reference point.",
+                                "deprecated": true,
+                                "nullable": true
+                              },
+                              "location": {
+                                "type": "object",
+                                "description": "Pickup point address geolocation coordinates.",
+                                "deprecated": true,
+                                "properties": {
+                                  "latitude": {
+                                    "type": "number",
+                                    "description": "Latitude coordinate.",
+                                    "deprecated": true
+                                  },
+                                  "longitude": {
+                                    "type": "number",
+                                    "description": "Longitude coordinate.",
+                                    "deprecated": true
+                                  }
+                                }
+                              }
+                            }
+                          },
+                          "additionalInfo": {
+                            "type": "string",
+                            "description": "Additional information about the delivery or the pickup point.",
+                            "nullable": true,
+                            "deprecated": true
+                          },
+                          "dockId": {
+                            "type": "string",
+                            "description": "ID of the [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj related to the delivery or the pickup point ID.",
+                            "nullable": true,
+                            "deprecated": true
+                          },
+                          "distance": {
+                            "type": "number",
+                            "description": "Distance in kilometers between the pickup point and the customer's address, measured as a straight line.",
+                            "nullable": true,
+                            "deprecated": true
+                          },
+                          "businessHours": {
+                            "type": "string",
+                            "description": "Pickup point business hours configurations.",
+                            "nullable": true,
+                            "deprecated": true
+                          },
+                          "pickupHolidays": {
+                            "type": "string",
+                            "description": "Holiday's configurations applicable to the pickup point.",
+                            "nullable": true,
+                            "deprecated": true
+                          },
+                          "sellerId": {
+                            "type": "string",
+                            "description": "Seller ID.",
+                            "nullable": true,
+                            "deprecated": true
+                          },
+                          "isThirdPartyPickup": {
+                            "type": "boolean",
+                            "description": "Defines if the pickup was third party (`true`) or not (`false`).",
+                            "deprecated": true
+                          }
+                        }
+                      },
+                      "storeId": {
+                        "type": "string",
+                        "description": "Store ID.",
+                        "nullable": true
+                      },
+                      "pickupInStoreInfo": {
+                        "type": "object",
+                        "description": "Information about the physical store as a pickup point.",
+                        "properties": {
+                          "isActice": {
+                            "type": "boolean",
+                            "description": "Defines if the physical store is a pickup point (`true`) or not (`false`)."
+                          },
+                          "additionalInfo": {
+                            "type": "string",
+                            "description": "Additional information of the store as a pickup point.",
+                            "nullable": true
+                          }
+                        }
+                      },
+                      "deliveryFromStoreInfo": {
+                        "type": "object",
+                        "description": "Settings for delivery from a physical store.",
+                        "properties": {
+                          "isActice": {
+                            "type": "boolean",
+                            "description": "Defines if the settings for delivery from physical stores are active (`true`) or inactive (`false`)."
+                          },
+                          "deliveryRadius": {
+                            "type": "number",
+                            "description": "Delivery radius."
+                          },
+                          "deliveryFee": {
+                            "type": "number",
+                            "description": "Delivery fee."
+                          },
+                          "deliveryTime": {
+                            "type": "string",
+                            "description": "Delivery time in the format `DD.HH:MM:SS`."
+                          },
+                          "maximumWeight": {
+                            "type": "number",
+                            "description": "Delivery maximum weight."
+                          }
+                        }
+                      },
+                      "address": {
+                        "type": "object",
+                        "description": "Loading dock address.",
+                        "properties": {
+                          "postalCode": {
+                            "type": "string",
+                            "description": "Loading dock address postal code."
+                          },
+                          "country": {
+                            "type": "object",
+                            "description": "Information about the loading dock address country.",
+                            "properties": {
+                              "acronym": {
+                                "type": "string",
+                                "description": "Three-digit country code of the loading dock address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Country name of the loading dock address."
+                              }
+                            }
+                          },
+                          "city": {
+                            "type": "string",
+                            "description": "Loading dock address city."
+                          },
+                          "state": {
+                            "type": "string",
+                            "description": "Loading dock address state."
+                          },
+                          "neighborhood": {
+                            "type": "string",
+                            "description": "Loading dock address neighborhood."
+                          },
+                          "street": {
+                            "type": "string",
+                            "description": "Loading dock address street."
+                          },
+                          "number": {
+                            "type": "string",
+                            "description": "Loading dock address number."
+                          },
+                          "complement": {
+                            "type": "string",
+                            "description": "Loading dock address complement.",
+                            "nullable": true
+                          },
+                          "reference": {
+                            "type": "string",
+                            "description": "Loading dock address reference point.",
+                            "nullable": true
+                          },
+                          "location": {
+                            "type": "object",
+                            "description": "Loading dock address geolocation coordinates.",
+                            "properties": {
+                              "latitude": {
+                                "type": "number",
+                                "description": "Latitude coordinate."
+                              },
+                              "longitude": {
+                                "type": "number",
+                                "description": "Longitude coordinate."
+                              }
+                            }
+                          }
+                        }
+                      },
+                      "location": {
+                        "type": "object",
+                        "description": "Loading dock location details.",
+                        "nullable": true,
+                        "properties": {
+                          "zipCode": {
+                            "type": "string",
+                            "description": "Loading dock address postal code."
+                          },
+                          "country": {
+                            "type": "string",
+                            "description": "Three-digit country code of the loading dock address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format."
+                          },
+                          "inStore": {
+                            "type": "object",
+                            "description": "Information related to orders made via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc).",
+                            "properties": {
+                              "IsCheckedIn": {
+                                "type": "boolean",
+                                "description": "Defines if orders can be placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) (`true`) or not (`false`)."
+                              },
+                              "StoreId": {
+                                "type": "string",
+                                "description": "ID of purchases made in the GoCommerce context.",
+                                "nullable": true
+                              }
+                            }
+                          }
+                        }
+                      },
+                      "shippingRatesProviders": {
+                        "type": "array",
+                        "description": "Shipping rates providers information.",
+                        "items": {
+                          "type": "string",
+                          "description": "Shipping rates."
+                        },
+                        "nullable": true
+                      },
+                      "deliveryAgreementsIds": {
+                        "type": "array",
+                        "description": "Delivery agreements IDs information.",
+                        "items": {
+                          "type": "string",
+                          "description": "Delivery agreements IDs."
+                        },
+                        "nullable": true
+                      },
+                      "id": {
+                        "type": "string",
+                        "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID."
+                      },
+                      "name": {
+                        "type": "string",
+                        "description": "Loading dock name."
+                      },
+                      "priority": {
+                        "type": "integer",
+                        "description": "Value from `0` to `10` used as a tie-breaking rule for loading dock selecting. The greater the priority, the greater the possibility of the loading dock being chosen in [shipping calculation](https://help.vtex.com/en/tutorial/how-shipping-calculation-works--tutorials_116). When no priority was set, it corresponds to `0`."
+                      },
+                      "dockTimeFake": {
+                        "type": "string",
+                        "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) processing time in the format `D.HH:MM:SS`. When not configured, it returns `00:00:00`."
+                      },
+                      "timeFakeOverhead": {
+                        "type": "string",
+                        "description": "Time frame used to choose a loading dock when there is more than one loading dock with the same processing time. The lower the value entered in this field, the greater the possibility of the loading dock being chosen. \r\n>ℹ️ This field is not considered when calculating the delivery time."
+                      },
+                      "salesChannels": {
+                        "type": "array",
+                        "description": "Sales channels ([trade policies](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) associated with the loading dock.",
+                        "items": {
+                          "type": "string",
+                          "description": "Sales channel ID."
+                        }
+                      },
+                      "salesChannel": {
+                        "type": "string",
+                        "description": "Main sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) associated with the loading dock."
+                      },
+                      "freightTableIds": {
+                        "type": "array",
+                        "description": "List with freight table IDs associated with the loading dock.",
+                        "items": {
+                          "type": "string",
+                          "description": "Freight table ID."
+                        }
+                      },
+                      "wmsEndPoint": {
+                        "type": "string",
+                        "description": "Endpoint for integrating an external Warehouse Management System (WMS).",
+                        "nullable": true
+                      },
+                      "isActive": {
+                        "type": "boolean",
+                        "description": "Defines if the loading dock is active (`true`) or inactive (`false`)."
+                      }
+                    }
+                  }
+                },
+                "example": [
+                  {
+                    "pickupStoreInfo": {
+                      "isPickupStore": false,
+                      "storeId": null,
+                      "friendlyName": null,
+                      "address": {
+                        "postalCode": "01001-000",
+                        "country": {
+                          "acronym": "BRA",
+                          "name": "Brasil"
+                        },
+                        "city": "São Paulo",
+                        "state": "SP",
+                        "neighborhood": "Sé",
+                        "street": "Praça da Sé",
+                        "number": "100",
+                        "complement": null,
+                        "reference": "Next to the pink building",
+                        "location": {
+                          "latitude": -46.6342009,
+                          "longitude": -23.5503099
+                        }
+                      },
+                      "additionalInfo": null,
+                      "dockId": null,
+                      "distance": null,
+                      "businessHours": null,
+                      "pickupHolidays": null,
+                      "sellerId": null,
+                      "isThirdPartyPickup": false
+                    },
+                    "storeId": null,
+                    "pickupInStoreInfo": {
+                      "isActice": false,
+                      "additionalInfo": null
+                    },
+                    "deliveryFromStoreInfo": {
+                      "isActice": false,
+                      "deliveryRadius": 0,
+                      "deliveryFee": 0,
+                      "deliveryTime": "00:00:00",
+                      "maximumWeight": 0
+                    },
+                    "address": {
+                      "postalCode": "01001-000",
+                      "country": {
+                        "acronym": "BRA",
+                        "name": "Brasil"
+                      },
+                      "city": "São Paulo",
+                      "state": "SP",
+                      "neighborhood": "Sé",
+                      "street": "Praça da Sé",
+                      "number": "",
+                      "complement": null,
+                      "reference": null,
+                      "location": {
+                        "latitude": -46.6342009,
+                        "longitude": -23.5503099
+                      }
+                    },
+                    "location": null,
+                    "shippingRatesProviders": [],
+                    "deliveryAgreementsIds": [],
+                    "id": "1aa131g",
+                    "name": "Dock Pac",
+                    "priority": 0,
+                    "dockTimeFake": "00:00:00",
+                    "timeFakeOverhead": "00:00:00",
+                    "salesChannels": [
+                      "1",
+                      "2",
+                      "3"
+                    ],
+                    "freightTableIds": [
+                      "1602051"
+                    ],
+                    "wmsEndPoint": null,
+                    "isActive": true
+                  },
+                  {
+                    "pickupStoreInfo": {
+                      "isPickupStore": false,
+                      "storeId": null,
+                      "friendlyName": null,
+                      "address": null,
+                      "additionalInfo": null,
+                      "dockId": null,
+                      "distance": null,
+                      "businessHours": null,
+                      "pickupHolidays": null,
+                      "sellerId": null,
+                      "isThirdPartyPickup": false
+                    },
+                    "storeId": null,
+                    "pickupInStoreInfo": {
+                      "isActice": false,
+                      "additionalInfo": null
+                    },
+                    "deliveryFromStoreInfo": {
+                      "isActice": false,
+                      "deliveryRadius": 0,
+                      "deliveryFee": 0,
+                      "deliveryTime": "00:00:00",
+                      "maximumWeight": 0
+                    },
+                    "address": {
+                      "postalCode": "22220070",
+                      "country": {
+                        "acronym": "BRA",
+                        "name": "Brazil"
+                      },
+                      "city": "Rio de Janeiro",
+                      "state": "RJ",
+                      "neighborhood": "Catete",
+                      "street": "Artur Bernardes Street",
+                      "number": "100",
+                      "complement": "apartment",
+                      "coordinates": [
+                        -34.82939147949219,
+                        -7.115228652954102
+                      ]
+                    },
+                    "location": {
+                      "zipCode": "22220070",
+                      "country": "BRA",
+                      "inStore": {
+                        "IsCheckedIn": false,
+                        "StoreId": null
+                      }
+                    },
+                    "shippingRatesProviders": [],
+                    "deliveryAgreementsIds": [],
+                    "id": "doc_dockTest",
+                    "name": "Central dock",
+                    "priority": 0,
+                    "dockTimeFake": "00:00:00",
+                    "timeFakeOverhead": "00:00:00",
+                    "salesChannels": [
+                      "1"
+                    ],
+                    "salesChannel": "1",
+                    "freightTableIds": [
+                      "andreia-sp-01"
+                    ],
+                    "wmsEndPoint": null,
+                    "isActive": true
+                  }
+                ]
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/configuration/docks/{dockId}": {
+      "get": {
+        "tags": [
+          "Docks"
+        ],
+        "summary": "List dock by ID",
+        "description": "Retrieves information about a [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) of your store's [shipping strategy](https://help.vtex.com/en/tutorial/shipping-strategy--58vLBDbjYVQzJ6rRc5QNz3), searching by dock ID.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "DockById",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "dockId",
+            "in": "path",
+            "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "dock_1f95"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "description": "Loading dock information.",
+                  "properties": {
+                    "pickupStoreInfo": {
+                      "type": "object",
+                      "description": "Information about a loading dock that was transformed into a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).",
+                      "deprecated": true,
+                      "properties": {
+                        "isPickupStore": {
+                          "type": "boolean",
+                          "description": "Defines if the shipping type was pickup (`true`) or not (`false`).",
+                          "nullable": true,
+                          "deprecated": true
+                        },
+                        "storeId": {
+                          "type": "string",
+                          "description": "Store ID for stores that acted as pickup points.",
+                          "nullable": true,
+                          "deprecated": true
+                        },
+                        "friendlyName": {
+                          "type": "string",
+                          "description": "Name of the pickup point displayed at checkout.",
+                          "nullable": true,
+                          "deprecated": true
+                        },
+                        "address": {
+                          "type": "object",
+                          "description": "Pickup point address information.",
+                          "nullable": true,
+                          "deprecated": true,
+                          "properties": {
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Pickup point address postal code.",
+                              "deprecated": true
+                            },
+                            "country": {
+                              "type": "object",
+                              "description": "Information about the pickup point address country.",
+                              "deprecated": true,
+                              "properties": {
+                                "acronym": {
+                                  "type": "string",
+                                  "description": "Three-digit country code of the pickup point address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.",
+                                  "deprecated": true
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Country name of the pickup point address.",
+                                  "deprecated": true
+                                }
+                              }
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "Pickup point address city.",
+                              "deprecated": true
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "Pickup point address state.",
+                              "deprecated": true
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Pickup point address neighborhood.",
+                              "deprecated": true
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Pickup point address street.",
+                              "deprecated": true
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Pickup point address number.",
+                              "deprecated": true
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Pickup point address complement.",
+                              "deprecated": true,
+                              "nullable": true
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Pickup point address reference point.",
+                              "deprecated": true,
+                              "nullable": true
+                            },
+                            "location": {
+                              "type": "object",
+                              "description": "Pickup point address geolocation coordinates.",
+                              "deprecated": true,
+                              "properties": {
+                                "latitude": {
+                                  "type": "number",
+                                  "description": "Latitude coordinate.",
+                                  "deprecated": true
+                                },
+                                "longitude": {
+                                  "type": "number",
+                                  "description": "Longitude coordinate.",
+                                  "deprecated": true
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "additionalInfo": {
+                          "type": "string",
+                          "description": "Additional information about the delivery or the pickup point.",
+                          "nullable": true,
+                          "deprecated": true
+                        },
+                        "dockId": {
+                          "type": "string",
+                          "description": "ID of the [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj related to the delivery or the pickup point ID.",
+                          "nullable": true,
+                          "deprecated": true
+                        },
+                        "distance": {
+                          "type": "number",
+                          "description": "Distance in kilometers between the pickup point and the customer's address, measured as a straight line.",
+                          "nullable": true,
+                          "deprecated": true
+                        },
+                        "businessHours": {
+                          "type": "string",
+                          "description": "Pickup point business hours configurations.",
+                          "nullable": true,
+                          "deprecated": true
+                        },
+                        "pickupHolidays": {
+                          "type": "string",
+                          "description": "Holiday's configurations applicable to the pickup point.",
+                          "nullable": true,
+                          "deprecated": true
+                        },
+                        "sellerId": {
+                          "type": "string",
+                          "description": "Seller ID.",
+                          "nullable": true,
+                          "deprecated": true
+                        },
+                        "isThirdPartyPickup": {
+                          "type": "boolean",
+                          "description": "Defines if the pickup was third party (`true`) or not (`false`).",
+                          "deprecated": true
+                        }
+                      }
+                    },
+                    "storeId": {
+                      "type": "string",
+                      "description": "Store ID.",
+                      "nullable": true
+                    },
+                    "pickupInStoreInfo": {
+                      "type": "object",
+                      "description": "Information about the physical store as a pickup point.",
+                      "properties": {
+                        "isActice": {
+                          "type": "boolean",
+                          "description": "Defines if the physical store is a pickup point (`true`) or not (`false`)."
+                        },
+                        "additionalInfo": {
+                          "type": "string",
+                          "description": "Additional information of the store as a pickup point.",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "deliveryFromStoreInfo": {
+                      "type": "object",
+                      "description": "Settings for delivery from a physical store.",
+                      "properties": {
+                        "isActice": {
+                          "type": "boolean",
+                          "description": "Defines if the settings for delivery from physical stores are active (`true`) or inactive (`false`)."
+                        },
+                        "deliveryRadius": {
+                          "type": "number",
+                          "description": "Delivery radius."
+                        },
+                        "deliveryFee": {
+                          "type": "number",
+                          "description": "Delivery fee."
+                        },
+                        "deliveryTime": {
+                          "type": "string",
+                          "description": "Delivery time in the format `DD.HH:MM:SS`."
+                        },
+                        "maximumWeight": {
+                          "type": "number",
+                          "description": "Delivery maximum weight."
+                        }
+                      }
+                    },
+                    "address": {
+                      "type": "object",
+                      "description": "Loading dock address.",
+                      "properties": {
+                        "postalCode": {
+                          "type": "string",
+                          "description": "Loading dock address postal code."
+                        },
+                        "country": {
+                          "type": "object",
+                          "description": "Information about the loading dock address country.",
+                          "properties": {
+                            "acronym": {
+                              "type": "string",
+                              "description": "Three-digit country code of the loading dock address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format."
+                            },
+                            "name": {
+                              "type": "string",
+                              "description": "Country name of the loading dock address."
+                            }
+                          }
+                        },
+                        "city": {
+                          "type": "string",
+                          "description": "Loading dock address city."
+                        },
+                        "state": {
+                          "type": "string",
+                          "description": "Loading dock address state."
+                        },
+                        "neighborhood": {
+                          "type": "string",
+                          "description": "Loading dock address neighborhood."
+                        },
+                        "street": {
+                          "type": "string",
+                          "description": "Loading dock address street."
+                        },
+                        "number": {
+                          "type": "string",
+                          "description": "Loading dock address number."
+                        },
+                        "complement": {
+                          "type": "string",
+                          "description": "Loading dock address complement.",
+                          "nullable": true
+                        },
+                        "reference": {
+                          "type": "string",
+                          "description": "Loading dock address reference point.",
+                          "nullable": true
+                        },
+                        "location": {
+                          "type": "object",
+                          "description": "Loading dock address geolocation coordinates.",
+                          "properties": {
+                            "latitude": {
+                              "type": "number",
+                              "description": "Latitude coordinate."
+                            },
+                            "longitude": {
+                              "type": "number",
+                              "description": "Longitude coordinate."
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "location": {
+                      "type": "object",
+                      "description": "Loading dock location details.",
+                      "nullable": true,
+                      "properties": {
+                        "zipCode": {
+                          "type": "string",
+                          "description": "Loading dock address postal code."
+                        },
+                        "country": {
+                          "type": "string",
+                          "description": "Three-digit country code of the loading dock address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format."
+                        },
+                        "inStore": {
+                          "type": "object",
+                          "description": "Information related to orders made via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc).",
+                          "properties": {
+                            "IsCheckedIn": {
+                              "type": "boolean",
+                              "description": "Defines if orders can be placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) (`true`) or not (`false`)."
+                            },
+                            "StoreId": {
+                              "type": "string",
+                              "description": "ID of purchases made in the GoCommerce context.",
+                              "nullable": true
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "shippingRatesProviders": {
+                      "type": "array",
+                      "description": "Shipping rates providers information.",
+                      "items": {
+                        "type": "string",
+                        "description": "Shipping rates."
+                      },
+                      "nullable": true
+                    },
+                    "deliveryAgreementsIds": {
+                      "type": "array",
+                      "description": "Delivery agreements IDs information.",
+                      "items": {
+                        "type": "string",
+                        "description": "Delivery agreements IDs."
+                      },
+                      "nullable": true
+                    },
+                    "id": {
+                      "type": "string",
+                      "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID."
+                    },
+                    "name": {
+                      "type": "string",
+                      "description": "Loading dock name."
+                    },
+                    "priority": {
+                      "type": "integer",
+                      "description": "Value from `0` to `10` used as a tie-breaking rule for loading dock selecting. The greater the priority, the greater the possibility of the loading dock being chosen in [shipping calculation](https://help.vtex.com/en/tutorial/how-shipping-calculation-works--tutorials_116). When no priority was set, it corresponds to `0`."
+                    },
+                    "dockTimeFake": {
+                      "type": "string",
+                      "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) processing time in the format `D.HH:MM:SS`. When not configured, it returns `00:00:00`."
+                    },
+                    "timeFakeOverhead": {
+                      "type": "string",
+                      "description": "Time frame used to choose a loading dock when there is more than one loading dock with the same processing time. The lower the value entered in this field, the greater the possibility of the loading dock being chosen. \r\n>ℹ️ This field is not considered when calculating the delivery time."
+                    },
+                    "salesChannels": {
+                      "type": "array",
+                      "description": "Sales channels ([trade policies](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) associated with the loading dock.",
+                      "items": {
+                        "type": "string",
+                        "description": "Sales channel ID."
+                      }
+                    },
+                    "salesChannel": {
+                      "type": "string",
+                      "description": "Main sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) associated with the loading dock."
+                    },
+                    "freightTableIds": {
+                      "type": "array",
+                      "description": "List with freight table IDs associated with the loading dock.",
+                      "items": {
+                        "type": "string",
+                        "description": "Freight table ID."
+                      }
+                    },
+                    "wmsEndPoint": {
+                      "type": "string",
+                      "description": "Endpoint for integrating an external Warehouse Management System (WMS).",
+                      "nullable": true
+                    },
+                    "isActive": {
+                      "type": "boolean",
+                      "description": "Defines if the loading dock is active (`true`) or inactive (`false`)."
+                    }
+                  }
+                },
+                "example": {
+                  "pickupStoreInfo": {
+                    "isPickupStore": false,
+                    "storeId": null,
+                    "friendlyName": null,
+                    "address": null,
+                    "additionalInfo": null,
+                    "dockId": null,
+                    "distance": null,
+                    "businessHours": null,
+                    "pickupHolidays": null,
+                    "sellerId": null,
+                    "isThirdPartyPickup": false
+                  },
+                  "storeId": null,
+                  "pickupInStoreInfo": {
+                    "isActice": false,
+                    "additionalInfo": null
+                  },
+                  "deliveryFromStoreInfo": {
+                    "isActice": false,
+                    "deliveryRadius": 0,
+                    "deliveryFee": 0,
+                    "deliveryTime": "00:00:00",
+                    "maximumWeight": 0
+                  },
+                  "address": {
+                    "postalCode": "22220070",
+                    "country": {
+                      "acronym": "BRA",
+                      "name": "Brazil"
+                    },
+                    "city": "Rio de Janeiro",
+                    "state": "RJ",
+                    "neighborhood": "Catete",
+                    "street": "Artur Bernardes Street",
+                    "number": "100",
+                    "complement": "apartment",
+                    "reference": "Next to the pink building",
+                    "location": {
+                      "latitude": -34.82939147949219,
+                      "longitude": -7.115228652954102
+                    }
+                  },
+                  "location": {
+                    "zipCode": "22220070",
+                    "country": "BRA",
+                    "inStore": {
+                      "IsCheckedIn": false,
+                      "StoreId": null
+                    }
+                  },
+                  "shippingRatesProviders": [],
+                  "deliveryAgreementsIds": [],
+                  "id": "doc_dockTest",
+                  "name": "Central dock",
+                  "priority": 0,
+                  "dockTimeFake": "00:00:00",
+                  "timeFakeOverhead": "00:00:00",
+                  "salesChannels": [
+                    "1"
+                  ],
+                  "salesChannel": "1",
+                  "freightTableIds": [
+                    "andreia-sp-01"
+                  ],
+                  "wmsEndPoint": null,
+                  "isActive": true
+                }
+              }
+            }
+          }
+        }
+      },
+      "delete": {
+        "tags": [
+          "Docks"
+        ],
+        "summary": "Delete dock",
+        "description": "Deletes a [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj), searching by dock ID.\r\n\r\nSuccessful requests receive a `200 OK` status code with `true` in the response body.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "Dock",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "dockId",
+            "in": "path",
+            "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "dock_1f95"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "boolean",
+                  "description": "Successful requests return the message `true`."
+                },
+                "example": true
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/configuration/docks/{dockId}/activation": {
+      "post": {
+        "tags": [
+          "Docks"
+        ],
+        "summary": "Activate dock",
+        "description": "Activates a [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) of your store's [shipping strategy](https://help.vtex.com/en/tutorial/shipping-strategy--58vLBDbjYVQzJ6rRc5QNz3), searching by dock ID.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "ActivateDock",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "dockId",
+            "in": "path",
+            "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "dock_1f95"
+            }
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "No Content"
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/configuration/docks/{dockId}/deactivation": {
+      "post": {
+        "tags": [
+          "Docks"
+        ],
+        "summary": "Deactivate dock",
+        "description": "Deactivates a [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) of your store's [shipping strategy](https://help.vtex.com/en/tutorial/shipping-strategy--58vLBDbjYVQzJ6rRc5QNz3), searching by dock ID.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "DeactivateDock",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "dockId",
+            "in": "path",
+            "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "dock_1f95"
+            }
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "No Content"
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/configuration/warehouses": {
+      "post": {
+        "tags": [
+          "Warehouses"
+        ],
+        "summary": "Create or update warehouse",
+        "description": "Creates or updates a [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "Create/UpdateWarehouse",
+        "parameters": [
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "required": [
+                  "id",
+                  "name",
+                  "warehouseDocks"
+                ],
+                "type": "object",
+                "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) to be created or updated.",
+                "properties": {
+                  "id": {
+                    "type": "string",
+                    "description": "Warehouse ID.",
+                    "example": "15bfc76"
+                  },
+                  "name": {
+                    "type": "string",
+                    "description": "Warehouse name.",
+                    "example": "Main warehouse"
+                  },
+                  "warehouseDocks": {
+                    "type": "array",
+                    "description": "List of [loading docks](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) to associate with the warehouse.",
+                    "items": {
+                      "type": "object",
+                      "description": "Loading dock details.",
+                      "required": [
+                        "dockId",
+                        "name",
+                        "time",
+                        "cost",
+                        "translateDays",
+                        "costToDisplay"
+                      ],
+                      "properties": {
+                        "dockId": {
+                          "type": "string",
+                          "description": "Loading dock ID.",
+                          "example": "1a8bce3"
+                        },
+                        "name": {
+                          "type": "string",
+                          "description": "Loading dock name.",
+                          "example": "Central dock"
+                        },
+                        "time": {
+                          "type": "string",
+                          "description": "Loading dock processing time in the format `D.HH:MM:SS`. When it was not configured, it returns `00:00:00`.",
+                          "example": "3.00:00:00"
+                        },
+                        "cost": {
+                          "type": "string",
+                          "description": "Extra charges added to the shipping rate when **Additional shipping costs** are configured.",
+                          "example": "5.00"
+                        },
+                        "translateDays": {
+                          "type": "string",
+                          "description": "Translate days.",
+                          "example": "days"
+                        },
+                        "costToDisplay": {
+                          "type": "string",
+                          "description": "Cost to display.",
+                          "example": "5,00"
+                        }
+                      }
+                    }
+                  },
+                  "priority": {
+                    "type": "integer",
+                    "description": "Optional configuration of the warehouse priority. When no priority was set, it corresponds to `0`.",
+                    "example": 0
+                  },
+                  "isActive": {
+                    "type": "boolean",
+                    "description": "Defines if the warehous is active (`true`) or not (`false`).",
+                    "example": true
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      },
+      "get": {
+        "tags": [
+          "Warehouses"
+        ],
+        "summary": "List all warehouses",
+        "description": "Lists all [warehouses](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) set up in your store.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "AllWarehouses",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "description": "Each object contains details about a [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).",
+                    "properties": {
+                      "id": {
+                        "type": "string",
+                        "description": "Warehouse ID."
+                      },
+                      "name": {
+                        "type": "string",
+                        "description": "Warehouse name."
+                      },
+                      "warehouseDocks": {
+                        "type": "array",
+                        "description": "List of [loading docks](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) related to the warehouse.",
+                        "items": {
+                          "type": "object",
+                          "description": "Loading dock information.",
+                          "properties": {
+                            "dockId": {
+                              "type": "string",
+                              "description": "Loading dock ID."
+                            },
+                            "time": {
+                              "type": "string",
+                              "description": "Loading dock processing time in the format `D.HH:MM:SS`. When it was not configured, it returns `00:00:00`."
+                            },
+                            "cost": {
+                              "type": "number",
+                              "description": "Extra charges added to the shipping rate when **Additional shipping costs** are configured."
+                            }
+                          }
+                        }
+                      },
+                      "pickupPointIds": {
+                        "type": "array",
+                        "description": "List of [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) associated with the warehouse.",
+                        "items": {
+                          "type": "string",
+                          "description": "Pickup point ID."
+                        }
+                      },
+                      "priority": {
+                        "type": "integer",
+                        "description": "Warehouse priority. When no priority was set, it corresponds to `0`."
+                      },
+                      "isActive": {
+                        "type": "boolean",
+                        "description": "Shows if the warehouse is active (`true`) or inactive (`false`)."
+                      }
+                    }
+                  }
+                },
+                "example": [
+                  {
+                    "id": "1937054",
+                    "name": "Main warehouse",
+                    "warehouseDocks": [
+                      {
+                        "dockId": "1_1_1",
+                        "time": "1.00:00:00",
+                        "cost": 0
+                      }
+                    ],
+                    "pickupPointIds": [
+                      "345",
+                      "136",
+                      "189"
+                    ],
+                    "priority": 0,
+                    "isActive": true
+                  },
+                  {
+                    "id": "140ac66",
+                    "name": "Warehouse B",
+                    "warehouseDocks": [
+                      {
+                        "dockId": "139270d",
+                        "time": "00:00:00",
+                        "cost": 0
+                      }
+                    ],
+                    "pickupPointIds": [
+                      "145",
+                      "412",
+                      "221"
+                    ],
+                    "priority": 0,
+                    "isActive": true
+                  }
+                ]
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/configuration/warehouses/{warehouseId}": {
+      "get": {
+        "tags": [
+          "Warehouses"
+        ],
+        "summary": "List warehouse by ID",
+        "description": "Retrieves information of a [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb), searching by warehouse ID.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "WarehouseById",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "warehouseId",
+            "in": "path",
+            "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "warehouse_68d7"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "type": "string",
+                      "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID."
+                    },
+                    "name": {
+                      "type": "string",
+                      "description": "Warehouse name."
+                    },
+                    "warehouseDocks": {
+                      "type": "array",
+                      "description": "List of [loading docks](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) related to the warehouse.",
+                      "items": {
+                        "type": "object",
+                        "description": "Loading dock information.",
+                        "properties": {
+                          "dockId": {
+                            "type": "string",
+                            "description": "Loading dock ID."
+                          },
+                          "time": {
+                            "type": "string",
+                            "description": "Loading dock processing time in the format `D.HH:MM:SS`. When it was not configured, it returns `00:00:00`."
+                          },
+                          "cost": {
+                            "type": "number",
+                            "description": "Extra charges added to the shipping rate when **Additional shipping costs** are configured."
+                          }
+                        }
+                      }
+                    },
+                    "pickupPointIds": {
+                      "type": "array",
+                      "description": "List of [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) associated with the warehouse.",
+                      "items": {
+                        "type": "string",
+                        "description": "Pickup point ID."
+                      }
+                    },
+                    "priority": {
+                      "type": "integer",
+                      "description": "Warehouse priority. When no priority was set, it corresponds to `0`."
+                    },
+                    "isActive": {
+                      "type": "boolean",
+                      "description": "Shows if the warehouse is active (`true`) or inactive (`false`)."
+                    }
+                  }
+                },
+                "example": {
+                  "id": "15bfc76",
+                  "name": "Main warehouse",
+                  "warehouseDocks": [
+                    {
+                      "dockId": "1a8bce3",
+                      "time": "3.00:00:00",
+                      "cost": 5
+                    }
+                  ],
+                  "pickupPointIds": [
+                    "345",
+                    "136",
+                    "189"
+                  ],
+                  "priority": 0,
+                  "isActive": true
+                }
+              }
+            }
+          }
+        }
+      },
+      "delete": {
+        "tags": [
+          "Warehouses"
+        ],
+        "summary": "Remove warehouse",
+        "description": "Deletes a [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb), searching by warehouse ID.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "RemoveWarehouse",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "warehouseId",
+            "in": "path",
+            "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "warehouse_68d7"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/configuration/warehouses/{warehouseId}/activation": {
+      "post": {
+        "tags": [
+          "Warehouses"
+        ],
+        "summary": "Activate warehouse",
+        "description": "Activates a [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb), searching by warehouse ID.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "ActivateWarehouse",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "warehouseId",
+            "in": "path",
+            "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "warehouse_68d7"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/configuration/warehouses/{warehouseId}/deactivation": {
+      "post": {
+        "tags": [
+          "Warehouses"
+        ],
+        "summary": "Deactivate warehouse",
+        "description": "Deactivates a [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb), searching by warehouse ID.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "DeactivateWarehouse",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "warehouseId",
+            "in": "path",
+            "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "warehouse_68d7"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/inventory/skus/{skuId}": {
+      "get": {
+        "tags": [
+          "Inventory"
+        ],
+        "summary": "List inventory by SKU",
+        "description": "Lists [inventory](https://help.vtex.com/en/tutorial/inventory-management--tutorials_139) information, searching by SKU ID.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics inventory full access** |\r\n| Logistics | Logistics access | **Logistics inventory read only** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics inventory full access |\r\n| OMS - Full access | Logistics inventory full access |\r\n| Logistics - Full access | Logistics inventory read only |\r\n| Logistics - Read only | Logistics inventory read only |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "InventoryBySku",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "skuId",
+            "in": "path",
+            "description": "Every SKU has a unique identifier called SKU ID.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "36"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "skuId": {
+                      "type": "string",
+                      "description": "SKU ID."
+                    },
+                    "balance": {
+                      "type": "array",
+                      "description": "List with warehouses' inventory details.",
+                      "items": {
+                        "type": "object",
+                        "description": "Warehouse inventory details.",
+                        "properties": {
+                          "warehouseId": {
+                            "type": "string",
+                            "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID."
+                          },
+                          "warehouseName": {
+                            "type": "string",
+                            "description": "Warehouse name."
+                          },
+                          "totalQuantity": {
+                            "type": "integer",
+                            "format": "int32",
+                            "description": "Total quantity of items of the given SKU."
+                          },
+                          "reservedQuantity": {
+                            "type": "integer",
+                            "format": "int32",
+                            "description": "SKU reserved quantity."
+                          },
+                          "hasUnlimitedQuantity": {
+                            "type": "boolean",
+                            "description": "When set as `false`, every sold unit decreases the item's available quantity. When set as `true`, the SKU from the warehouse is always available for sale. No matter how many units are sold, the SKU available quantity never decreases, and the SKU is never out of stock."
+                          },
+                          "timeToRefill": {
+                            "type": "string",
+                            "description": "Time to refill.",
+                            "nullable": true
+                          },
+                          "dateOfSupplyUtc": {
+                            "type": "string",
+                            "description": "Supply date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.",
+                            "nullable": true
+                          },
+                          "leadTime": {
+                            "type": "string",
+                            "description": "[Lead time](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B) is an optional time configuration you can make for a SKU in a warehouse. It can be handling time, fabrication or how long it takes for the item to be available to be shipped to customers. The lead time is a part of the total shipping time and will be considered for shipping date calculation. The format is `DD.HH:MM:SS`."
+                          }
+                        }
+                      }
+                    }
+                  }
+                },
+                "example": {
+                  "skuId": "10",
+                  "balance": [
+                    {
+                      "warehouseId": "1fabf84",
+                      "warehouseName": "Main Warehouse",
+                      "totalQuantity": 0,
+                      "reservedQuantity": 0,
+                      "hasUnlimitedQuantity": false,
+                      "timeToRefill": null,
+                      "dateOfSupplyUtc": null,
+                      "leadTime": "00:00:00"
+                    },
+                    {
+                      "warehouseId": "14e3fcc",
+                      "warehouseName": "Warehouse dew56",
+                      "totalQuantity": 0,
+                      "reservedQuantity": 0,
+                      "hasUnlimitedQuantity": false,
+                      "timeToRefill": null,
+                      "dateOfSupplyUtc": null,
+                      "leadTime": "1.00:00:00"
+                    },
+                    {
+                      "warehouseId": "102e53e",
+                      "warehouseName": "wh-03",
+                      "totalQuantity": 0,
+                      "reservedQuantity": 0,
+                      "hasUnlimitedQuantity": false,
+                      "timeToRefill": null,
+                      "dateOfSupplyUtc": null,
+                      "leadTime": "00:00:00"
+                    }
+                  ]
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}": {
+      "get": {
+        "tags": [
+          "Inventory"
+        ],
+        "summary": "List inventory per warehouse",
+        "description": "Lists [inventory](https://help.vtex.com/en/tutorial/inventory-management--tutorials_139) information, searching by [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics inventory full access** |\r\n| Logistics | Logistics access | **Logistics inventory read only** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics inventory full access |\r\n| OMS - Full access | Logistics inventory full access |\r\n| Logistics - Full access | Logistics inventory read only |\r\n| Logistics - Read only | Logistics inventory read only |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "Inventoryperwarehouse",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "skuId",
+            "in": "path",
+            "description": "SKU unique identifier.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "36"
+            }
+          },
+          {
+            "name": "warehouseId",
+            "in": "path",
+            "description": "Warehouse ID is the unique identifier of the [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "whs15hs6c"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "description": "Inventory information for a given warehouse.",
+                    "properties": {
+                      "skuId": {
+                        "type": "string",
+                        "description": "SKU ID."
+                      },
+                      "warehouseId": {
+                        "type": "string",
+                        "description": "Warehouse ID."
+                      },
+                      "dockId": {
+                        "type": "string",
+                        "description": "Dock ID."
+                      },
+                      "totalQuantity": {
+                        "type": "integer",
+                        "description": "Total quantity of SKU."
+                      },
+                      "reservedQuantity": {
+                        "type": "integer",
+                        "description": "Reserved quantity of the SKU."
+                      },
+                      "availableQuantity": {
+                        "type": "integer",
+                        "description": "Amount of items available for sale. Difference between total quantity and reserved quantity."
+                      },
+                      "isUnlimited": {
+                        "type": "boolean",
+                        "description": "Indicates whether the SKU's availability is unlimited (\"unlimited inventory\")."
+                      },
+                      "salesChannel": {
+                        "type": "array",
+                        "description": "List of sales channels ([trade policies](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV) associated.",
+                        "items": {
+                          "type": "string",
+                          "description": "Sales channel (trade policy) ID."
+                        }
+                      },
+                      "deliveryChannel": {
+                        "type": "array",
+                        "description": "List of delivery channels available.",
+                        "items": {
+                          "type": "string",
+                          "description": "Delivery channel type available."
+                        }
+                      },
+                      "timeToRefill": {
+                        "type": "string",
+                        "description": "Time to refill.",
+                        "deprecated": true
+                      },
+                      "dateOfSupplyUtc": {
+                        "type": "string",
+                        "description": "Date of supply lot in UTC."
+                      },
+                      "keepSellingAfterExpiration": {
+                        "type": "boolean",
+                        "description": "Indicates whether SKU can continue to be sold after the available quantity gets to 0."
+                      },
+                      "transfer": {
+                        "type": "string",
+                        "description": "Transfer."
+                      }
+                    }
+                  }
+                },
+                "example": [
+                  {
+                    "skuId": "1",
+                    "warehouseId": "1",
+                    "dockId": "1",
+                    "totalQuantity": 1000000,
+                    "reservedQuantity": 0,
+                    "availableQuantity": 1000000,
+                    "isUnlimited": true,
+                    "salesChannel": [
+                      "1"
+                    ],
+                    "deliveryChannels": [
+                      "delivery"
+                    ],
+                    "timeToRefill": "1",
+                    "dateOfSupplyUtc": "12020-04-05T00:00:00+00:00",
+                    "supplyLotId": "05-05-22",
+                    "keepSellingAfterExpiration": false,
+                    "transfer": "Transfer 1"
+                  }
+                ]
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/inventory/skus/{skuId}/warehouses/{warehouseId}": {
+      "put": {
+        "tags": [
+          "Inventory"
+        ],
+        "summary": "Update inventory by SKU and warehouse",
+        "description": "Updates [inventory](https://help.vtex.com/en/tutorial/inventory-management--tutorials_139) quantity and [lead time](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B) for a given SKU in a warehouse.\r\n\r\n>ℹ️ If you wish to configure lead time exclusively, use the [Update inventory lead time by SKU and warehouse](https://developers.vtex.com/docs/api-reference/logistics-api#patch-/api/logistics/pvt/inventory/skus/-skuId-/warehouses/-warehouseId-/lead-time) endpoint, and if the quantity only, use the [Update inventory quantity by SKU and warehouse](https://developers.vtex.com/docs/api-reference/logistics-api#patch-/api/logistics/pvt/inventory/skus/-skuId-/warehouses/-warehouseId-/quantity) endpoint. \r\n\r\nThis endpoint allows you to: \r\n\r\n- **Define a quantity:** Indicate a specific number of items of a SKU from a warehouse, and it will decrease whenever an item is sold. When the last item is sold, the SKU will run out of stock. \r\n\r\n- **Set an unlimited inventory:** Always have items of a SKU from a warehouse considered available for sale. When this configuration is active, the SKU never goes out of stock. \r\n\r\n- **Configure lead time:** Set the [lead time](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B) for a given SKU from a warehouse, and this period will be added to the order total shipping time. This configuration is optional and by default it is set to `0` days. \r\n\r\nSuccessful requests receive a `200 OK` status code with `true` in the response body, and unsuccessful requests receive a `400 Bad Request` error code. \r\n\r\n>❗ Requests made with an incomplete response body can be successful and receive a `200 OK` message. However, sending the request body without the `leadTime` field sets the SKU [lead time](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B) to `0`. The same is valid for the `quantity` field, which, if not sent, makes the SKU count equal to `0`. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics inventory full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics inventory full access |\r\n| OMS - Full access | Logistics inventory full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication.",
+        "operationId": "UpdateInventoryBySkuandWarehouse",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "skuId",
+            "in": "path",
+            "description": "Unique identifier of the SKU you wish to update.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "25"
+            }
+          },
+          {
+            "name": "warehouseId",
+            "in": "path",
+            "description": "Unique identifier of the [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) of the SKU you wish to update.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "store-warehouse"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "required": [
+                  "quantity",
+                  "unlimitedQuantity",
+                  "leadTime"
+                ],
+                "type": "object",
+                "properties": {
+                  "quantity": {
+                    "type": "integer",
+                    "format": "int32",
+                    "description": "Quantity of SKU units you wish to update the [inventory](https://help.vtex.com/tutorial/inventory-management--tutorials_139) in the given [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb). Note that:\r\n\r\n- Sending it as `null` sets the quantity to `0`.\r\n\r\n- Not sending it sets the quantity to `0`.\r\n\r\n- Sending `unlimitedQuantity` as `true` overrules the `quantity`.",
+                    "example": 202
+                  },
+                  "unlimitedQuantity": {
+                    "type": "boolean",
+                    "description": "When set as `true`, you make the SKU from the given warehouse permanently available for sales. No matter how many units are sold, the default quantity of `1000000` units does not decrease, and the store never runs out of stock. When set as `false`, every sold unit will decrease your inventory quantity. Note that:\r\n\r\n- Sending this field as `null` sets the value to `false`.\r\n\r\n- Not sending this field sets the value to `false`.\r\n\r\n- Sending this field as `true` overrules the `quantity` field.",
+                    "example": false
+                  },
+                  "dateUtcOnBalanceSystem": {
+                    "type": "string",
+                    "description": "Defines the date and time of the warehouse when the SKU was updated. This can be useful for liberating handling order [reservations](https://help.vtex.com/en/tutorial/how-the-reservation-works--tutorials_92), for example. The format is [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`. \r\nWhen the value is `null` or empty, the default will be the date and time of the request being made.",
+                    "example": "2024-06-13T00:52:16"
+                  },
+                  "leadTime": {
+                    "type": "string",
+                    "description": "Defines the [lead time](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B), which is an optional time configuration you can make for a SKU in a warehouse. It can be handling time, fabrication or how long it takes for the item to be available to be shipped to customers.\r\n\r\nThe lead time is a part of the total shipping time and will be considered for shipping date calculation.\r\n\r\nThe format is `dd.hh:mm:ss` (days.hours:minutes:seconds). Note that:\r\n\r\n- Sending this field as `null` sets the value to `0`.\r\n\r\n- Not sending this field sets the value to `0`.",
+                    "example": "10.10:00:00"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK"
+          },
+          "400": {
+            "description": "Bad Request"
+          },
+          "423": {
+            "description": "Locked",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "type": "string",
+                  "description": "When too many inventory update requests are made within milliseconds for the same SKU, warehouse, and seller, you can receive a status code response `423 Locked`, meaning only the first request was accepted by the platform, and the others were discarded. You must wait a few seconds before making another request. This platform constraint objective is to increase merchants' control and precision and prevent errors."
+                },
+                "example": "Unable to acquire lock for key: {{accountName}}_item_logistics_{{skuId}}_{{warehouseId}}."
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/inventory/skus/{skuId}/warehouses/{warehouseId}/quantity": {
+      "patch": {
+        "tags": [
+          "Inventory"
+        ],
+        "summary": "Update inventory quantity by SKU and warehouse",
+        "description": "Updates [inventory](https://help.vtex.com/en/tutorial/inventory-management--tutorials_139) with a SKU count and availability for a given [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb). You can do it in two ways: \r\n\r\n- **Define a quantity:** Indicate a specific number of items of a SKU from a warehouse, and it will decrease whenever an item is sold. When the last item is sold, the SKU will run out of stock. \r\n\r\n- **Set an unlimited inventory:** Always have items of a SKU from a warehouse considered available for sales. When this configuration is active, the SKU never runs out of stock. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics inventory full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics inventory full access |\r\n| OMS - Full access | Logistics inventory full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication.",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "skuId",
+            "in": "path",
+            "description": "Unique identifier of the SKU you wish to update.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "25"
+            }
+          },
+          {
+            "name": "warehouseId",
+            "in": "path",
+            "description": "Unique identifier of the [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) of the SKU you wish to update.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "storeWarehouse"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "required": [
+                  "quantity",
+                  "unlimitedQuantity"
+                ],
+                "type": "object",
+                "properties": {
+                  "quantity": {
+                    "type": "integer",
+                    "description": "Number of items you wish to update in your [inventory](https://help.vtex.com/en/tutorial/inventory-management--tutorials_139) for a SKU from a given warehouse. \r\n\r\nNote that sending the field `unlimitedQuantity` as `true` overrules the `quantity`.",
+                    "example": 201
+                  },
+                  "unlimitedQuantity": {
+                    "type": "boolean",
+                    "description": "When set as `false`, every sold unit decreases the item's available quantity. When set as `true`, the SKU from the warehouse is always available for sale. No matter how many units are sold, the SKU available quantity never decreases, and the SKU is never out of stock. \r\n\r\nNote that sending this field as `true` overrules the `quantity`.",
+                    "example": false
+                  },
+                  "dateUtcOnBalanceSystem": {
+                    "type": "string",
+                    "description": "Defines the date and time of the warehouse when the SKU was updated. This can be useful for liberating handling order [reservations](https://help.vtex.com/en/tutorial/how-the-reservation-works--tutorials_92), for example. \r\n\r\nThe format is [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`. When the value is `null` or empty, the default will be the date and time of the when the request being made.",
+                    "example": "2024-01-31T19:12:01.025662+00:00"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "204": {
+            "description": "No Content"
+          },
+          "400": {
+            "description": "Bad Request"
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/inventory/skus/{skuId}/warehouses/{warehouseId}/lead-time": {
+      "patch": {
+        "tags": [
+          "Inventory"
+        ],
+        "summary": "Update inventory lead time by SKU and warehouse",
+        "description": "Configures the [lead time](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B) for a SKU of a warehouse, and the period is added to the order's total shipping time.\r\n\r\nAmong other [main use cases](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B#main-use-cases), lead time can represent an item's manufacturing time or scenarios where there are third-party suppliers, for example.\r\n\r\nLead time is an optional configuration and by default is set to `0` days.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics inventory full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics inventory full access |\r\n| OMS - Full access | Logistics inventory full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "skuId",
+            "in": "path",
+            "description": "Unique identifier of the SKU you wish to update.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "25"
+            }
+          },
+          {
+            "name": "warehouseId",
+            "in": "path",
+            "description": "Unique identifier of the [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) of the SKU you wish to update.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "storeWarehouse"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "required": [
+                  "leadTime"
+                ],
+                "type": "object",
+                "properties": {
+                  "leadTime": {
+                    "type": "string",
+                    "description": "Defines the [lead time](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B), a configuration for shipping time at SKU level. You can set a shipping period for a warehouse SKU, and this time will be added to the order's total shipping time. Note that: \r\n\r\n- The format is `DD.HH:MM:SS`, or `DD`. The endpoint allows configuring hours and minutes, but the UI only shows days. \r\n\r\n- If you mistake hours for days, the system will accept the value as days. For example, sending `78:00:00` updates the lead time to 78 days. \r\n\r\n- Sending an empty field or a value in an incorrect format will result in a `400 Bad Request`.",
+                    "example": "8.00:00:00"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "204": {
+            "description": "No Content"
+          },
+          "400": {
+            "description": "Bad Request"
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/inventory/items/{skuId}/docks/{dockId}": {
+      "get": {
+        "tags": [
+          "Inventory"
+        ],
+        "summary": "List inventory per dock",
+        "description": "Lists inventory information, searching by [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics inventory full access** |\r\n| Logistics | Logistics access | **Logistics inventory read only** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics inventory full access |\r\n| OMS - Full access | Logistics inventory full access |\r\n| Logistics - Full access | Logistics inventory read only |\r\n| Logistics - Read only | Logistics inventory read only |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "Inventoryperdock",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "skuId",
+            "in": "path",
+            "description": "SKU unique identifier.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "36"
+            }
+          },
+          {
+            "name": "dockId",
+            "in": "path",
+            "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "dock13a"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "description": "Loading dock inventory information.",
+                    "properties": {
+                      "skuId": {
+                        "type": "string",
+                        "description": "SKU ID."
+                      },
+                      "warehouseId": {
+                        "type": "string",
+                        "description": "Warehouse ID."
+                      },
+                      "dockId": {
+                        "type": "string",
+                        "description": "Dock ID."
+                      },
+                      "totalQuantity": {
+                        "type": "integer",
+                        "description": "Total quantity of SKU."
+                      },
+                      "reservedQuantity": {
+                        "type": "integer",
+                        "description": "Reserved quantity of the SKU."
+                      },
+                      "availableQuantity": {
+                        "type": "integer",
+                        "description": "Amount of items available for sales. Difference between total quantity and reserved quantity."
+                      },
+                      "isUnlimited": {
+                        "type": "boolean",
+                        "description": "Indicates whether the SKU's availability is unlimited (\"unlimited inventory\")."
+                      },
+                      "salesChannel": {
+                        "type": "array",
+                        "description": "List of sales channels ([trade policies](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV) associated.",
+                        "items": {
+                          "type": "string",
+                          "description": "Sales channel ID."
+                        }
+                      },
+                      "deliveryChannel": {
+                        "type": "array",
+                        "description": "List of delivery channels available.",
+                        "items": {
+                          "type": "string",
+                          "description": "Delivery channel type available."
+                        }
+                      },
+                      "timeToRefill": {
+                        "type": "string",
+                        "description": "Time to refill.",
+                        "deprecated": true
+                      },
+                      "dateOfSupplyUtc": {
+                        "type": "string",
+                        "description": "Date of supply lot in UTC."
+                      },
+                      "keepSellingAfterExpiration": {
+                        "type": "boolean",
+                        "description": "Indicates whether SKU can continue to be sold after the available quantity gets to 0."
+                      },
+                      "transfer": {
+                        "type": "string",
+                        "description": "Transfer supply lot."
+                      }
+                    }
+                  }
+                },
+                "example": [
+                  {
+                    "skuId": "1",
+                    "warehouseId": "1",
+                    "dockId": "1",
+                    "totalQuantity": 1000000,
+                    "reservedQuantity": 0,
+                    "availableQuantity": 1000000,
+                    "isUnlimited": true,
+                    "salesChannel": [
+                      "1"
+                    ],
+                    "deliveryChannels": [
+                      "delivery"
+                    ],
+                    "timeToRefill": "01:50:00",
+                    "dateOfSupplyUtc": "2020-04-05T00:00:00+00:00",
+                    "supplyLotId": null,
+                    "keepSellingAfterExpiration": false,
+                    "transfer": "transfer1"
+                  },
+                  {
+                    "skuId": "1",
+                    "warehouseId": "1_1",
+                    "dockId": "1",
+                    "totalQuantity": 1000117,
+                    "reservedQuantity": 117,
+                    "availableQuantity": 1000000,
+                    "isUnlimited": true,
+                    "salesChannel": [
+                      "1"
+                    ],
+                    "deliveryChannels": [
+                      "delivery"
+                    ],
+                    "timeToRefill": "01:50:00",
+                    "dateOfSupplyUtc": "2020-04-05T00:00:00+00:00",
+                    "supplyLotId": null,
+                    "keepSellingAfterExpiration": false,
+                    "transfer": "transfer2"
+                  }
+                ]
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/inventory/items/{skuId}/docks/{dockId}/warehouses/{warehouseId}": {
+      "get": {
+        "tags": [
+          "Inventory"
+        ],
+        "summary": "List inventory per dock and warehouse",
+        "description": "Lists inventory information from the combination of a given [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) and a [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics inventory full access** |\r\n| Logistics | Logistics access | **Logistics inventory read only** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics inventory full access |\r\n| OMS - Full access | Logistics inventory full access |\r\n| Logistics - Full access | Logistics inventory read only |\r\n| Logistics - Read only | Logistics inventory read only |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "Inventoryperdockandwarehouse",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "skuId",
+            "in": "path",
+            "description": "SKU unique identifier.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "36"
+            }
+          },
+          {
+            "name": "dockId",
+            "in": "path",
+            "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "dock13a"
+            }
+          },
+          {
+            "name": "warehouseId",
+            "in": "path",
+            "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "whs15hs6c"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "description": "Inventory information for the given dock and warehouse.",
+                    "properties": {
+                      "skuId": {
+                        "type": "string",
+                        "description": "SKU ID."
+                      },
+                      "warehouseId": {
+                        "type": "string",
+                        "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID."
+                      },
+                      "dockId": {
+                        "type": "string",
+                        "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID."
+                      },
+                      "totalQuantity": {
+                        "type": "integer",
+                        "description": "Total quantity of SKU."
+                      },
+                      "reservedQuantity": {
+                        "type": "integer",
+                        "description": "Reserved quantity of the SKU."
+                      },
+                      "availableQuantity": {
+                        "type": "integer",
+                        "description": "Amount of items available for sales. Difference between total quantity and reserved quantity."
+                      },
+                      "isUnlimited": {
+                        "type": "boolean",
+                        "description": "Indicates if the unlimited inventory is activated so the SKU's availability is unlimited (`true`) or not (`false`)."
+                      },
+                      "salesChannel": {
+                        "type": "array",
+                        "description": "List of sales channels ([trade policies](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV) associated.",
+                        "items": {
+                          "type": "string",
+                          "description": "Sales channel ID."
+                        }
+                      },
+                      "deliveryChannel": {
+                        "type": "array",
+                        "description": "List of delivery channels available.",
+                        "items": {
+                          "type": "string",
+                          "description": "Delivey channel type."
+                        }
+                      },
+                      "timeToRefill": {
+                        "type": "string",
+                        "description": "Time to refill (deprecated)."
+                      },
+                      "dateOfSupplyUtc": {
+                        "type": "string",
+                        "description": "Date of supply lot in UTC."
+                      },
+                      "keepSellingAfterExpiration": {
+                        "type": "boolean",
+                        "description": "Indicates whether SKU can continue to be sold after the available quantity gets to 0."
+                      },
+                      "transfer": {
+                        "type": "string",
+                        "description": "Transfer."
+                      }
+                    }
+                  }
+                },
+                "example": [
+                  {
+                    "skuId": "1",
+                    "warehouseId": "1",
+                    "dockId": "1",
+                    "totalQuantity": 1000000,
+                    "reservedQuantity": 0,
+                    "availableQuantity": 1000000,
+                    "isUnlimited": true,
+                    "salesChannel": [
+                      "1"
+                    ],
+                    "deliveryChannels": [
+                      "delivery"
+                    ],
+                    "timeToRefill": "12:50:00",
+                    "dateOfSupplyUtc": "2020-04-05T00:00:00+00:00",
+                    "supplyLotId": null,
+                    "keepSellingAfterExpiration": false,
+                    "transfer": "Tranfer1"
+                  }
+                ]
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/inventory/items/{itemId}/warehouses/{warehouseId}/dispatched": {
+      "get": {
+        "tags": [
+          "Inventory"
+        ],
+        "summary": "List inventory with dispatched reservations",
+        "description": "[Reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) is the VTEX solution that prevents stores from selling the same item more than once. Adding products to the shopping cart does not create a reservation, this only happens after the shopper completes the purchase.\r\n\r\nThis endpoint lists your [inventory](https://help.vtex.com/en/tutorial/inventory-management--tutorials_139) information about dispatched reservations from a given warehouse. A reservation is considered dispatched after the order has passed the `authorize-fulfillment` status in the [order flow](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196) and is not canceled.\r\n\r\n**Response 400 Bad Request:** When the store has more than 2.000 active reservations, you receive a `400 Bad Request` error with the message: _Too many active reservations_.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics inventory full access** |\r\n| Logistics | Logistics access | **Logistics inventory read only** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics inventory full access |\r\n| OMS - Full access | Logistics inventory full access |\r\n| Logistics - Full access | Logistics inventory read only |\r\n| Logistics - Read only | Logistics inventory read only |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "Getinventorywithdispatchedreservations",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "itemId",
+            "in": "path",
+            "description": "SKU unique identifier called SKU ID. This field is an equivalent to `skuId`.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "89"
+            }
+          },
+          {
+            "name": "warehouseId",
+            "in": "path",
+            "description": "Warehouse ID is the unique identifier of the [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "warehouse-1-StoreName"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "description": "Inventory information.",
+                    "properties": {
+                      "skuId": {
+                        "type": "string",
+                        "description": "SKU ID."
+                      },
+                      "warehouseId": {
+                        "type": "string",
+                        "description": "Warehouse ID."
+                      },
+                      "quantity": {
+                        "type": "integer",
+                        "description": "SKU quantity."
+                      },
+                      "isUnlimitedQuantity": {
+                        "type": "boolean",
+                        "description": "Indicates whether the SKU's availability is unlimited (\"unlimited inventory\")."
+                      },
+                      "totalReservedQuantity": {
+                        "type": "integer",
+                        "description": "Total reserved quantity of the SKU."
+                      },
+                      "dispatchedReservationsQuantity": {
+                        "type": "integer",
+                        "description": "Dispatched reservations quantity."
+                      },
+                      "availableQuantity": {
+                        "type": "integer",
+                        "description": "Available quantity."
+                      }
+                    }
+                  }
+                },
+                "example": [
+                  {
+                    "skuId": "1",
+                    "warehouseId": "1",
+                    "quantity": 2147483647,
+                    "isUnlimitedQuantity": true,
+                    "totalReservedQuantity": 0,
+                    "dispatchedReservationsQuantity": 0,
+                    "availableQuantity": 2147483647
+                  }
+                ]
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}/supplyLots": {
+      "get": {
+        "tags": [
+          "Inventory"
+        ],
+        "summary": "List supply lots",
+        "description": "Lists supply lots of a SKU in a given [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics inventory full access** |\r\n| Logistics | Logistics access | **Logistics inventory read only** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics inventory full access |\r\n| OMS - Full access | Logistics inventory full access |\r\n| Logistics - Full access | Logistics inventory read only |\r\n| Logistics - Read only | Logistics inventory read only |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "GetSupplyLots",
+        "parameters": [
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "skuId",
+            "in": "path",
+            "description": "SKU ID.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "36"
+            }
+          },
+          {
+            "name": "warehouseId",
+            "in": "path",
+            "description": "ID of the [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) where the SKU is located.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "whs15hs6c"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "description": "Supply lot details.",
+                    "properties": {
+                      "skuId": {
+                        "type": "string",
+                        "description": "SKU ID related to the supply lot."
+                      },
+                      "warehouseId": {
+                        "type": "string",
+                        "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID where the SKU supply lot will arrive."
+                      },
+                      "dockId": {
+                        "type": "string",
+                        "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID."
+                      },
+                      "totalQuantity": {
+                        "type": "integer",
+                        "description": "Total quantity scheduled for the SKU in the supply lot."
+                      },
+                      "reservedQuantity": {
+                        "type": "integer",
+                        "description": "Total [reserved quantity](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) scheduled for the SKU in the supply lot."
+                      },
+                      "availableQuantity": {
+                        "type": "integer",
+                        "description": "Available quantity scheduled for the SKU in the supply lot."
+                      },
+                      "isUnlimited": {
+                        "type": "boolean",
+                        "description": "Indicates if the unlimited inventory is activated so the SKU availability for sales is unlimited (`true`), or not (`false`)."
+                      },
+                      "salesChannel": {
+                        "type": "array",
+                        "description": "List of sales channels ([trade policies](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV) associated with the supply lot.",
+                        "items": {
+                          "type": "string",
+                          "description": "Sales channel (trade policy) ID."
+                        }
+                      },
+                      "deliveryChannels": {
+                        "type": "array",
+                        "description": "List of delivery channels type associated with the supply lot.",
+                        "items": {
+                          "type": "string",
+                          "description": "Delivery channel type.",
+                          "enum": [
+                            "delivery",
+                            "pickup"
+                          ]
+                        }
+                      },
+                      "timeToRefill": {
+                        "type": "string",
+                        "description": "Time to refill in the format `HH:MM:SS`.",
+                        "nullable": true
+                      },
+                      "dateOfSupplyUtc": {
+                        "type": "string",
+                        "description": "Date and time scheduled for the SKU from the warehouse to have quantity and availability for sales again. The format is [ISO 8601 time zone offset](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`."
+                      },
+                      "supplyLotId": {
+                        "type": "string",
+                        "description": "Supply lot ID."
+                      },
+                      "keepSellingAfterExpiration": {
+                        "type": "boolean",
+                        "description": "Defines if the SKU from the warehouse should be available for sales after running _out-of-stock_ (`true`), or not (`false`)."
+                      },
+                      "transfer": {
+                        "type": "string",
+                        "description": "Transfer system.",
+                        "nullable": true
+                      },
+                      "leadTime": {
+                        "type": "string",
+                        "description": "[Lead time](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B) is an optional time configuration for a SKU in a warehouse. It can be handling time, fabrication or how long it takes for the item to be available to be shipped to customers. The lead time is a part of the total shipping time and is considered for shipping date calculation. The format is `DD.HH:MM:SS`.",
+                        "nullable": true
+                      }
+                    }
+                  }
+                },
+                "example": [
+                  {
+                    "skuId": "12",
+                    "warehouseId": "124816",
+                    "dockId": "1839",
+                    "totalQuantity": 0,
+                    "reservedQuantity": 0,
+                    "availableQuantity": 0,
+                    "isUnlimited": false,
+                    "salesChannel": [
+                      "1"
+                    ],
+                    "deliveryChannels": [
+                      "delivery"
+                    ],
+                    "timeToRefill": "12:50:00",
+                    "dateOfSupplyUtc": "2025-10-18T00:00:00+00:00",
+                    "supplyLotId": "supplyId1",
+                    "keepSellingAfterExpiration": true,
+                    "transfer": null,
+                    "leadTime": "10.00:00:00"
+                  }
+                ]
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}/supplyLots/{supplyLotId}": {
+      "put": {
+        "tags": [
+          "Inventory"
+        ],
+        "summary": "Save supply lot",
+        "description": "Creates a new supply lot, which allows you to sell a SKU that is currently _out-of-stock_ in your [inventory](https://help.vtex.com/en/tutorial/inventory-management--tutorials_139) and unavailable for sales. Creating a supply lot is useful when you know the date of when the SKU will have quantity and availability for sales again.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics inventory full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics inventory full access |\r\n| OMS - Full access | Logistics inventory full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "SaveSupplyLot",
+        "parameters": [
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "skuId",
+            "in": "path",
+            "description": "SKU ID being scheduled for availability for sales.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "36"
+            }
+          },
+          {
+            "name": "warehouseId",
+            "in": "path",
+            "description": "ID of the [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) where the SKU will arrive.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "whs15hs6c"
+            }
+          },
+          {
+            "name": "supplyLotId",
+            "in": "path",
+            "description": "ID of the supply lot of the SKU availability scheduling.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "7100-1023-04"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "required": [
+                  "quantity",
+                  "dateOfSupplyUtc"
+                ],
+                "type": "object",
+                "properties": {
+                  "quantity": {
+                    "type": "integer",
+                    "description": "Supply lot quantity for a SKU from a [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb).",
+                    "example": 1200
+                  },
+                  "dateOfSupplyUtc": {
+                    "type": "string",
+                    "description": "Date and time of when the SKU from the warehouse will have quantity and availability for sales again. The format is [ISO 8601 time zone offset](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`. Since it is a prevision, this field must be a future date.",
+                    "example": "2025-02-25T09:00:00+00:00"
+                  },
+                  "keepSellingAfterExpiration": {
+                    "type": "boolean",
+                    "description": "Defines if the SKU from the warehouse should be available for sales after running _out-of-stock_ (`true`), or not (`false`).",
+                    "example": true
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "204": {
+            "description": "No Content"
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/inventory/items/{skuId}/warehouses/{warehouseId}/supplyLots/{supplyLotId}/transfer": {
+      "post": {
+        "tags": [
+          "Inventory"
+        ],
+        "summary": "Transfer supply lot",
+        "description": "Transfers a SKU from a supply lot to the currently available inventory.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics inventory full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics inventory full access |\r\n| OMS - Full access | Logistics inventory full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "TransferSupplyLot",
+        "parameters": [
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "skuId",
+            "in": "path",
+            "description": "ID of the SKU.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "36"
+            }
+          },
+          {
+            "name": "warehouseId",
+            "in": "path",
+            "description": "ID of the [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) where the SKU is located.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "whs15hs6c"
+            }
+          },
+          {
+            "name": "supplyLotId",
+            "in": "path",
+            "description": "ID of the supply lot in which the SKU is currently located and from where it will be transfered.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "7100-1023-04"
+            }
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "No Content"
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/configuration/holidays/{holidayId}": {
+      "put": {
+        "tags": [
+          "Holidays"
+        ],
+        "summary": "Create or update holiday",
+        "description": "Creates or updates a [holiday](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk), searching by holiday ID.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "Create/UpdateHoliday",
+        "parameters": [
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "holidayId",
+            "in": "path",
+            "description": "[Holiday](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) ID.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "christmas2025"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "required": [
+                  "name",
+                  "startDate"
+                ],
+                "type": "object",
+                "description": "Holiday information.",
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "[Holiday](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) ID.",
+                    "example": "Christmas"
+                  },
+                  "startDate": {
+                    "type": "string",
+                    "description": "Holiday starting date, in the format `YYYY-MM-DD`.",
+                    "example": "2024-12-25"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      },
+      "get": {
+        "tags": [
+          "Holidays"
+        ],
+        "summary": "List holiday by ID",
+        "description": "Lists information about a [holiday](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk), searching by holiday ID.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "HolidayById",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "holidayId",
+            "in": "path",
+            "description": "[Holiday](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) ID.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "christmas2025"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      },
+      "delete": {
+        "tags": [
+          "Holidays"
+        ],
+        "summary": "Delete holiday",
+        "description": "Deletes a [holiday](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) set up in your store, searching by holiday ID.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "Holiday",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "holidayId",
+            "in": "path",
+            "description": "[Holiday](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) ID.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "christmas2025"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/configuration/holidays": {
+      "get": {
+        "tags": [
+          "Holidays"
+        ],
+        "summary": "List all holidays",
+        "description": "Lists information about all [holidays](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) configured on your store.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "AllHolidays",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/inventory/reservations": {
+      "post": {
+        "tags": [
+          "Reservations"
+        ],
+        "summary": "Create reservation",
+        "description": "Creates a [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "CreateReservation",
+        "parameters": [
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "required": [
+                  "salesChannel",
+                  "lockId",
+                  "autorizationExpirationTTL",
+                  "deliveryItemOptions"
+                ],
+                "type": "object",
+                "description": "Reservation sales channel information.",
+                "properties": {
+                  "salesChannel": {
+                    "type": "string",
+                    "description": "Sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) valid for the reservation.",
+                    "example": "1"
+                  },
+                  "lockId": {
+                    "type": "string",
+                    "description": "[Reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) ID.",
+                    "example": null,
+                    "nullable": true
+                  },
+                  "autorizationExpirationTTL": {
+                    "type": "string",
+                    "description": "Duration before expiring the reservation, in the format `DD.HH:MM:SS`.",
+                    "example": "10.00:00:00"
+                  },
+                  "deliveryItemOptions": {
+                    "type": "array",
+                    "description": "Array with information about reserved items.",
+                    "items": {
+                      "required": [
+                        "item",
+                        "slaType",
+                        "slaTypeName",
+                        "listPrice",
+                        "promotionalPrice",
+                        "transitTime",
+                        "dockTime",
+                        "timeToDockPlusDockTime",
+                        "aditionalTimeBlockedDays",
+                        "totalTime",
+                        "deliveryWindows",
+                        "wareHouseId",
+                        "dockId",
+                        "location"
+                      ],
+                      "type": "object",
+                      "description": "Reserved items information.",
+                      "properties": {
+                        "item": {
+                          "required": [
+                            "id",
+                            "quantity",
+                            "kitItem",
+                            "price",
+                            "additionalHandlingTime",
+                            "dimension"
+                          ],
+                          "type": "object",
+                          "description": "Reserved item object.",
+                          "properties": {
+                            "id": {
+                              "type": "string",
+                              "description": "SKU ID.",
+                              "example": "29"
+                            },
+                            "quantity": {
+                              "type": "integer",
+                              "format": "int32",
+                              "description": "Quantity of items.",
+                              "example": 1
+                            },
+                            "kitItem": {
+                              "type": "array",
+                              "items": {
+                                "type": "string",
+                                "description": "Kit SKU ID.",
+                                "example": null,
+                                "nullable": true
+                              },
+                              "description": "[Kit](https://help.vtex.com/en/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) items information, when applicable."
+                            },
+                            "price": {
+                              "type": "number",
+                              "description": "Item price.",
+                              "example": 14128.9
+                            },
+                            "modal": {
+                              "type": "string",
+                              "description": "Type of [modal](https://help.vtex.com/en/tutorial/how-the-modal-works--tutorials_125), a special freight.",
+                              "enum": [
+                                "CHEMICALS",
+                                "ELECTRONICS",
+                                "FURNITURE",
+                                "GLASS",
+                                "LIQUID",
+                                "MATTRESSES",
+                                "REFRIGERATED",
+                                "TIRES",
+                                "WHITE_GOODS",
+                                "FIREARMS"
+                              ],
+                              "example": "FURNITURE",
+                              "nullable": true
+                            },
+                            "additionalHandlingTime": {
+                              "type": "string",
+                              "description": "Additional handling time in the format `DD.HH:MM:SS`.",
+                              "example": "00:00:00"
+                            },
+                            "dimension": {
+                              "required": [
+                                "weight",
+                                "height",
+                                "width",
+                                "length"
+                              ],
+                              "type": "object",
+                              "description": "Item dimensions.",
+                              "properties": {
+                                "weight": {
+                                  "type": "number",
+                                  "description": "Item weight.",
+                                  "example": 186.37
+                                },
+                                "height": {
+                                  "type": "number",
+                                  "description": "Item height.",
+                                  "example": 23.5
+                                },
+                                "width": {
+                                  "type": "number",
+                                  "description": "Item width.",
+                                  "example": 165
+                                },
+                                "length": {
+                                  "type": "number",
+                                  "description": "Item length.",
+                                  "example": 67.5
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "slaType": {
+                          "type": "string",
+                          "description": "SLA (Service Level Agreement) type.",
+                          "example": "delivery"
+                        },
+                        "slaTypeName": {
+                          "type": "string",
+                          "description": "SLA name.",
+                          "example": "Normal delivery"
+                        },
+                        "listPrice": {
+                          "type": "number",
+                          "description": "List price.",
+                          "example": 10.5
+                        },
+                        "promotionalPrice": {
+                          "type": "number",
+                          "description": "Promotion price.",
+                          "example": 10.5
+                        },
+                        "transitTime": {
+                          "type": "string",
+                          "description": "Transit time in the format `DD.HH:MM:SS`.",
+                          "example": "2.00:00:00"
+                        },
+                        "dockTime": {
+                          "type": "string",
+                          "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) processing time in the format `D.HH:MM:SS`. When it was not configured, it returns `00:00:00`.",
+                          "example": "00:00:00"
+                        },
+                        "timeToDockPlusDockTime": {
+                          "type": "string",
+                          "description": "Time spent in loading dock plus `dockTime` in the format `D.HH:MM:SS`.",
+                          "example": "1.00:00:00"
+                        },
+                        "aditionalTimeBlockedDays": {
+                          "type": "string",
+                          "description": "Additional time blocked in the format `DD.HH:MM:SS`.",
+                          "example": "1.00:00:00"
+                        },
+                        "totalTime": {
+                          "type": "string",
+                          "description": "SLA total time in the format `DD.HH:MM:SS`.",
+                          "example": "3.00:00:00"
+                        },
+                        "deliveryWindows": {
+                          "type": "array",
+                          "items": {
+                            "type": "object",
+                            "description": "Delivery window details.",
+                            "properties": {
+                              "startDateUtc": {
+                                "type": "string",
+                                "description": "Delivery window starting date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.",
+                                "example": "2024-02-25T09:00:00+00:00"
+                              },
+                              "endDateUtc": {
+                                "type": "string",
+                                "description": "Delivery window ending date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.",
+                                "example": "2024-02-25T12:00:00+00:00"
+                              },
+                              "listPrice": {
+                                "type": "string",
+                                "description": "List price.",
+                                "example": "0.0"
+                              }
+                            }
+                          },
+                          "description": "[Delivery windows](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz).",
+                          "nullable": true
+                        },
+                        "wareHouseId": {
+                          "type": "string",
+                          "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.",
+                          "example": "1937054",
+                          "nullable": true
+                        },
+                        "dockId": {
+                          "type": "string",
+                          "description": "Loading dock ID.",
+                          "example": "1a8bce3"
+                        },
+                        "location": {
+                          "required": [
+                            "zipCode",
+                            "country",
+                            "inStore"
+                          ],
+                          "type": "object",
+                          "description": "Shipping location details.",
+                          "properties": {
+                            "zipCode": {
+                              "type": "string",
+                              "description": "Shipping address postal code.",
+                              "example": "22220070"
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Three-digit country code of the shipping address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.",
+                              "example": "BRA"
+                            },
+                            "inStore": {
+                              "required": [
+                                "IsCheckedIn",
+                                "StoreId"
+                              ],
+                              "type": "object",
+                              "description": "Information related to [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc).",
+                              "properties": {
+                                "IsCheckedIn": {
+                                  "type": "boolean",
+                                  "description": "This field is set as `true` when the order was placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) and `false` when it was not.",
+                                  "example": false
+                                },
+                                "StoreId": {
+                                  "type": "string",
+                                  "description": "ID of purchases made in the GoCommerce context.",
+                                  "example": "180082",
+                                  "nullable": true
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "LastUpdateDateUtc": {
+                      "type": "string",
+                      "description": "Last update date and time in the format [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`."
+                    },
+                    "SalesChannel": {
+                      "type": "string",
+                      "description": "Sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) valid for the reservation."
+                    },
+                    "LockId": {
+                      "type": "string",
+                      "description": "Reservation ID."
+                    },
+                    "ReservationDateUtc": {
+                      "type": "string",
+                      "description": "Reservation date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`."
+                    },
+                    "MaximumConfirmationDateUtc": {
+                      "type": "string",
+                      "description": "Maximum confirmation date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`."
+                    },
+                    "Status": {
+                      "type": "integer",
+                      "format": "int32",
+                      "description": "Reservation status, meaning:\r\n\r\n- `0`: `NotCommitted`\r\n\r\n- `1`: `Authorized`\r\n\r\n- `2`: `Confirmed`\r\n\r\n- `3`: `Canceled_AbortedCommitted`\r\n\r\n- `4`: `Canceled_AuthorizationExpired`\r\n\r\n- `5`: `Canceled_Manually`"
+                    },
+                    "SlaRequest": {
+                      "type": "array",
+                      "description": "SLA (Service Level Agreement) request information.",
+                      "items": {
+                        "type": "object",
+                        "description": "SLA details.",
+                        "properties": {
+                          "item": {
+                            "type": "object",
+                            "description": "Information about the reserved item.",
+                            "properties": {
+                              "id": {
+                                "type": "string",
+                                "description": "SKU ID."
+                              },
+                              "groupItemId": {
+                                "type": "string",
+                                "description": "Group item ID.",
+                                "nullable": true
+                              },
+                              "quantity": {
+                                "type": "integer",
+                                "format": "int32",
+                                "description": "Item quantity."
+                              },
+                              "price": {
+                                "type": "number",
+                                "description": "Item price."
+                              },
+                              "modal": {
+                                "type": "string",
+                                "description": "Type of [modal](https://help.vtex.com/en/tutorial/how-the-modal-works--tutorials_125), a special freight.",
+                                "enum": [
+                                  "CHEMICALS",
+                                  "ELECTRONICS",
+                                  "FURNITURE",
+                                  "GLASS",
+                                  "LIQUID",
+                                  "MATTRESSES",
+                                  "REFRIGERATED",
+                                  "TIRES",
+                                  "WHITE_GOODS",
+                                  "FIREARMS"
+                                ],
+                                "nullable": true
+                              },
+                              "additionalHandlingTime": {
+                                "type": "string",
+                                "description": "Additional handling time in the format `DD.HH:MM:SS`."
+                              },
+                              "dimension": {
+                                "type": "object",
+                                "description": "Item dimensions.",
+                                "properties": {
+                                  "weight": {
+                                    "type": "number",
+                                    "description": "Item weight."
+                                  },
+                                  "height": {
+                                    "type": "number",
+                                    "description": "Item height."
+                                  },
+                                  "width": {
+                                    "type": "number",
+                                    "description": "Item width."
+                                  },
+                                  "length": {
+                                    "type": "number",
+                                    "description": "Item length."
+                                  },
+                                  "maxSumDimension": {
+                                    "type": "number",
+                                    "description": "Maximum sum of dimensions."
+                                  }
+                                }
+                              },
+                              "kitItem": {
+                                "type": "array",
+                                "nullable": true,
+                                "items": {
+                                  "type": "string",
+                                  "description": "SKU ID."
+                                },
+                                "description": "[Kit](https://help.vtex.com/en/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) item information."
+                              },
+                              "unlimitedQuantity": {
+                                "type": "boolean",
+                                "description": "When set as `false`, every sold unit decreases the item's available quantity. When set as `true`, the SKU from the warehouse is always available for sale. No matter how many units are sold, the SKU available quantity never decreases, and the SKU is never out of stock."
+                              }
+                            }
+                          },
+                          "slaType": {
+                            "type": "string",
+                            "description": "SLA (Service Level Agreement) type."
+                          },
+                          "slaTypeName": {
+                            "type": "string",
+                            "description": "SLA name."
+                          },
+                          "freightTableName": {
+                            "type": "string",
+                            "description": "[Shipping rate template](https://help.vtex.com/en/tutorial/shipping-rate-template--tutorials_127) name."
+                          },
+                          "freightTableId": {
+                            "type": "string",
+                            "description": "Shipping rate template ID."
+                          },
+                          "listPrice": {
+                            "type": "number",
+                            "description": "List price."
+                          },
+                          "promotionalPrice": {
+                            "type": "number",
+                            "description": "Promotion price."
+                          },
+                          "transitTime": {
+                            "type": "string",
+                            "description": "Transit time in the format `DD.HH:MM:SS`."
+                          },
+                          "dockTime": {
+                            "type": "string",
+                            "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) processing time in the format `D.HH:MM:SS`. When it was not configured, it returns `00:00:00`."
+                          },
+                          "timeToDockPlusDockTime": {
+                            "type": "string",
+                            "description": "Time spent in loading dock plus `dockTime` in the format `D.HH:MM:SS`."
+                          },
+                          "totalTime": {
+                            "type": "string",
+                            "description": "SLA total time in the format `DD.HH:MM:SS`."
+                          },
+                          "deliveryWindows": {
+                            "type": "object",
+                            "items": {
+                              "type": "object",
+                              "description": "Delivery window details.",
+                              "properties": {
+                                "startDateUtc": {
+                                  "type": "string",
+                                  "description": "Delivery window starting date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`."
+                                },
+                                "endDateUtc": {
+                                  "type": "string",
+                                  "description": "Delivery window ending date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`."
+                                },
+                                "listPrice": {
+                                  "type": "number",
+                                  "description": "List price."
+                                }
+                              }
+                            },
+                            "description": "[Delivery windows](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz).",
+                            "nullable": true
+                          },
+                          "wareHouseId": {
+                            "type": "string",
+                            "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID."
+                          },
+                          "dockId": {
+                            "type": "string",
+                            "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID."
+                          },
+                          "wmsEndPoint": {
+                            "type": "string",
+                            "description": "Warehouse Management System (WMS) fulfillment endpoint.",
+                            "nullable": true
+                          },
+                          "location": {
+                            "type": "object",
+                            "description": "Shipping location information.",
+                            "properties": {
+                              "zipCode": {
+                                "type": "string",
+                                "description": "Shipping address postal code."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three-digit country code of the shipping address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format."
+                              },
+                              "deliveryPointId": {
+                                "type": "string",
+                                "description": "Delivery point ID.",
+                                "nullable": true
+                              },
+                              "point": {
+                                "type": "array",
+                                "description": "Location delivery point coordinates.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Location coordinates, first longitude, then latitude."
+                                },
+                                "nullable": true
+                              },
+                              "inStore": {
+                                "type": "object",
+                                "description": "Information related to [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc).",
+                                "properties": {
+                                  "IsCheckedIn": {
+                                    "type": "boolean",
+                                    "description": "This field is set as `true` when the order was placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) and `false` when it was not."
+                                  },
+                                  "StoreId": {
+                                    "type": "string",
+                                    "description": "ID of purchases made in the GoCommerce context.",
+                                    "nullable": true
+                                  }
+                                }
+                              }
+                            }
+                          },
+                          "pickupStoreInfo": {
+                            "type": "string",
+                            "description": "Detailed information about a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).",
+                            "nullable": true
+                          }
+                        }
+                      }
+                    },
+                    "PickupPointItemOptions": {
+                      "type": "string",
+                      "description": "(Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) item options.",
+                      "nullable": true
+                    },
+                    "CanceledDateUtc": {
+                      "type": "string",
+                      "description": "Reservation canceled date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`."
+                    },
+                    "AuthorizedDateUtc": {
+                      "type": "string",
+                      "description": "Authorized date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`."
+                    },
+                    "ConfirmedDateUtc": {
+                      "type": "string",
+                      "description": "Confirmed date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`."
+                    },
+                    "Errors": {
+                      "type": "array",
+                      "description": "Errors details, if there are any.",
+                      "items": {
+                        "type": "string",
+                        "description": "Error message.",
+                        "nullable": true
+                      },
+                      "nullable": true
+                    },
+                    "IsSucess": {
+                      "type": "boolean",
+                      "description": "Defines if the reservation was successful (`true`) or not (`false`)."
+                    }
+                  }
+                },
+                "example": {
+                  "LastUpdateDateUtc": "2024-04-15T19:59:20.0397988+00:00",
+                  "SalesChannel": "1",
+                  "LockId": "3bfe679d-c0a8-475a-b315-706f84a9deb4",
+                  "ReservationDateUtc": "2024-04-15T19:59:20.0397988+00:00",
+                  "MaximumConfirmationDateUtc": "2024-04-15T20:09:20.0397988+00:00",
+                  "Status": 1,
+                  "SlaRequest": [
+                    {
+                      "item": {
+                        "id": "29",
+                        "groupItemId": null,
+                        "quantity": 1,
+                        "price": 0,
+                        "modal": "FURNITURE",
+                        "additionalHandlingTime": "00:00:00",
+                        "dimension": {
+                          "weight": 186.37,
+                          "height": 23.5,
+                          "width": 165,
+                          "length": 67.5,
+                          "maxSumDimension": 300
+                        },
+                        "kitItem": [],
+                        "unlimitedQuantity": false
+                      },
+                      "slaType": "delivery",
+                      "slaTypeName": "Normal delivery",
+                      "freightTableName": "Correios PAC",
+                      "freightTableId": "11cc4b6",
+                      "listPrice": 10.5,
+                      "promotionalPrice": 10.5,
+                      "transitTime": "2.00:00:00",
+                      "dockTime": "00:00:00",
+                      "timeToDockPlusDockTime": "1.00:00:00",
+                      "totalTime": "3.00:00:00",
+                      "deliveryWindows": {
+                        "startDateUtc": "2024-02-25T09:00:00+00:00",
+                        "endDateUtc": "2024-02-25T12:00:00+00:00",
+                        "listPrice": 0
+                      },
+                      "wareHouseId": "1937054",
+                      "dockId": "1a8bce3",
+                      "wmsEndPoint": null,
+                      "location": {
+                        "zipCode": "22220070",
+                        "country": "BRA",
+                        "deliveryPointId": null,
+                        "point": null,
+                        "inStore": {
+                          "IsCheckedIn": false,
+                          "StoreId": "180082"
+                        }
+                      },
+                      "pickupStoreInfo": null
+                    }
+                  ],
+                  "PickupPointItemOptions": null,
+                  "CanceledDateUtc": "0001-01-01T00:00:00+00:00",
+                  "AuthorizedDateUtc": "2024-04-15T19:59:20.0397988+00:00",
+                  "ConfirmedDateUtc": "0001-01-01T00:00:00+00:00",
+                  "Errors": [],
+                  "IsSucess": true
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/inventory/reservations/{reservationId}": {
+      "get": {
+        "tags": [
+          "Reservations"
+        ],
+        "summary": "List reservation by ID",
+        "description": "Lists information about a [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92), searching by reservation ID.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "ReservationById",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "reservationId",
+            "in": "path",
+            "description": "[Reservation](https://help.vtex.com/en/tutorial/how-the-reservation-works--tutorials_92) ID.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "00-1336411707838-01"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "LastUpdateDateUtc": {
+                      "type": "string",
+                      "description": "Last update date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`."
+                    },
+                    "SalesChannel": {
+                      "type": "string",
+                      "description": "Sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) valid for the reservation."
+                    },
+                    "LockId": {
+                      "type": "string",
+                      "description": "Reservation ID."
+                    },
+                    "ReservationDateUtc": {
+                      "type": "string",
+                      "description": "Reservation date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`."
+                    },
+                    "MaximumConfirmationDateUtc": {
+                      "type": "string",
+                      "description": "Maximum confirmation date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`."
+                    },
+                    "Status": {
+                      "type": "integer",
+                      "format": "int32",
+                      "description": "Reservation status, meaning:\r\n\r\n- `0`: `NotCommitted`\r\n\r\n- `1`: `Authorized`\r\n\r\n- `2`: `Confirmed`\r\n\r\n- `3`: `Canceled_AbortedCommitted`\r\n\r\n- `4`: `Canceled_AuthorizationExpired`\r\n\r\n- `5`: `Canceled_Manually`"
+                    },
+                    "SlaRequest": {
+                      "type": "array",
+                      "description": "SLA (Service Level Agreement) request information.",
+                      "items": {
+                        "type": "object",
+                        "description": "SLA details.",
+                        "properties": {
+                          "item": {
+                            "type": "object",
+                            "description": "Information about the reserved item.",
+                            "properties": {
+                              "id": {
+                                "type": "string",
+                                "description": "SKU ID."
+                              },
+                              "groupItemId": {
+                                "type": "string",
+                                "description": "Group item ID.",
+                                "nullable": true
+                              },
+                              "quantity": {
+                                "type": "integer",
+                                "format": "int32",
+                                "description": "Item quantity."
+                              },
+                              "price": {
+                                "type": "number",
+                                "description": "Item price."
+                              },
+                              "modal": {
+                                "type": "string",
+                                "description": "Type of [modal](https://help.vtex.com/en/tutorial/how-the-modal-works--tutorials_125), a special freight.",
+                                "enum": [
+                                  "CHEMICALS",
+                                  "ELECTRONICS",
+                                  "FURNITURE",
+                                  "GLASS",
+                                  "LIQUID",
+                                  "MATTRESSES",
+                                  "REFRIGERATED",
+                                  "TIRES",
+                                  "WHITE_GOODS",
+                                  "FIREARMS"
+                                ],
+                                "nullable": true
+                              },
+                              "additionalHandlingTime": {
+                                "type": "string",
+                                "description": "Additional handling time in the format `DD.HH:MM:SS`."
+                              },
+                              "dimension": {
+                                "type": "object",
+                                "description": "Item dimensions.",
+                                "properties": {
+                                  "weight": {
+                                    "type": "number",
+                                    "description": "Item weight."
+                                  },
+                                  "height": {
+                                    "type": "number",
+                                    "description": "Item height."
+                                  },
+                                  "width": {
+                                    "type": "number",
+                                    "description": "Item width."
+                                  },
+                                  "length": {
+                                    "type": "number",
+                                    "description": "Item length."
+                                  },
+                                  "maxSumDimension": {
+                                    "type": "number",
+                                    "description": "Maximum sum of dimensions."
+                                  }
+                                }
+                              },
+                              "kitItem": {
+                                "type": "array",
+                                "nullable": true,
+                                "items": {
+                                  "type": "string",
+                                  "description": "Kit SKU ID."
+                                },
+                                "description": "[Kit](https://help.vtex.com/en/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) item information."
+                              },
+                              "unlimitedQuantity": {
+                                "type": "boolean",
+                                "description": "When set as `false`, every sold unit decreases the item's available quantity. When set as `true`, the SKU from the warehouse is always available for sale — no matter how many units are sold, the SKU available quantity never decreases, and the SKU is never out of stock."
+                              },
+                              "dockId": {
+                                "type": "string",
+                                "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID."
+                              },
+                              "wareHouseId": {
+                                "type": "string",
+                                "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID."
+                              },
+                              "provider": {
+                                "type": "string",
+                                "description": "SLA request provider.",
+                                "nullable": true
+                              }
+                            }
+                          },
+                          "slaType": {
+                            "type": "string",
+                            "description": "SLA (Service Level Agreement) type."
+                          },
+                          "slaTypeName": {
+                            "type": "string",
+                            "description": "SLA name."
+                          },
+                          "freightTableName": {
+                            "type": "string",
+                            "description": "[Shipping rate template](https://help.vtex.com/en/tutorial/shipping-rate-template--tutorials_127) name."
+                          },
+                          "freightTableId": {
+                            "type": "string",
+                            "description": "Shipping rate template ID."
+                          },
+                          "listPrice": {
+                            "type": "number",
+                            "description": "List price."
+                          },
+                          "promotionalPrice": {
+                            "type": "number",
+                            "description": "Promotion price."
+                          },
+                          "timeToPresale": {
+                            "type": "string",
+                            "description": "Time to presale in the format `D.HH:MM:SS`."
+                          },
+                          "transitTime": {
+                            "type": "string",
+                            "description": "Transit time in the format `DD.HH:MM:SS`."
+                          },
+                          "dockTime": {
+                            "type": "string",
+                            "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) processing time in the format `D.HH:MM:SS`. When it was not configured, it returns `00:00:00`."
+                          },
+                          "timeToDockPlusDockTime": {
+                            "type": "string",
+                            "description": "Time spent in loading dock plus `dockTime` in the format `D.HH:MM:SS`."
+                          },
+                          "totalTime": {
+                            "type": "string",
+                            "description": "SLA total time in the format `DD.HH:MM:SS`."
+                          },
+                          "deliveryWindows": {
+                            "type": "object",
+                            "items": {
+                              "type": "object",
+                              "description": "Delivery window details.",
+                              "properties": {
+                                "startDateUtc": {
+                                  "type": "string",
+                                  "description": "Delivery window starting date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`."
+                                },
+                                "endDateUtc": {
+                                  "type": "string",
+                                  "description": "Delivery window ending date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`."
+                                },
+                                "listPrice": {
+                                  "type": "number",
+                                  "description": "List price."
+                                }
+                              }
+                            },
+                            "description": "[Delivery windows](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz).",
+                            "nullable": true
+                          },
+                          "wareHouseId": {
+                            "type": "string",
+                            "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID."
+                          },
+                          "kitReservation": {
+                            "type": "string",
+                            "description": "Kit reservation.",
+                            "nullable": true
+                          },
+                          "dockId": {
+                            "type": "string",
+                            "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID."
+                          },
+                          "wmsEndPoint": {
+                            "type": "string",
+                            "description": "Warehouse Management System (WMS) fulfillment endpoint.",
+                            "nullable": true
+                          },
+                          "location": {
+                            "type": "object",
+                            "description": "Shipping location information.",
+                            "properties": {
+                              "zipCode": {
+                                "type": "string",
+                                "description": "Shipping address postal code."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three-digit country code of the shipping address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format."
+                              },
+                              "point": {
+                                "type": "array",
+                                "description": "Location delivery point coordinates.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Location coordinates, first longitude, then latitude."
+                                },
+                                "nullable": true
+                              },
+                              "inStore": {
+                                "type": "object",
+                                "description": "Information related to [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc).",
+                                "properties": {
+                                  "IsCheckedIn": {
+                                    "type": "boolean",
+                                    "description": "This field is set as `true` when the order was placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) and `false` when it was not."
+                                  },
+                                  "StoreId": {
+                                    "type": "string",
+                                    "description": "ID of purchases made in the GoCommerce context.",
+                                    "nullable": true
+                                  }
+                                }
+                              }
+                            }
+                          },
+                          "pickupStoreInfo": {
+                            "type": "string",
+                            "description": "Detailed information about a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).",
+                            "nullable": true
+                          },
+                          "deliveryOnWeekends": {
+                            "type": "boolean",
+                            "description": "Defines if the delivery on weekends configuration is active (`true`) or not (`false`).",
+                            "nullable": true
+                          },
+                          "weekendAndHolidays": {
+                            "type": "object",
+                            "description": "Delivery on weekends and holidays information.",
+                            "properties": {
+                              "saturday": {
+                                "type": "boolean",
+                                "description": "Defines if the delivery on Saturday configuration is active (`true`) or not (`false`)."
+                              },
+                              "sunday": {
+                                "type": "boolean",
+                                "description": "Defines if the delivery on Sunday configuration is active (`true`) or not (`false`)."
+                              },
+                              "holiday": {
+                                "type": "boolean",
+                                "description": "Defines if the delivery on [holiday](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) configuration is active (`true`) or not (`false`)."
+                              }
+                            }
+                          },
+                          "estimateDate": {
+                            "type": "string",
+                            "description": "Delivery estimate date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`."
+                          },
+                          "deliveryChannel": {
+                            "type": "string",
+                            "description": "Delivery channel."
+                          },
+                          "totalTimePlusCarrierSchedule": {
+                            "type": "string",
+                            "description": "Total shipping time plus carrier schedule, in the format `DD.HH:MM:SS`."
+                          },
+                          "polygonName": {
+                            "type": "string",
+                            "description": "[Polygon](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) name."
+                          },
+                          "distanceLevel": {
+                            "type": "string",
+                            "description": "SLA distance level.",
+                            "nullable": true
+                          },
+                          "accountCarrier": {
+                            "type": "string",
+                            "description": "Account carrier."
+                          },
+                          "dateOfSupplyUtc": {
+                            "type": "string",
+                            "description": "Supply date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.",
+                            "nullable": true
+                          },
+                          "supplyLotId": {
+                            "type": "string",
+                            "description": "Supply lot ID.",
+                            "nullable": true
+                          },
+                          "isExternal": {
+                            "type": "boolean",
+                            "description": "Defines if the SLA request is external (`true`) or not (`false`)."
+                          }
+                        }
+                      }
+                    },
+                    "CanceledDateUtc": {
+                      "type": "string",
+                      "description": "Reservation canceled date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`."
+                    },
+                    "AuthorizedDateUtc": {
+                      "type": "string",
+                      "description": "Authorized date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`."
+                    },
+                    "ConfirmedDateUtc": {
+                      "type": "string",
+                      "description": "Confirmed date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`."
+                    },
+                    "Errors": {
+                      "type": "array",
+                      "description": "Error details, if there are any.",
+                      "items": {
+                        "type": "string",
+                        "description": "Error message.",
+                        "nullable": true
+                      },
+                      "nullable": true
+                    },
+                    "IsSucess": {
+                      "type": "boolean",
+                      "description": "Defines if the reservation was successful (`true`) or not (`false`)."
+                    }
+                  }
+                },
+                "example": {
+                  "LastUpdateDateUtc": "2024-05-01T17:14:51.5898912+00:00",
+                  "SalesChannel": "1",
+                  "LockId": "00-1336411707838-01",
+                  "ReservationDateUtc": "2024-05-01T17:14:40.4900134+00:00",
+                  "MaximumConfirmationDateUtc": "2024-06-13T17:14:40.4900134+00:00",
+                  "Status": 2,
+                  "SlaRequest": [
+                    {
+                      "item": {
+                        "id": "229",
+                        "groupItemId": null,
+                        "quantity": 1,
+                        "price": 5,
+                        "modal": "FURNITURE",
+                        "additionalHandlingTime": "00:00:00",
+                        "dimension": {
+                          "weight": 186.37,
+                          "height": 23.5,
+                          "width": 165,
+                          "length": 67.5,
+                          "maxSumDimension": 300
+                        },
+                        "kitItem": [],
+                        "unlimitedQuantity": false,
+                        "dockId": "dk_temp",
+                        "warehouseId": "wh_temp",
+                        "provider": null
+                      },
+                      "slaType": "delivery",
+                      "slaTypeName": "Normal delivery",
+                      "freightTableName": "Correios PAC",
+                      "freightTableId": "11cc4b6",
+                      "listPrice": 10.35,
+                      "promotionalPrice": 10.35,
+                      "timeToPresale": "00:00:00",
+                      "transitTime": "1.00:00:00",
+                      "dockTime": "00:00:00",
+                      "timeToDockPlusDockTime": "00:00:00",
+                      "totalTime": "1.00:00:00",
+                      "deliveryWindows": {
+                        "startDateUtc": "2024-02-25T09:00:00+00:00",
+                        "endDateUtc": "2024-02-25T12:00:00+00:00",
+                        "listPrice": 0
+                      },
+                      "wareHouseId": "wh_temp",
+                      "kitReservation": null,
+                      "dockId": "dk_temp",
+                      "wmsEndPoint": null,
+                      "location": {
+                        "zipCode": "58039210",
+                        "country": "BRA",
+                        "point": [
+                          -34.82939147949219,
+                          -7.115228652954102
+                        ],
+                        "inStore": {
+                          "isCheckedIn": false,
+                          "storeId": "180082"
+                        }
+                      },
+                      "pickupStoreInfo": null,
+                      "deliveryOnWeekends": true,
+                      "weekendAndHolidays": {
+                        "saturday": true,
+                        "sunday": true,
+                        "holiday": true
+                      },
+                      "estimateDate": "2024-05-02T17:14:51.5742729+00:00",
+                      "deliveryChannel": "delivery",
+                      "totalTimePlusCarrierSchedule": "1.00:00:00",
+                      "polygonName": "centerlRio",
+                      "distanceLevel": null,
+                      "accountCarrier": "recorrenciaqa",
+                      "dateOfSupplyUtc": null,
+                      "supplyLotId": null,
+                      "isExternal": false
+                    }
+                  ],
+                  "CanceledDateUtc": "0001-01-01T00:00:00+00:00",
+                  "AuthorizedDateUtc": "2024-05-01T17:14:40.4900134+00:00",
+                  "ConfirmedDateUtc": "2024-05-01T17:14:51.5898912+00:00",
+                  "Errors": [],
+                  "IsSucess": true
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/inventory/reservations/{reservationId}/confirm": {
+      "post": {
+        "tags": [
+          "Reservations"
+        ],
+        "summary": "Confirm reservation",
+        "description": "Confirms a [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92), searching by reservation ID.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "ConfirmReservation",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "reservationId",
+            "in": "path",
+            "description": "[Reservation](https://help.vtex.com/en/tutorial/how-the-reservation-works--tutorials_92) ID.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "00-1336411707838-01"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/inventory/reservations/{reservationId}/acknowledge": {
+      "post": {
+        "tags": [
+          "Reservations"
+        ],
+        "summary": "Acknowledgment reservation",
+        "description": "Acknowledges a [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92), searching by reservation ID.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "AcknowledgmentReservation",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "reservationId",
+            "in": "path",
+            "description": "[Reservation](https://help.vtex.com/en/tutorial/how-the-reservation-works--tutorials_92) ID.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "00-1336411707838-01"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/inventory/reservations/{reservationId}/cancel": {
+      "post": {
+        "tags": [
+          "Reservations"
+        ],
+        "summary": "Cancel reservation",
+        "description": "Cancels a [reservation](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92), searching by reservation ID.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "CancelReservation",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "reservationId",
+            "in": "path",
+            "description": "[Reservation](https://help.vtex.com/en/tutorial/how-the-reservation-works--tutorials_92) ID.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "00-1336411707838-01"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/inventory/reservations/{warehouseId}/{skuId}": {
+      "get": {
+        "tags": [
+          "Reservations"
+        ],
+        "summary": "List reservation by warehouse and SKU",
+        "description": "Lists information about [reservations](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92), searching by a given [warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID and SKU ID.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "ReservationbyWarehouseandSku",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "warehouseId",
+            "in": "path",
+            "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "whs15hs6c"
+            }
+          },
+          {
+            "name": "skuId",
+            "in": "path",
+            "description": "SKU ID.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "36"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/shipping/calculate": {
+      "post": {
+        "tags": [
+          "SLA"
+        ],
+        "summary": "Calculate SLA",
+        "description": "Checkout uses this endpoint to calculate a Service Level Agreement (SLA), a contract between the store and a customer about their order fulfillment conditions, such as the shipping estimated date.\r\n\r\nThe calculation of the estimated date considers the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) and [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) related to the order.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "CalculateSLA",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "description": "Shipping conditions to calculate the Service Level Agreement (SLA).",
+                  "required": [
+                    "items",
+                    "location"
+                  ],
+                  "properties": {
+                    "items": {
+                      "type": "array",
+                      "description": "Items' shipping conditions to calculate the Service Level Agreement (SLA).",
+                      "items": {
+                        "type": "object",
+                        "description": "Item's information.",
+                        "required": [
+                          "id",
+                          "quantity",
+                          "dimension"
+                        ],
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "SKU ID.",
+                            "example": "1"
+                          },
+                          "quantity": {
+                            "type": "integer",
+                            "format": "int32",
+                            "description": "SKU quantity.",
+                            "example": 1
+                          },
+                          "price": {
+                            "type": "number",
+                            "description": "Item price.",
+                            "example": 14128.9,
+                            "nullable": true
+                          },
+                          "modal": {
+                            "type": "string",
+                            "description": "[Modal](https://help.vtex.com/en/tutorial/how-the-modal-works--tutorials_125) is a special freight.",
+                            "enum": [
+                              "CHEMICALS",
+                              "ELECTRONICS",
+                              "FURNITURE",
+                              "GLASS",
+                              "LIQUID",
+                              "MATTRESSES",
+                              "REFRIGERATED",
+                              "TIRES",
+                              "WHITE_GOODS",
+                              "FIREARMS"
+                            ],
+                            "example": "FURNITURE",
+                            "nullable": true
+                          },
+                          "additionalHandlingTime": {
+                            "type": "string",
+                            "description": "Additional handling time in the format `DD.HH:MM:SS`.",
+                            "example": "00:00:00"
+                          },
+                          "dimension": {
+                            "type": "object",
+                            "description": "Item dimensions.",
+                            "properties": {
+                              "weight": {
+                                "type": "number",
+                                "description": "Item weight.",
+                                "example": 86.37
+                              },
+                              "height": {
+                                "type": "number",
+                                "description": "Item height.",
+                                "example": 23.5
+                              },
+                              "width": {
+                                "type": "number",
+                                "description": "Item width.",
+                                "example": 65
+                              },
+                              "length": {
+                                "type": "number",
+                                "description": "Item length.",
+                                "example": 67.5
+                              },
+                              "maxSumDimension": {
+                                "type": "number",
+                                "description": "Maximum sum of dimensions.",
+                                "example": 243.9
+                              }
+                            }
+                          },
+                          "kitItem": {
+                            "type": "array",
+                            "description": "[Kit](https://help.vtex.com/en/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) item information.",
+                            "items": {
+                              "type": "object",
+                              "description": "Kit item object.",
+                              "required": [
+                                "id",
+                                "quantity",
+                                "dimension"
+                              ],
+                              "properties": {
+                                "id": {
+                                  "type": "string",
+                                  "description": "Kit SKU ID.",
+                                  "example": "2"
+                                },
+                                "groupItemId": {
+                                  "type": "string",
+                                  "description": "Kit group item ID.",
+                                  "example": null,
+                                  "nullable": true
+                                },
+                                "kitItem": {
+                                  "type": "array",
+                                  "description": "Kit item list.",
+                                  "items": {
+                                    "type": "string",
+                                    "description": "Kit items' IDs.",
+                                    "example": "1"
+                                  },
+                                  "nullable": true
+                                },
+                                "quantity": {
+                                  "type": "integer",
+                                  "format": "int32",
+                                  "description": "Kit SKU quantity.",
+                                  "example": 1
+                                },
+                                "price": {
+                                  "type": "number",
+                                  "description": "Kit SKU price.",
+                                  "example": 1
+                                },
+                                "additionalHandlingTime": {
+                                  "type": "string",
+                                  "description": "Kit item additional handling time in the format `DD.HH:MM:SS`.",
+                                  "example": "00:00:00"
+                                },
+                                "dimension": {
+                                  "type": "object",
+                                  "description": "Kit item dimensions.",
+                                  "properties": {
+                                    "weight": {
+                                      "type": "number",
+                                      "description": "Kit item weight.",
+                                      "example": 1
+                                    },
+                                    "height": {
+                                      "type": "number",
+                                      "description": "Kit item height.",
+                                      "example": 1
+                                    },
+                                    "width": {
+                                      "type": "number",
+                                      "description": "Kit item width.",
+                                      "example": 1
+                                    },
+                                    "length": {
+                                      "type": "number",
+                                      "description": "Kit item length.",
+                                      "example": 1
+                                    },
+                                    "maxSumDimension": {
+                                      "type": "number",
+                                      "description": "Maximum sum of dimensions.",
+                                      "example": 5
+                                    }
+                                  }
+                                }
+                              }
+                            },
+                            "nullable": true
+                          },
+                          "dockId": {
+                            "type": "string",
+                            "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID.",
+                            "example": "1a8bce3",
+                            "nullable": true
+                          },
+                          "wareHouseId": {
+                            "type": "string",
+                            "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID.",
+                            "example": "1937054",
+                            "nullable": true
+                          }
+                        }
+                      }
+                    },
+                    "location": {
+                      "type": "object",
+                      "description": "Shipping location information.",
+                      "required": [
+                        "zipCode",
+                        "country"
+                      ],
+                      "properties": {
+                        "zipCode": {
+                          "type": "string",
+                          "description": "Shipping adress postal code.",
+                          "example": "22780084"
+                        },
+                        "country": {
+                          "type": "string",
+                          "description": "Three-digit country code of the shipping address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.",
+                          "example": "BRA"
+                        },
+                        "point": {
+                          "type": "array",
+                          "description": "Shipping address coordinates, first longitude then latitude.",
+                          "items": {
+                            "type": "number",
+                            "description": "Longitude or latitude.",
+                            "example": -43.23171615600586
+                          },
+                          "example": [
+                            -43.23171615600586,
+                            -22.990713500405295
+                          ]
+                        },
+                        "inStore": {
+                          "type": "object",
+                          "description": "Information related to [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc).",
+                          "properties": {
+                            "IsCheckedIn": {
+                              "type": "boolean",
+                              "description": "This field is set as `true` when the order is placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) and `false` when it is not.",
+                              "example": false
+                            },
+                            "StoreId": {
+                              "type": "string",
+                              "description": "ID of purchases made in the GoCommerce context.",
+                              "example": "180082",
+                              "nullable": true
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "salesChannel": {
+                      "type": "string",
+                      "description": "Sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) valid for the SLA calculation.",
+                      "example": "1"
+                    },
+                    "deliveryChannel": {
+                      "type": "string",
+                      "description": "Defines if the shipping type is `delivery` or `pickup`.",
+                      "example": "delivery",
+                      "nullable": true
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "type": "array",
+                    "description": "List of Service Level Agreements (SLA).",
+                    "items": {
+                      "type": "object",
+                      "description": "Service Level Agreements (SLA) conditions.",
+                      "properties": {
+                        "itemId": {
+                          "type": "string",
+                          "description": "SKU ID."
+                        },
+                        "quantity": {
+                          "type": "integer",
+                          "format": "int32",
+                          "description": "SKU quantity."
+                        },
+                        "kitItem": {
+                          "type": "array",
+                          "description": "[Kit](https://help.vtex.com/en/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28) items' information.",
+                          "items": {
+                            "type": "object",
+                            "description": "Kit item object.",
+                            "properties": {
+                              "id": {
+                                "type": "string",
+                                "description": "Kit SKU ID."
+                              },
+                              "quantity": {
+                                "type": "integer",
+                                "description": "Kit SKU quantity."
+                              },
+                              "warehouseId": {
+                                "type": "string",
+                                "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID where the kit SKU is stored."
+                              },
+                              "supplyLotId": {
+                                "type": "string",
+                                "description": "Kit SKU supply lot ID.",
+                                "nullable": true
+                              }
+                            }
+                          }
+                        },
+                        "availabilityQuantity": {
+                          "type": "integer",
+                          "format": "int32",
+                          "description": "SKU quantity available for sales. [Reserved](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92) items do not count."
+                        },
+                        "salesChannel": {
+                          "type": "string",
+                          "description": "Sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) valid for the SLA calculation."
+                        },
+                        "slaType": {
+                          "type": "string",
+                          "description": "Service Level Agreement (SLA) type."
+                        },
+                        "slaTypeName": {
+                          "type": "string",
+                          "description": "Service Level Agreement (SLA) name."
+                        },
+                        "freightTableName": {
+                          "type": "string",
+                          "description": "[Shipping rate template](https://help.vtex.com/en/tutorial/shipping-rate-template--tutorials_127) name."
+                        },
+                        "freightTableId": {
+                          "type": "string",
+                          "description": "Shipping rate template ID."
+                        },
+                        "listPrice": {
+                          "type": "number",
+                          "description": "SKU list price."
+                        },
+                        "transitTime": {
+                          "type": "string",
+                          "description": "Transit time in the format `DD.HH:MM:SS`."
+                        },
+                        "dockTime": {
+                          "type": "string",
+                          "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) processing time in the format `D.HH:MM:SS`. When it was not configured, it returns `00:00:00`."
+                        },
+                        "timeToDockPlusDockTime": {
+                          "type": "string",
+                          "description": "Time spent in loading dock plus `dockTime` in the format `D.HH:MM:SS`."
+                        },
+                        "aditionalTimeBlockedDays": {
+                          "type": "string",
+                          "description": "Additional time blocked in the format `DD.HH:MM:SS`."
+                        },
+                        "leadTime": {
+                          "type": "string",
+                          "description": "[Lead time](https://help.vtex.com/en/tutorial/lead-time-shipping-time-at-sku-level--16yv5Mkj6bTyWR1hCN2f4B) is an optional time configuration for a SKU in a warehouse. It can be handling time, fabrication or how long it takes for the item to be available to be shipped to customers. The lead time is a part of the total shipping time and is considered for shipping date calculation. The format is `DD.HH:MM:SS`."
+                        },
+                        "totalTime": {
+                          "type": "string",
+                          "description": "SLA total time in the format `DD.HH:MM:SS`."
+                        },
+                        "deliveryWindows": {
+                          "type": "array",
+                          "description": "[Delivery windows](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz) configurations.",
+                          "items": {
+                            "type": "object",
+                            "description": "Delivery window details.",
+                            "properties": {
+                              "startDateUtc": {
+                                "type": "string",
+                                "description": "Delivery window starting date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`."
+                              },
+                              "endDateUtc": {
+                                "type": "string",
+                                "description": "Delivery window ending date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`."
+                              },
+                              "listPrice": {
+                                "type": "number",
+                                "description": "List price."
+                              }
+                            }
+                          }
+                        },
+                        "wareHouseId": {
+                          "type": "string",
+                          "description": "[Warehouse](https://help.vtex.com/en/tutorial/warehouse--6oIxvsVDTtGpO7y6zwhGpb) ID."
+                        },
+                        "dockId": {
+                          "type": "string",
+                          "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID."
+                        },
+                        "location": {
+                          "type": "object",
+                          "description": "Shipping location information.",
+                          "properties": {
+                            "zipCode": {
+                              "type": "string",
+                              "description": "Shipping adress postal code."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Three-digit country code of the shipping address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format."
+                            },
+                            "point": {
+                              "type": "array",
+                              "description": "Shipping address coordinates, first longitude then latitude.",
+                              "items": {
+                                "type": "number",
+                                "description": "Longitude or latitude."
+                              },
+                              "nullable": true
+                            },
+                            "inStore": {
+                              "type": "object",
+                              "description": "Information related to [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc).",
+                              "properties": {
+                                "isCheckedIn": {
+                                  "type": "boolean",
+                                  "description": "This field is set as `true` when the order is placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) and `false` when it is not."
+                                },
+                                "storeId": {
+                                  "type": "string",
+                                  "description": "ID of purchases made in the GoCommerce context.",
+                                  "nullable": true
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "deliveryOnWeekends": {
+                          "type": "boolean",
+                          "description": "Defines if the delivery on weekends configuration is active (`true`) or inactive (`false`)."
+                        },
+                        "weekendAndHolidays": {
+                          "type": "object",
+                          "description": "Delivery on weekends and holidays information.",
+                          "properties": {
+                            "saturday": {
+                              "type": "boolean",
+                              "description": "Defines if the delivery on Saturday configuration is active (`true`) or inactive (`false`)."
+                            },
+                            "sunday": {
+                              "type": "boolean",
+                              "description": "Defines if the delivery on Sunday configuration is active (`true`) or inactive (`false`)."
+                            },
+                            "holiday": {
+                              "type": "boolean",
+                              "description": "Defines if the delivery on [holiday](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) configuration is active (`true`) or inactive (`false`)."
+                            }
+                          },
+                          "nullable": true
+                        },
+                        "carrierSchedule": {
+                          "type": "array",
+                          "description": "Schedule sent by the carrier.",
+                          "items": {
+                            "type": "object",
+                            "description": "Carrier schedule object.",
+                            "properties": {
+                              "dayOfWeek": {
+                                "type": "integer",
+                                "description": "Day of the week, from `0` (Sunday) to `6` (Saturday).",
+                                "enum": [
+                                  0,
+                                  1,
+                                  2,
+                                  3,
+                                  4,
+                                  5,
+                                  6
+                                ]
+                              },
+                              "timeLimit": {
+                                "type": "string",
+                                "description": "Time limit."
+                              }
+                            }
+                          }
+                        },
+                        "totalTimePlusCarrierSchedule": {
+                          "type": "string",
+                          "description": "Total shipping time plus carrier schedule, in the format `DD.HH:MM:SS`."
+                        },
+                        "restrictedFreight": {
+                          "type": "array",
+                          "description": "List of postal codes where the delivery is restricted for the carrier.",
+                          "items": {
+                            "type": "string",
+                            "description": "Restricted freight postal code.",
+                            "nullable": true
+                          },
+                          "nullable": true
+                        },
+                        "coordinates": {
+                          "type": "array",
+                          "description": "Shipping address geolocation coordinates, first longitude then latitude.",
+                          "nullable": true,
+                          "items": {
+                            "type": "number",
+                            "description": "Longitude or latitude.",
+                            "nullable": true
+                          }
+                        },
+                        "pickupStoreInfo": {
+                          "type": "object",
+                          "description": "Information about a loading dock that was transformed into a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).",
+                          "deprecated": true,
+                          "properties": {
+                            "isPickupStore": {
+                              "type": "boolean",
+                              "description": "Defines if the shipping type was pickup (`true`) or not (`false`).",
+                              "nullable": true,
+                              "deprecated": true
+                            },
+                            "storeId": {
+                              "type": "string",
+                              "description": "Store ID for stores that acted as pickup points.",
+                              "nullable": true,
+                              "deprecated": true
+                            },
+                            "friendlyName": {
+                              "type": "string",
+                              "description": "Name of the pickup point displayed at checkout.",
+                              "nullable": true,
+                              "deprecated": true
+                            },
+                            "address": {
+                              "type": "object",
+                              "description": "Pickup point address information.",
+                              "nullable": true,
+                              "deprecated": true,
+                              "properties": {
+                                "postalCode": {
+                                  "type": "string",
+                                  "description": "Pickup point address postal code.",
+                                  "deprecated": true
+                                },
+                                "country": {
+                                  "type": "object",
+                                  "description": "Information about the pickup point address country.",
+                                  "deprecated": true,
+                                  "properties": {
+                                    "acronym": {
+                                      "type": "string",
+                                      "description": "Three-digit country code of the pickup point address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.",
+                                      "deprecated": true
+                                    },
+                                    "name": {
+                                      "type": "string",
+                                      "description": "Country name of the pickup point address.",
+                                      "deprecated": true
+                                    }
+                                  }
+                                },
+                                "city": {
+                                  "type": "string",
+                                  "description": "Pickup point address city.",
+                                  "deprecated": true
+                                },
+                                "state": {
+                                  "type": "string",
+                                  "description": "Pickup point address state.",
+                                  "deprecated": true
+                                },
+                                "neighborhood": {
+                                  "type": "string",
+                                  "description": "Pickup point address neighborhood.",
+                                  "deprecated": true
+                                },
+                                "street": {
+                                  "type": "string",
+                                  "description": "Pickup point address street.",
+                                  "deprecated": true
+                                },
+                                "number": {
+                                  "type": "string",
+                                  "description": "Pickup point address number.",
+                                  "deprecated": true
+                                },
+                                "complement": {
+                                  "type": "string",
+                                  "description": "Pickup point address complement.",
+                                  "deprecated": true,
+                                  "nullable": true
+                                },
+                                "reference": {
+                                  "type": "string",
+                                  "description": "Pickup point address reference point.",
+                                  "deprecated": true,
+                                  "nullable": true
+                                },
+                                "location": {
+                                  "type": "object",
+                                  "description": "Pickup point address geolocation coordinates.",
+                                  "deprecated": true,
+                                  "properties": {
+                                    "latitude": {
+                                      "type": "number",
+                                      "description": "Latitude coordinate.",
+                                      "deprecated": true
+                                    },
+                                    "longitude": {
+                                      "type": "number",
+                                      "description": "Longitude coordinate.",
+                                      "deprecated": true
+                                    }
+                                  }
+                                }
+                              }
+                            },
+                            "additionalInfo": {
+                              "type": "string",
+                              "description": "Additional information about the delivery or the pickup point.",
+                              "nullable": true,
+                              "deprecated": true
+                            },
+                            "dockId": {
+                              "type": "string",
+                              "description": "ID of the [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj related to the delivery or the pickup point ID.",
+                              "nullable": true,
+                              "deprecated": true
+                            },
+                            "distance": {
+                              "type": "number",
+                              "description": "Distance in kilometers between the pickup point and the customer's address, measured as a straight line.",
+                              "nullable": true,
+                              "deprecated": true
+                            },
+                            "businessHours": {
+                              "type": "string",
+                              "description": "Pickup point business hours configurations.",
+                              "nullable": true,
+                              "deprecated": true
+                            },
+                            "pickupHolidays": {
+                              "type": "string",
+                              "description": "Holiday's configurations applicable to the pickup point.",
+                              "nullable": true,
+                              "deprecated": true
+                            },
+                            "sellerId": {
+                              "type": "string",
+                              "description": "Seller ID.",
+                              "nullable": true,
+                              "deprecated": true
+                            },
+                            "isThirdPartyPickup": {
+                              "type": "boolean",
+                              "description": "Defines if the pickup was third party (`true`) or not (`false`).",
+                              "deprecated": true
+                            }
+                          }
+                        },
+                        "timeToPresale": {
+                          "type": "string",
+                          "description": "Time to presale in the format `DD.HH:MM:SS`."
+                        },
+                        "deliveryChannel": {
+                          "type": "string",
+                          "description": "Defines if the shipping type is `delivery` or `pickup`."
+                        },
+                        "availabilityQuantityByDeliveryChannel": {
+                          "type": "integer",
+                          "description": "Availability and quantity by the given delivery channel."
+                        },
+                        "polygonName": {
+                          "type": "string",
+                          "description": "[Polygon](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) ID (same as the polygon name)."
+                        },
+                        "distanceLevel": {
+                          "type": "string",
+                          "description": "SLA distance level."
+                        },
+                        "accountCarrier": {
+                          "type": "string",
+                          "description": "Account carrier."
+                        },
+                        "carrierBusinessHours": {
+                          "type": "array",
+                          "description": "Carrier business hours configurations for the week.",
+                          "items": {
+                            "type": "object",
+                            "description": "Carrier business hours configurations for a day of the week.",
+                            "properties": {
+                              "openingTime": {
+                                "type": "string",
+                                "description": "Carrier opening time in `HH:MM:SS` format."
+                              },
+                              "closingTime": {
+                                "type": "string",
+                                "description": "Carrier closing time in `HH:MM:SS` format."
+                              },
+                              "dayOfWeek": {
+                                "type": "integer",
+                                "description": "Day of the week, from `0` (Sunday) to `6` (Saturday).",
+                                "enum": [
+                                  0,
+                                  1,
+                                  2,
+                                  3,
+                                  4,
+                                  5,
+                                  6
+                                ]
+                              }
+                            }
+                          }
+                        },
+                        "provider": {
+                          "type": "string",
+                          "description": "Provider system.",
+                          "nullable": true
+                        },
+                        "dateOfSupplyUtc": {
+                          "type": "string",
+                          "description": "Supply date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`.",
+                          "nullable": true
+                        },
+                        "estimateDate": {
+                          "type": "string",
+                          "description": "Delivery estimate date and time in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`."
+                        },
+                        "supplyLotId": {
+                          "type": "string",
+                          "description": "Supply lot ID.",
+                          "nullable": true
+                        },
+                        "isExternal": {
+                          "type": "boolean",
+                          "description": "Defines if the SLA request is external (`true`) or not (`false`)."
+                        }
+                      }
+                    }
+                  }
+                },
+                "example": [
+                  [
+                    {
+                      "itemId": "1",
+                      "quantity": 2,
+                      "kitItem": [
+                        {
+                          "id": "1",
+                          "quantity": 1,
+                          "warehouseId": "wh-01",
+                          "supplyLotId": "05-05-22"
+                        }
+                      ],
+                      "availabilityQuantity": 3062340,
+                      "salesChannel": "1",
+                      "slaType": "Normal delivery",
+                      "slaTypeName": "Normal delivery",
+                      "freightTableName": "ft-01",
+                      "freightTableId": "ft-01",
+                      "listPrice": 12.12,
+                      "transitTime": "2.00:00:00",
+                      "dockTime": "00:00:00",
+                      "timeToDockPlusDockTime": "7.00:00:00",
+                      "aditionalTimeBlockedDays": "00:00:00",
+                      "leadTime": "00:00:00",
+                      "totalTime": "9.00:00:00",
+                      "deliveryWindows": [
+                        {
+                          "startDateUtc": "2024-07-25T00:00:00+00:00",
+                          "endDateUtc": "2024-07-25T23:59:59+00:00",
+                          "listPrice": 0
+                        }
+                      ],
+                      "wareHouseId": "wh-01",
+                      "dockId": "dock-01",
+                      "location": {
+                        "zipCode": "01239000",
+                        "country": "BRA",
+                        "point": null,
+                        "inStore": {
+                          "isCheckedIn": false,
+                          "storeId": null
+                        }
+                      },
+                      "deliveryOnWeekends": true,
+                      "weekendAndHolidays": null,
+                      "carrierSchedule": [],
+                      "totalTimePlusCarrierSchedule": "9.00:00:00",
+                      "restrictedFreight": null,
+                      "coordinates": null,
+                      "pickupStoreInfo": {
+                        "isPickupStore": false,
+                        "storeId": null,
+                        "friendlyName": null,
+                        "address": null,
+                        "additionalInfo": null,
+                        "dockId": null,
+                        "distance": 0,
+                        "businessHours": null,
+                        "pickupHolidays": null,
+                        "sellerId": "storefashion",
+                        "isThirdPartyPickup": false
+                      },
+                      "timeToPresale": "00:00:00",
+                      "deliveryChannel": "delivery",
+                      "availabilityQuantityByDeliveryChannel": 1012337,
+                      "polygonName": "ipanema_leblon",
+                      "distanceLevel": "",
+                      "accountCarrier": "storefashion",
+                      "carrierBusinessHours": [
+                        {
+                          "dayOfWeek": 1,
+                          "openingTime": "00:00:00",
+                          "closingTime": "23:59:59"
+                        },
+                        {
+                          "dayOfWeek": 2,
+                          "openingTime": "00:00:00",
+                          "closingTime": "23:59:59"
+                        },
+                        {
+                          "dayOfWeek": 3,
+                          "openingTime": "00:00:00",
+                          "closingTime": "23:59:59"
+                        },
+                        {
+                          "dayOfWeek": 4,
+                          "openingTime": "00:00:00",
+                          "closingTime": "23:59:59"
+                        },
+                        {
+                          "dayOfWeek": 5,
+                          "openingTime": "00:00:00",
+                          "closingTime": "23:59:59"
+                        },
+                        {
+                          "dayOfWeek": 6,
+                          "openingTime": "00:00:00",
+                          "closingTime": "23:59:59"
+                        },
+                        {
+                          "dayOfWeek": 0,
+                          "openingTime": "00:00:00",
+                          "closingTime": "23:59:59"
+                        }
+                      ],
+                      "provider": null,
+                      "dateOfSupplyUtc": null,
+                      "estimateDate": "2024-07-24T15:39:00-03:00",
+                      "supplyLotId": "05-05-22",
+                      "isExternal": false
+                    },
+                    {
+                      "itemId": "1",
+                      "quantity": 2,
+                      "kitItem": [
+                        {
+                          "id": "1",
+                          "quantity": 1,
+                          "warehouseId": "wh8735n",
+                          "supplyLotId": null
+                        }
+                      ],
+                      "availabilityQuantity": 3062340,
+                      "salesChannel": "1",
+                      "slaType": "Capacity",
+                      "slaTypeName": "Capacity",
+                      "freightTableName": "Delivery Capacity11",
+                      "freightTableId": "168e017",
+                      "listPrice": 2.02,
+                      "transitTime": "00:01:00",
+                      "dockTime": "00:00:00",
+                      "timeToDockPlusDockTime": "00:00:00",
+                      "aditionalTimeBlockedDays": "00:00:00",
+                      "leadTime": "00:00:00",
+                      "totalTime": "00:01:00",
+                      "deliveryWindows": [
+                        {
+                          "startDateUtc": "2024-07-16T00:00:00+00:00",
+                          "endDateUtc": "2024-07-16T23:59:59+00:00",
+                          "listPrice": 0
+                        },
+                        {
+                          "startDateUtc": "2024-07-16T09:00:00+00:00",
+                          "endDateUtc": "2024-07-16T10:59:59+00:00",
+                          "listPrice": 0
+                        },
+                        {
+                          "startDateUtc": "2024-07-17T00:00:00+00:00",
+                          "endDateUtc": "2024-07-17T23:59:59+00:00",
+                          "listPrice": 0
+                        },
+                        {
+                          "startDateUtc": "2024-07-17T09:00:00+00:00",
+                          "endDateUtc": "2024-07-17T10:59:59+00:00",
+                          "listPrice": 0
+                        },
+                        {
+                          "startDateUtc": "2024-07-18T00:00:00+00:00",
+                          "endDateUtc": "2024-07-18T23:59:59+00:00",
+                          "listPrice": 0
+                        },
+                        {
+                          "startDateUtc": "2024-07-18T09:00:00+00:00",
+                          "endDateUtc": "2024-07-18T10:59:59+00:00",
+                          "listPrice": 0
+                        }
+                      ],
+                      "wareHouseId": "wh8735n",
+                      "dockId": "d89vnwe",
+                      "location": {
+                        "zipCode": "01239000",
+                        "country": "BRA",
+                        "point": null,
+                        "inStore": {
+                          "isCheckedIn": false,
+                          "storeId": null
+                        }
+                      },
+                      "deliveryOnWeekends": true,
+                      "weekendAndHolidays": null,
+                      "carrierSchedule": [],
+                      "totalTimePlusCarrierSchedule": "00:01:00",
+                      "restrictedFreight": null,
+                      "coordinates": null,
+                      "pickupStoreInfo": {
+                        "isPickupStore": false,
+                        "storeId": null,
+                        "friendlyName": null,
+                        "address": null,
+                        "additionalInfo": null,
+                        "dockId": null,
+                        "distance": 0,
+                        "businessHours": null,
+                        "pickupHolidays": null,
+                        "sellerId": "logisticsqa",
+                        "isThirdPartyPickup": false
+                      },
+                      "timeToPresale": "00:00:00",
+                      "deliveryChannel": "delivery",
+                      "availabilityQuantityByDeliveryChannel": 1012337,
+                      "polygonName": "central_rio",
+                      "distanceLevel": "",
+                      "accountCarrier": "logisticsqa",
+                      "carrierBusinessHours": [
+                        {
+                          "dayOfWeek": 1,
+                          "openingTime": "00:00:00",
+                          "closingTime": "23:59:59"
+                        },
+                        {
+                          "dayOfWeek": 2,
+                          "openingTime": "00:00:00",
+                          "closingTime": "23:59:59"
+                        },
+                        {
+                          "dayOfWeek": 3,
+                          "openingTime": "00:00:00",
+                          "closingTime": "23:59:59"
+                        },
+                        {
+                          "dayOfWeek": 4,
+                          "openingTime": "00:00:00",
+                          "closingTime": "23:59:59"
+                        },
+                        {
+                          "dayOfWeek": 5,
+                          "openingTime": "00:00:00",
+                          "closingTime": "23:59:59"
+                        },
+                        {
+                          "dayOfWeek": 6,
+                          "openingTime": "00:00:00",
+                          "closingTime": "23:59:59"
+                        },
+                        {
+                          "dayOfWeek": 0,
+                          "openingTime": "00:00:00",
+                          "closingTime": "23:59:59"
+                        }
+                      ],
+                      "provider": null,
+                      "dateOfSupplyUtc": null,
+                      "estimateDate": "2024-07-15T15:40:00-03:00",
+                      "supplyLotId": null,
+                      "isExternal": false
+                    }
+                  ]
+                ]
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/configuration/pickuppoints": {
+      "get": {
+        "tags": [
+          "Pickup points"
+        ],
+        "summary": "List pickup points",
+        "description": "Retrieves information about your store [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).\r\n\r\n>⚠️ The response is limited to 1.000 pickup points. If you need more results, you can use the [List paged pickup points](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/configuration/pickuppoints/_search) endpoint.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "ListAllPickupPpoints",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "description": "List of pickup points, limited to 1.000 pickup points. If you need more than 1000 results, you can use the [List paged pickup points](https://developers.vtex.com/docs/api-reference/logistics-api#get-/api/logistics/pvt/configuration/pickuppoints/_search) endpoint.",
+                  "items": {
+                    "type": "object",
+                    "description": "Pickup point information.",
+                    "properties": {
+                      "id": {
+                        "type": "string",
+                        "description": "[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID."
+                      },
+                      "name": {
+                        "type": "string",
+                        "description": "Pickup point name displayed to customers at checkout."
+                      },
+                      "description": {
+                        "type": "string",
+                        "description": "Pickup point description displayed to customers at checkout."
+                      },
+                      "instructions": {
+                        "type": "string",
+                        "description": "Instructions for customers when collecting their package."
+                      },
+                      "formatted_address": {
+                        "type": "string",
+                        "description": "Formatted address.",
+                        "nullable": true
+                      },
+                      "address": {
+                        "type": "object",
+                        "description": "Pickup point address information.",
+                        "properties": {
+                          "postalCode": {
+                            "type": "string",
+                            "description": "Pickup point address postal code."
+                          },
+                          "country": {
+                            "type": "object",
+                            "description": "Information about the pickup point address country.",
+                            "properties": {
+                              "acronym": {
+                                "type": "string",
+                                "description": "Three-digit country code of the pickup point address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Country name of the pickup point address."
+                              }
+                            }
+                          },
+                          "city": {
+                            "type": "string",
+                            "description": "Pickup point address city."
+                          },
+                          "state": {
+                            "type": "string",
+                            "description": "Pickup point address state."
+                          },
+                          "neighborhood": {
+                            "type": "string",
+                            "description": "Pickup point address neighborhood."
+                          },
+                          "street": {
+                            "type": "string",
+                            "description": "Pickup point address street."
+                          },
+                          "number": {
+                            "type": "string",
+                            "description": "Pickup point address number."
+                          },
+                          "complement": {
+                            "type": "string",
+                            "description": "Pickup point address complement."
+                          },
+                          "reference": {
+                            "type": "string",
+                            "description": "Reference point to help the customer find the pickup point."
+                          },
+                          "location": {
+                            "type": "object",
+                            "description": "Pickup point address geolocation coordinates.",
+                            "properties": {
+                              "latitude": {
+                                "type": "number",
+                                "description": "Latitude coordinate."
+                              },
+                              "longitude": {
+                                "type": "number",
+                                "description": "Longitude coordinate."
+                              }
+                            }
+                          }
+                        }
+                      },
+                      "isActive": {
+                        "type": "boolean",
+                        "description": "Defines if the pickup point is active (`true`) or inactive (`false`)."
+                      },
+                      "distance": {
+                        "type": "number",
+                        "description": "Pickup point configured distance."
+                      },
+                      "seller": {
+                        "type": "string",
+                        "description": "Seller that corresponds to the pickup point."
+                      },
+                      "_sort": {
+                        "type": "array",
+                        "description": "Sort array.",
+                        "items": {
+                          "type": "number",
+                          "description": "Pickup point sort information."
+                        }
+                      },
+                      "businessHours": {
+                        "type": "array",
+                        "description": "Pickup point business hours configurations.",
+                        "items": {
+                          "type": "object",
+                          "description": "Business hours configurations from Monday to Friday.",
+                          "properties": {
+                            "dayOfWeek": {
+                              "type": "integer",
+                              "description": "Day of the week identification, as in `1` = Monday, `2` = Tuesday, `3` = Wednesday, `4` = Thursday, and `5` = Friday."
+                            },
+                            "openingTime": {
+                              "type": "string",
+                              "description": "Opening time in `HH:MM:SS` format."
+                            },
+                            "closingTime": {
+                              "type": "string",
+                              "description": "Closing time in `HH:MM:SS` format."
+                            }
+                          }
+                        }
+                      },
+                      "tagsLabel": {
+                        "type": "array",
+                        "description": "Tags that identify a group of pickup points.",
+                        "items": {
+                          "type": "string",
+                          "description": "Pickup point tag label."
+                        }
+                      },
+                      "pickupHolidays": {
+                        "type": "array",
+                        "description": "[Holidays](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) configured for the pickup point.",
+                        "items": {
+                          "type": "object",
+                          "description": "Holiday information.",
+                          "properties": {
+                            "date": {
+                              "type": "string",
+                              "description": "Holiday date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`."
+                            },
+                            "hourBegin": {
+                              "type": "string",
+                              "description": "Holiday beginning time in `HH:MM` format."
+                            },
+                            "hourEnd": {
+                              "type": "string",
+                              "description": "Holiday ending time in `HH:MM` format."
+                            }
+                          }
+                        }
+                      },
+                      "isThirdPartyPickup": {
+                        "type": "boolean",
+                        "description": "Defines if the pickup point is third-party (`true`) or not (`false`)."
+                      },
+                      "accountOwnerName": {
+                        "type": "string",
+                        "description": "Account owner name."
+                      },
+                      "accountOwnerId": {
+                        "type": "string",
+                        "description": "Account owner ID."
+                      },
+                      "parentAccountName": {
+                        "type": "string",
+                        "description": "Parent account name."
+                      },
+                      "originalId": {
+                        "type": "string",
+                        "description": "Original ID.",
+                        "nullable": true
+                      }
+                    }
+                  }
+                },
+                "example": [
+                  {
+                    "id": "b8e7ca56",
+                    "name": "Pickup Shopping Center",
+                    "description": "Shopping Center from Barra",
+                    "instructions": "You have to present a document to collect your package",
+                    "formatted_address": "undefined",
+                    "address": {
+                      "postalCode": "22250040",
+                      "country": {
+                        "acronym": "BRA",
+                        "name": "Brazil"
+                      },
+                      "city": "Rio de Janeiro",
+                      "state": "RJ",
+                      "neighborhood": "Botafogo",
+                      "street": "Botafogo beach",
+                      "number": "300",
+                      "complement": "Shopping Center",
+                      "reference": "Third floor",
+                      "location": {
+                        "latitude": -22.906847,
+                        "longitude": -43.172897
+                      }
+                    },
+                    "isActive": true,
+                    "distance": 0,
+                    "seller": "Fashion Skirts",
+                    "_sort": [
+                      1574240390000
+                    ],
+                    "businessHours": [
+                      {
+                        "dayOfWeek": 1,
+                        "openingTime": "09:00:00",
+                        "closingTime": "18:00:00"
+                      },
+                      {
+                        "dayOfWeek": 2,
+                        "openingTime": "09:00:00",
+                        "closingTime": "18:00:00"
+                      },
+                      {
+                        "dayOfWeek": 3,
+                        "openingTime": "09:00:00",
+                        "closingTime": "18:00:00"
+                      },
+                      {
+                        "dayOfWeek": 4,
+                        "openingTime": "09:00:00",
+                        "closingTime": "18:00:00"
+                      },
+                      {
+                        "dayOfWeek": 5,
+                        "openingTime": "09:00:00",
+                        "closingTime": "18:00:00"
+                      }
+                    ],
+                    "tagsLabel": [
+                      "w67",
+                      "p34"
+                    ],
+                    "pickupHolidays": [
+                      {
+                        "date": "2024-12-28T03:00:00Z",
+                        "hourBegin": "09:00",
+                        "hourEnd": "13:00"
+                      },
+                      {
+                        "date": "2024-11-17T03:00:00Z",
+                        "hourBegin": "00:00",
+                        "hourEnd": "00:00"
+                      }
+                    ],
+                    "isThirdPartyPickup": false,
+                    "accountOwnerName": "Fashion Store",
+                    "accountOwnerId": "1b4018ec-48bf-4a59-9eae-547403e11afc",
+                    "parentAccountName": "Fashion Store",
+                    "originalId": null
+                  },
+                  {
+                    "id": "792893547449051",
+                    "name": "Bleu PUP",
+                    "description": "Bleu Store",
+                    "instructions": "You must present a document to collect your order",
+                    "formatted_address": "undefined",
+                    "address": {
+                      "postalCode": "18550-000",
+                      "country": {
+                        "acronym": "BRA",
+                        "name": "Brasil"
+                      },
+                      "city": "Boituva",
+                      "state": "SP",
+                      "neighborhood": "Tancredo Neves",
+                      "street": "BTV-250",
+                      "number": "01",
+                      "complement": "Second floor",
+                      "reference": "Next to the city hall",
+                      "location": {
+                        "latitude": -23.2863329,
+                        "longitude": -47.6783742
+                      }
+                    },
+                    "isActive": true,
+                    "distance": 1574240387072,
+                    "seller": "Recurrency",
+                    "_sort": [
+                      1574240390000
+                    ],
+                    "businessHours": [
+                      {
+                        "dayOfWeek": 1,
+                        "openingTime": "09:00:00",
+                        "closingTime": "18:00:00"
+                      },
+                      {
+                        "dayOfWeek": 2,
+                        "openingTime": "09:00:00",
+                        "closingTime": "18:00:00"
+                      },
+                      {
+                        "dayOfWeek": 3,
+                        "openingTime": "09:00:00",
+                        "closingTime": "18:00:00"
+                      },
+                      {
+                        "dayOfWeek": 4,
+                        "openingTime": "09:00:00",
+                        "closingTime": "18:00:00"
+                      },
+                      {
+                        "dayOfWeek": 5,
+                        "openingTime": "09:00:00",
+                        "closingTime": "18:00:00"
+                      }
+                    ],
+                    "tagsLabel": [
+                      "kr47",
+                      "yk15"
+                    ],
+                    "pickupHolidays": [
+                      {
+                        "date": "2024-12-28T03:00:00Z",
+                        "hourBegin": "09:00",
+                        "hourEnd": "13:00"
+                      }
+                    ],
+                    "isThirdPartyPickup": false,
+                    "accountOwnerName": "sportsstore",
+                    "accountOwnerId": "9ddcfba5-3855-49ec-b61e-b2847b9314cc",
+                    "parentAccountName": "sportsstore",
+                    "originalId": "b8e7ca56"
+                  }
+                ]
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/configuration/pickuppoints/{pickupPointId}": {
+      "put": {
+        "tags": [
+          "Pickup points"
+        ],
+        "summary": "Create or update pickup point",
+        "description": "Creates or updates a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) of your store, searching by pickup point ID.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "CreateUpdatePickupPoint",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "pickupPointId",
+            "in": "path",
+            "description": "[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID. Cannot contain spaces.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "b8e7ca56"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "required": [
+                  "id",
+                  "name",
+                  "description",
+                  "instructions",
+                  "formatted_address",
+                  "address",
+                  "isActive",
+                  "businessHours",
+                  "tagsLabel"
+                ],
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string",
+                    "description": "[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID. Cannot contain spaces.",
+                    "example": "b8e7ca56"
+                  },
+                  "name": {
+                    "type": "string",
+                    "description": "Pickup point name displayed to customers at checkout.",
+                    "example": "Pickup store."
+                  },
+                  "description": {
+                    "type": "string",
+                    "description": "Pickup point description.",
+                    "example": "Pickup your items in our store."
+                  },
+                  "instructions": {
+                    "type": "string",
+                    "description": "Pickup point instructions.",
+                    "example": "Bring your ID in order to pickup your order."
+                  },
+                  "formatted_address": {
+                    "type": "string",
+                    "description": "Formatted address.",
+                    "example": "undefined"
+                  },
+                  "address": {
+                    "required": [
+                      "postalCode",
+                      "country",
+                      "city",
+                      "state",
+                      "neighborhood",
+                      "street",
+                      "number",
+                      "complement",
+                      "reference",
+                      "location"
+                    ],
+                    "type": "object",
+                    "description": "Pickup point address information.",
+                    "properties": {
+                      "postalCode": {
+                        "type": "string",
+                        "description": "Pickup point address postal code.",
+                        "example": "22070002"
+                      },
+                      "country": {
+                        "required": [
+                          "acronym",
+                          "name"
+                        ],
+                        "type": "object",
+                        "description": "Information about the pickup point address country.",
+                        "properties": {
+                          "acronym": {
+                            "type": "string",
+                            "description": "Three-digit country code of the pickup point address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.",
+                            "example": "BRA"
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Country name of the pickup point address.",
+                            "example": "Brazil"
+                          }
+                        }
+                      },
+                      "city": {
+                        "type": "string",
+                        "description": "Pickup point address city.",
+                        "example": "Rio de Janeiro"
+                      },
+                      "state": {
+                        "type": "string",
+                        "description": "Pickup point address state.",
+                        "example": "RJ"
+                      },
+                      "neighborhood": {
+                        "type": "string",
+                        "description": "Pickup point address neighborhood.",
+                        "example": "Botafogo"
+                      },
+                      "street": {
+                        "type": "string",
+                        "description": "Pickup point address street.",
+                        "example": "Praia de botafogo."
+                      },
+                      "number": {
+                        "type": "string",
+                        "description": "Pickup point address number.",
+                        "example": "200"
+                      },
+                      "complement": {
+                        "type": "string",
+                        "description": "Pickup point address complement.",
+                        "example": "3rd floor"
+                      },
+                      "reference": {
+                        "type": "string",
+                        "description": "Reference point to help the customer find the pickup point.",
+                        "example": "Grey building"
+                      },
+                      "location": {
+                        "required": [
+                          "latitude",
+                          "longitude"
+                        ],
+                        "type": "object",
+                        "description": "Pickup point address geolocation coordinates.",
+                        "properties": {
+                          "latitude": {
+                            "type": "number",
+                            "description": "Latitude coordinate.",
+                            "example": -22.974477767944336
+                          },
+                          "longitude": {
+                            "type": "number",
+                            "description": "Longitude coordinate.",
+                            "example": -43.18672561645508
+                          }
+                        }
+                      }
+                    }
+                  },
+                  "isActive": {
+                    "type": "boolean",
+                    "description": "Defines if the pickup point is active (`true`) or inactive (`false`).",
+                    "example": true
+                  },
+                  "businessHours": {
+                    "type": "array",
+                    "items": {
+                      "required": [
+                        "dayOfWeek",
+                        "openingTime",
+                        "closingTime"
+                      ],
+                      "type": "object",
+                      "description": "Business hours configurations from Monday to Friday.",
+                      "properties": {
+                        "dayOfWeek": {
+                          "type": "integer",
+                          "format": "int32",
+                          "description": "Day of the week identification, as in `1` = Monday, `2` = Tuesday, `3` = Wednesday, `4` = Thursday, and `5` = Friday.",
+                          "example": 1,
+                          "enum": [
+                            1,
+                            2,
+                            3,
+                            4,
+                            5
+                          ]
+                        },
+                        "openingTime": {
+                          "type": "string",
+                          "description": "Opening time in `HH:MM:SS` format.",
+                          "example": "08:00:00"
+                        },
+                        "closingTime": {
+                          "type": "string",
+                          "description": "Closing time in `HH:MM:SS` format.",
+                          "example": "20:00:00"
+                        }
+                      }
+                    },
+                    "description": "Pickup point business hours configurations."
+                  },
+                  "tagsLabel": {
+                    "type": "array",
+                    "items": {
+                      "type": "string",
+                      "description": "Pickup point tag label.",
+                      "example": "w67"
+                    },
+                    "description": "Tags that identify a group of pickup points.",
+                    "example": [
+                      "w67",
+                      "p34"
+                    ]
+                  },
+                  "isThirdPartyPickup": {
+                    "type": "boolean",
+                    "description": "Defines if the pickup point is third-party (`true`) or not (`false`).",
+                    "example": false
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "description": "Pickup point information.",
+                  "properties": {
+                    "id": {
+                      "type": "string",
+                      "description": "[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID."
+                    },
+                    "name": {
+                      "type": "string",
+                      "description": "Pickup point name displayed to customers at checkout."
+                    },
+                    "description": {
+                      "type": "string",
+                      "description": "Pickup point description displayed to customers at checkout."
+                    },
+                    "instructions": {
+                      "type": "string",
+                      "description": "Instructions for customers when collecting their package."
+                    },
+                    "formatted_address": {
+                      "type": "string",
+                      "description": "Formatted address.",
+                      "nullable": true
+                    },
+                    "address": {
+                      "type": "object",
+                      "description": "Pickup point address information.",
+                      "properties": {
+                        "postalCode": {
+                          "type": "string",
+                          "description": "Pickup point address postal code."
+                        },
+                        "country": {
+                          "type": "object",
+                          "description": "Information about the pickup point address country.",
+                          "properties": {
+                            "acronym": {
+                              "type": "string",
+                              "description": "Three-digit country code of the pickup point address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format."
+                            },
+                            "name": {
+                              "type": "string",
+                              "description": "Country name of the pickup point address."
+                            }
+                          }
+                        },
+                        "city": {
+                          "type": "string",
+                          "description": "Pickup point address city."
+                        },
+                        "state": {
+                          "type": "string",
+                          "description": "Pickup point address state."
+                        },
+                        "neighborhood": {
+                          "type": "string",
+                          "description": "Pickup point address neighborhood."
+                        },
+                        "street": {
+                          "type": "string",
+                          "description": "Pickup point address street."
+                        },
+                        "number": {
+                          "type": "string",
+                          "description": "Pickup point address number."
+                        },
+                        "complement": {
+                          "type": "string",
+                          "description": "Pickup point address complement."
+                        },
+                        "reference": {
+                          "type": "string",
+                          "description": "Reference point to help the customer find the pickup point."
+                        },
+                        "location": {
+                          "type": "object",
+                          "description": "Pickup point address geolocation coordinates.",
+                          "properties": {
+                            "latitude": {
+                              "type": "number",
+                              "description": "Latitude coordinate."
+                            },
+                            "longitude": {
+                              "type": "number",
+                              "description": "Longitude coordinate."
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "isActive": {
+                      "type": "boolean",
+                      "description": "Defines if the pickup point is active (`true`) or inactive (`false`)."
+                    },
+                    "distance": {
+                      "type": "number",
+                      "description": "Pickup point configured distance."
+                    },
+                    "seller": {
+                      "type": "string",
+                      "description": "Seller that corresponds to the pickup point."
+                    },
+                    "_sort": {
+                      "type": "array",
+                      "description": "Sort array.",
+                      "items": {
+                        "type": "number",
+                        "description": "Pickup point sort information."
+                      }
+                    },
+                    "businessHours": {
+                      "type": "array",
+                      "description": "Pickup point business hours configurations.",
+                      "items": {
+                        "type": "object",
+                        "description": "Business hours configurations from Monday to Friday.",
+                        "properties": {
+                          "dayOfWeek": {
+                            "type": "integer",
+                            "description": "Day of the week identification, as in `1` = Monday, `2` = Tuesday, `3` = Wednesday, `4` = Thursday, and `5` = Friday."
+                          },
+                          "openingTime": {
+                            "type": "string",
+                            "description": "Opening time in `HH:MM:SS` format."
+                          },
+                          "closingTime": {
+                            "type": "string",
+                            "description": "Closing time in `HH:MM:SS` format."
+                          }
+                        }
+                      }
+                    },
+                    "tagsLabel": {
+                      "type": "array",
+                      "description": "Tags that identify a group of pickup points.",
+                      "items": {
+                        "type": "string",
+                        "description": "Pickup point tag label."
+                      }
+                    },
+                    "pickupHolidays": {
+                      "type": "array",
+                      "description": "[Holidays](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) configured for the pickup point.",
+                      "items": {
+                        "type": "object",
+                        "description": "Holiday information.",
+                        "properties": {
+                          "date": {
+                            "type": "string",
+                            "description": "Holiday date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`."
+                          },
+                          "hourBegin": {
+                            "type": "string",
+                            "description": "Holiday beginning time in `HH:MM` format."
+                          },
+                          "hourEnd": {
+                            "type": "string",
+                            "description": "Holiday ending time in `HH:MM` format."
+                          }
+                        }
+                      }
+                    },
+                    "isThirdPartyPickup": {
+                      "type": "boolean",
+                      "description": "Defines if the pickup point is third-party (`true`) or not (`false`)."
+                    },
+                    "accountOwnerName": {
+                      "type": "string",
+                      "description": "Account owner name."
+                    },
+                    "accountOwnerId": {
+                      "type": "string",
+                      "description": "Account owner ID."
+                    },
+                    "parentAccountName": {
+                      "type": "string",
+                      "description": "Parent account name."
+                    },
+                    "originalId": {
+                      "type": "string",
+                      "description": "Original ID.",
+                      "nullable": true
+                    }
+                  }
+                },
+                "example": {
+                  "id": "b8e7ca56",
+                  "name": "Pickup Shopping Center",
+                  "description": "Shopping Center from Barra",
+                  "instructions": "You have to present a document to collect your package",
+                  "formatted_address": "undefined",
+                  "address": {
+                    "postalCode": "22250040",
+                    "country": {
+                      "acronym": "BRA",
+                      "name": "Brazil"
+                    },
+                    "city": "Rio de Janeiro",
+                    "state": "RJ",
+                    "neighborhood": "Botafogo",
+                    "street": "Botafogo beach",
+                    "number": "300",
+                    "complement": "Shopping Center",
+                    "reference": "Third floor",
+                    "location": {
+                      "latitude": -22.906847,
+                      "longitude": -43.172897
+                    }
+                  },
+                  "isActive": true,
+                  "distance": 0,
+                  "seller": "Fashion Skirts",
+                  "_sort": [
+                    1574240390000
+                  ],
+                  "businessHours": [
+                    {
+                      "dayOfWeek": 1,
+                      "openingTime": "09:00:00",
+                      "closingTime": "18:00:00"
+                    },
+                    {
+                      "dayOfWeek": 2,
+                      "openingTime": "09:00:00",
+                      "closingTime": "18:00:00"
+                    },
+                    {
+                      "dayOfWeek": 3,
+                      "openingTime": "09:00:00",
+                      "closingTime": "18:00:00"
+                    },
+                    {
+                      "dayOfWeek": 4,
+                      "openingTime": "09:00:00",
+                      "closingTime": "18:00:00"
+                    },
+                    {
+                      "dayOfWeek": 5,
+                      "openingTime": "09:00:00",
+                      "closingTime": "18:00:00"
+                    }
+                  ],
+                  "tagsLabel": [
+                    "w67",
+                    "p34"
+                  ],
+                  "pickupHolidays": [
+                    {
+                      "date": "2024-12-28T03:00:00Z",
+                      "hourBegin": "09:00",
+                      "hourEnd": "13:00"
+                    },
+                    {
+                      "date": "2024-11-17T03:00:00Z",
+                      "hourBegin": "00:00",
+                      "hourEnd": "00:00"
+                    }
+                  ],
+                  "isThirdPartyPickup": false,
+                  "accountOwnerName": "fashionstore",
+                  "accountOwnerId": "1b4018ec-48bf-4a59-9eae-547403e11afc",
+                  "parentAccountName": "fashionstore",
+                  "originalId": "b8e7ca56"
+                }
+              }
+            }
+          }
+        }
+      },
+      "get": {
+        "tags": [
+          "Pickup points"
+        ],
+        "summary": "List pickup point by ID",
+        "description": "Retrieves information about a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R), searching by pickup point ID.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "GetById",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "pickupPointId",
+            "in": "path",
+            "description": "[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "b8e7ca56"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "description": "Pickup point information.",
+                  "properties": {
+                    "id": {
+                      "type": "string",
+                      "description": "[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID."
+                    },
+                    "name": {
+                      "type": "string",
+                      "description": "Pickup point name displayed to customers at checkout."
+                    },
+                    "description": {
+                      "type": "string",
+                      "description": "Pickup point description displayed to customers at checkout."
+                    },
+                    "instructions": {
+                      "type": "string",
+                      "description": "Instructions for customers when collecting their package."
+                    },
+                    "formatted_address": {
+                      "type": "string",
+                      "description": "Formatted address.",
+                      "nullable": true
+                    },
+                    "address": {
+                      "type": "object",
+                      "description": "Pickup point address information.",
+                      "properties": {
+                        "postalCode": {
+                          "type": "string",
+                          "description": "Pickup point address postal code."
+                        },
+                        "country": {
+                          "type": "object",
+                          "description": "Information about the pickup point address country.",
+                          "properties": {
+                            "acronym": {
+                              "type": "string",
+                              "description": "Three-digit country code of the pickup point address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format."
+                            },
+                            "name": {
+                              "type": "string",
+                              "description": "Country name of the pickup point address."
+                            }
+                          }
+                        },
+                        "city": {
+                          "type": "string",
+                          "description": "Pickup point address city."
+                        },
+                        "state": {
+                          "type": "string",
+                          "description": "Pickup point address state."
+                        },
+                        "neighborhood": {
+                          "type": "string",
+                          "description": "Pickup point address neighborhood."
+                        },
+                        "street": {
+                          "type": "string",
+                          "description": "Pickup point address street."
+                        },
+                        "number": {
+                          "type": "string",
+                          "description": "Pickup point address number."
+                        },
+                        "complement": {
+                          "type": "string",
+                          "description": "Pickup point address complement."
+                        },
+                        "reference": {
+                          "type": "string",
+                          "description": "Reference point to help the customer find the pickup point."
+                        },
+                        "location": {
+                          "type": "object",
+                          "description": "Pickup point address geolocation coordinates.",
+                          "properties": {
+                            "latitude": {
+                              "type": "number",
+                              "description": "Latitude coordinate."
+                            },
+                            "longitude": {
+                              "type": "number",
+                              "description": "Longitude coordinate."
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "isActive": {
+                      "type": "boolean",
+                      "description": "Defines if the pickup point is active (`true`) or inactive (`false`)."
+                    },
+                    "distance": {
+                      "type": "number",
+                      "description": "Pickup point configured distance."
+                    },
+                    "seller": {
+                      "type": "string",
+                      "description": "Seller that corresponds to the pickup point."
+                    },
+                    "_sort": {
+                      "type": "array",
+                      "description": "Sort array.",
+                      "items": {
+                        "type": "number",
+                        "description": "Pickup point sort information."
+                      }
+                    },
+                    "businessHours": {
+                      "type": "array",
+                      "description": "Pickup point business hours configurations.",
+                      "items": {
+                        "type": "object",
+                        "description": "Business hours configurations from Monday to Friday.",
+                        "properties": {
+                          "dayOfWeek": {
+                            "type": "integer",
+                            "description": "Day of the week identification, as in `1` = Monday, `2` = Tuesday, `3` = Wednesday, `4` = Thursday, and `5` = Friday."
+                          },
+                          "openingTime": {
+                            "type": "string",
+                            "description": "Opening time in `HH:MM:SS` format."
+                          },
+                          "closingTime": {
+                            "type": "string",
+                            "description": "Closing time in `HH:MM:SS` format."
+                          }
+                        }
+                      }
+                    },
+                    "tagsLabel": {
+                      "type": "array",
+                      "description": "Tags that identify a group of pickup points.",
+                      "items": {
+                        "type": "string",
+                        "description": "Pickup point tag label."
+                      }
+                    },
+                    "pickupHolidays": {
+                      "type": "array",
+                      "description": "[Holidays](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) configured for the pickup point.",
+                      "items": {
+                        "type": "object",
+                        "description": "Holiday information.",
+                        "properties": {
+                          "date": {
+                            "type": "string",
+                            "description": "Holiday date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`."
+                          },
+                          "hourBegin": {
+                            "type": "string",
+                            "description": "Holiday beginning time in `HH:MM` format."
+                          },
+                          "hourEnd": {
+                            "type": "string",
+                            "description": "Holiday ending time in `HH:MM` format."
+                          }
+                        }
+                      }
+                    },
+                    "isThirdPartyPickup": {
+                      "type": "boolean",
+                      "description": "Defines if the pickup point is third-party (`true`) or not (`false`)."
+                    },
+                    "accountOwnerName": {
+                      "type": "string",
+                      "description": "Account owner name."
+                    },
+                    "accountOwnerId": {
+                      "type": "string",
+                      "description": "Account owner ID."
+                    },
+                    "parentAccountName": {
+                      "type": "string",
+                      "description": "Parent account name."
+                    },
+                    "originalId": {
+                      "type": "string",
+                      "description": "Original ID.",
+                      "nullable": true
+                    }
+                  }
+                },
+                "example": {
+                  "id": "b8e7ca56",
+                  "name": "Pickup Shopping Center",
+                  "description": "Shopping Center from Barra",
+                  "instructions": "You have to present a document to collect your package",
+                  "formatted_address": "undefined",
+                  "address": {
+                    "postalCode": "22250040",
+                    "country": {
+                      "acronym": "BRA",
+                      "name": "Brazil"
+                    },
+                    "city": "Rio de Janeiro",
+                    "state": "RJ",
+                    "neighborhood": "Botafogo",
+                    "street": "Botafogo beach",
+                    "number": "300",
+                    "complement": "Shopping Center",
+                    "reference": "Third floor",
+                    "location": {
+                      "latitude": -22.906847,
+                      "longitude": -43.172897
+                    }
+                  },
+                  "isActive": true,
+                  "distance": 0,
+                  "seller": "Fashion Skirts",
+                  "_sort": [
+                    1574240390000
+                  ],
+                  "businessHours": [
+                    {
+                      "dayOfWeek": 1,
+                      "openingTime": "09:00:00",
+                      "closingTime": "18:00:00"
+                    },
+                    {
+                      "dayOfWeek": 2,
+                      "openingTime": "09:00:00",
+                      "closingTime": "18:00:00"
+                    },
+                    {
+                      "dayOfWeek": 3,
+                      "openingTime": "09:00:00",
+                      "closingTime": "18:00:00"
+                    },
+                    {
+                      "dayOfWeek": 4,
+                      "openingTime": "09:00:00",
+                      "closingTime": "18:00:00"
+                    },
+                    {
+                      "dayOfWeek": 5,
+                      "openingTime": "09:00:00",
+                      "closingTime": "18:00:00"
+                    }
+                  ],
+                  "tagsLabel": [
+                    "w67",
+                    "p34"
+                  ],
+                  "pickupHolidays": [
+                    {
+                      "date": "2024-12-28T03:00:00Z",
+                      "hourBegin": "09:00",
+                      "hourEnd": "13:00"
+                    },
+                    {
+                      "date": "2024-11-17T03:00:00Z",
+                      "hourBegin": "00:00",
+                      "hourEnd": "00:00"
+                    }
+                  ],
+                  "isThirdPartyPickup": false,
+                  "accountOwnerName": "fashionstore",
+                  "accountOwnerId": "1b4018ec-48bf-4a59-9eae-547403e11afc",
+                  "parentAccountName": "fashionstore",
+                  "originalId": "b8e7ca56"
+                }
+              }
+            }
+          }
+        }
+      },
+      "delete": {
+        "tags": [
+          "Pickup points"
+        ],
+        "summary": "Delete pickup point",
+        "description": "Deletes a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) of your store, searching by pickup point ID.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "Delete",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "pickupPointId",
+            "in": "path",
+            "description": "[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "b8e7ca56"
+            }
+          }
+        ],
+        "responses": {
+          "204": {
+            "description": "No Content"
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/configuration/pickuppoints/_search": {
+      "get": {
+        "tags": [
+          "Pickup points"
+        ],
+        "summary": "List paged pickup points",
+        "description": "Lists paged [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) of your store.\r\n\r\n>⚠️ The response is limited to 100 pages.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "Getpaged",
+        "parameters": [
+          {
+            "name": "page",
+            "in": "query",
+            "description": "Number of the page of the response. When not informed, the default page returned is `1`, but you can use this parameter to retrieve a specific page. The response is limited to 100 pages.",
+            "required": false,
+            "style": "form",
+            "explode": true,
+            "schema": {
+              "type": "integer",
+              "example": 2
+            }
+          },
+          {
+            "name": "pageSize",
+            "in": "query",
+            "description": "Number of [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) per page.",
+            "required": false,
+            "style": "form",
+            "explode": true,
+            "schema": {
+              "type": "integer",
+              "example": 15,
+              "maximum": 100
+            }
+          },
+          {
+            "name": "keyword",
+            "in": "query",
+            "description": "Search pickup points by using a keyword.",
+            "required": false,
+            "style": "form",
+            "explode": true,
+            "schema": {
+              "type": "string",
+              "example": "Rio"
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "description": "Paged pickup points list.",
+                  "properties": {
+                    "items": {
+                      "type": "array",
+                      "description": "List of pickup points.",
+                      "items": {
+                        "type": "object",
+                        "description": "Pickup point information.",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID."
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Pickup point name displayed to customers at checkout."
+                          },
+                          "description": {
+                            "type": "string",
+                            "description": "Pickup point description displayed to customers at checkout."
+                          },
+                          "instructions": {
+                            "type": "string",
+                            "description": "Instructions for customers when collecting their package."
+                          },
+                          "formatted_address": {
+                            "type": "string",
+                            "description": "Formatted address.",
+                            "nullable": true
+                          },
+                          "address": {
+                            "type": "object",
+                            "description": "Pickup point address information.",
+                            "properties": {
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Pickup point address postal code."
+                              },
+                              "country": {
+                                "type": "object",
+                                "description": "Information about the pickup point address country.",
+                                "properties": {
+                                  "acronym": {
+                                    "type": "string",
+                                    "description": "Three-digit country code of the pickup point address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format."
+                                  },
+                                  "name": {
+                                    "type": "string",
+                                    "description": "Country name of the pickup point address."
+                                  }
+                                }
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "Pickup point address city."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "Pickup point address state."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Pickup point address neighborhood."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Pickup point address street."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Pickup point address number."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Pickup point address complement."
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Reference point to help the customer find the pickup point."
+                              },
+                              "location": {
+                                "type": "object",
+                                "description": "Pickup point address geolocation coordinates.",
+                                "properties": {
+                                  "latitude": {
+                                    "type": "number",
+                                    "description": "Latitude coordinate."
+                                  },
+                                  "longitude": {
+                                    "type": "number",
+                                    "description": "Longitude coordinate."
+                                  }
+                                }
+                              }
+                            }
+                          },
+                          "isActive": {
+                            "type": "boolean",
+                            "description": "Defines if the pickup point is active (`true`) or inactive (`false`)."
+                          },
+                          "distance": {
+                            "type": "number",
+                            "description": "Pickup point configured distance."
+                          },
+                          "seller": {
+                            "type": "string",
+                            "description": "Seller that corresponds to the pickup point."
+                          },
+                          "_sort": {
+                            "type": "array",
+                            "description": "Sort array.",
+                            "items": {
+                              "type": "number",
+                              "description": "Pickup point sort information."
+                            }
+                          },
+                          "businessHours": {
+                            "type": "array",
+                            "description": "Pickup point business hours configurations.",
+                            "items": {
+                              "type": "object",
+                              "description": "Business hours configurations from Monday to Friday.",
+                              "properties": {
+                                "dayOfWeek": {
+                                  "type": "integer",
+                                  "description": "Day of the week identification, as in `1` = Monday, `2` = Tuesday, `3` = Wednesday, `4` = Thursday, and `5` = Friday."
+                                },
+                                "openingTime": {
+                                  "type": "string",
+                                  "description": "Opening time in `HH:MM:SS` format."
+                                },
+                                "closingTime": {
+                                  "type": "string",
+                                  "description": "Closing time in `HH:MM:SS` format."
+                                }
+                              }
+                            }
+                          },
+                          "tagsLabel": {
+                            "type": "array",
+                            "description": "Tags that identify a group of pickup points.",
+                            "items": {
+                              "type": "string",
+                              "description": "Pickup point tag label."
+                            }
+                          },
+                          "pickupHolidays": {
+                            "type": "array",
+                            "description": "[Holidays](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) configured for the pickup point.",
+                            "items": {
+                              "type": "object",
+                              "description": "Holiday information.",
+                              "properties": {
+                                "date": {
+                                  "type": "string",
+                                  "description": "Holiday date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`."
+                                },
+                                "hourBegin": {
+                                  "type": "string",
+                                  "description": "Holiday beginning time in `HH:MM` format."
+                                },
+                                "hourEnd": {
+                                  "type": "string",
+                                  "description": "Holiday ending time in `HH:MM` format."
+                                }
+                              }
+                            }
+                          },
+                          "isThirdPartyPickup": {
+                            "type": "boolean",
+                            "description": "Defines if the pickup point is third-party (`true`) or not (`false`)."
+                          },
+                          "accountOwnerName": {
+                            "type": "string",
+                            "description": "Account owner name."
+                          },
+                          "accountOwnerId": {
+                            "type": "string",
+                            "description": "Account owner ID."
+                          },
+                          "parentAccountName": {
+                            "type": "string",
+                            "description": "Parent account name."
+                          },
+                          "originalId": {
+                            "type": "string",
+                            "description": "Original ID.",
+                            "nullable": true
+                          }
+                        }
+                      }
+                    },
+                    "paging": {
+                      "type": "object",
+                      "description": "Pagination information.",
+                      "properties": {
+                        "page": {
+                          "type": "integer",
+                          "description": "Number of the current page of the response. By default, it returns page `1`, unless a different value is informed in the `page` query parameter."
+                        },
+                        "perPage": {
+                          "type": "integer",
+                          "description": "Number of pickup points per page."
+                        },
+                        "total": {
+                          "type": "integer",
+                          "description": "Total number of existing pickup points."
+                        },
+                        "pages": {
+                          "type": "integer",
+                          "description": "Total number of pages, considering the total number of pickup points. Even though there might be other results, the maximum value of this field will be `100`, because the response is limited to 100 pages."
+                        }
+                      }
+                    }
+                  }
+                },
+                "example": {
+                  "items": [
+                    {
+                      "id": "b8e7ca56",
+                      "name": "Pickup Shopping Center",
+                      "description": "Shopping Center from Barra",
+                      "instructions": "You have to present a document to collect your package",
+                      "formatted_address": "undefined",
+                      "address": {
+                        "postalCode": "22250040",
+                        "country": {
+                          "acronym": "BRA",
+                          "name": "Brazil"
+                        },
+                        "city": "Rio de Janeiro",
+                        "state": "RJ",
+                        "neighborhood": "Botafogo",
+                        "street": "Botafogo beach",
+                        "number": "300",
+                        "complement": "Shopping Center",
+                        "reference": "Third floor",
+                        "location": {
+                          "latitude": -22.906847,
+                          "longitude": -43.172897
+                        }
+                      },
+                      "isActive": true,
+                      "distance": 0,
+                      "seller": "Fashion Skirts",
+                      "_sort": [
+                        1574240390000
+                      ],
+                      "businessHours": [
+                        {
+                          "dayOfWeek": 1,
+                          "openingTime": "09:00:00",
+                          "closingTime": "18:00:00"
+                        },
+                        {
+                          "dayOfWeek": 2,
+                          "openingTime": "09:00:00",
+                          "closingTime": "18:00:00"
+                        },
+                        {
+                          "dayOfWeek": 3,
+                          "openingTime": "09:00:00",
+                          "closingTime": "18:00:00"
+                        },
+                        {
+                          "dayOfWeek": 4,
+                          "openingTime": "09:00:00",
+                          "closingTime": "18:00:00"
+                        },
+                        {
+                          "dayOfWeek": 5,
+                          "openingTime": "09:00:00",
+                          "closingTime": "18:00:00"
+                        }
+                      ],
+                      "tagsLabel": [
+                        "w67",
+                        "p34"
+                      ],
+                      "pickupHolidays": [
+                        {
+                          "date": "2024-12-28T03:00:00Z",
+                          "hourBegin": "09:00",
+                          "hourEnd": "13:00"
+                        },
+                        {
+                          "date": "2024-11-17T03:00:00Z",
+                          "hourBegin": "00:00",
+                          "hourEnd": "00:00"
+                        }
+                      ],
+                      "isThirdPartyPickup": false,
+                      "accountOwnerName": "Fashion Store",
+                      "accountOwnerId": "1b4018ec-48bf-4a59-9eae-547403e11afc",
+                      "parentAccountName": "Fashion Store",
+                      "originalId": null
+                    },
+                    {
+                      "id": "792893547449051",
+                      "name": "Bleu PUP",
+                      "description": "Bleu Store",
+                      "instructions": "You must present a document to collect your order",
+                      "formatted_address": "undefined",
+                      "address": {
+                        "postalCode": "18550-000",
+                        "country": {
+                          "acronym": "BRA",
+                          "name": "Brasil"
+                        },
+                        "city": "Boituva",
+                        "state": "SP",
+                        "neighborhood": "Tancredo Neves",
+                        "street": "BTV-250",
+                        "number": "01",
+                        "complement": "Second floor",
+                        "reference": "Next to the city hall",
+                        "location": {
+                          "latitude": -23.2863329,
+                          "longitude": -47.6783742
+                        }
+                      },
+                      "isActive": true,
+                      "distance": 1574240387072,
+                      "seller": "Recurrency",
+                      "_sort": [
+                        1574240390000
+                      ],
+                      "businessHours": [
+                        {
+                          "dayOfWeek": 1,
+                          "openingTime": "09:00:00",
+                          "closingTime": "18:00:00"
+                        },
+                        {
+                          "dayOfWeek": 2,
+                          "openingTime": "09:00:00",
+                          "closingTime": "18:00:00"
+                        },
+                        {
+                          "dayOfWeek": 3,
+                          "openingTime": "09:00:00",
+                          "closingTime": "18:00:00"
+                        },
+                        {
+                          "dayOfWeek": 4,
+                          "openingTime": "09:00:00",
+                          "closingTime": "18:00:00"
+                        },
+                        {
+                          "dayOfWeek": 5,
+                          "openingTime": "09:00:00",
+                          "closingTime": "18:00:00"
+                        }
+                      ],
+                      "tagsLabel": [
+                        "kr47",
+                        "yk15"
+                      ],
+                      "pickupHolidays": [
+                        {
+                          "date": "2024-12-28T03:00:00Z",
+                          "hourBegin": "09:00",
+                          "hourEnd": "13:00"
+                        }
+                      ],
+                      "isThirdPartyPickup": false,
+                      "accountOwnerName": "sportsstore",
+                      "accountOwnerId": "9ddcfba5-3855-49ec-b61e-b2847b9314cc",
+                      "parentAccountName": "sportsstore",
+                      "originalId": "b8e7ca56"
+                    }
+                  ],
+                  "paging": {
+                    "page": 1,
+                    "perPage": 15,
+                    "total": 29,
+                    "pages": 2
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/configuration/geoshape": {
+      "get": {
+        "tags": [
+          "Polygons"
+        ],
+        "summary": "List paged polygons",
+        "description": "Lists paged [polygons](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) of your store.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "PagedPolygons",
+        "parameters": [
+          {
+            "name": "page",
+            "in": "query",
+            "description": "Number of the page of the response.",
+            "required": false,
+            "style": "form",
+            "explode": true,
+            "schema": {
+              "type": "integer",
+              "example": 2
+            }
+          },
+          {
+            "name": "perPage",
+            "in": "query",
+            "description": "Number of [polygons](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) per page.",
+            "required": false,
+            "style": "form",
+            "explode": true,
+            "schema": {
+              "type": "integer",
+              "example": 15
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "items": {
+                      "type": "array",
+                      "description": "Polygons list.",
+                      "items": {
+                        "type": "string",
+                        "description": "Polygon name."
+                      }
+                    },
+                    "paging": {
+                      "type": "object",
+                      "description": "Pagination information.",
+                      "properties": {
+                        "page": {
+                          "type": "integer",
+                          "description": "Number of the current page of the response. By default, it returns page `1`."
+                        },
+                        "perPage": {
+                          "type": "integer",
+                          "description": "Number of polygons per page."
+                        },
+                        "total": {
+                          "type": "integer",
+                          "description": "Total number of existing polygons."
+                        },
+                        "pages": {
+                          "type": "integer",
+                          "description": "Total number of pages, considering the total number of polygons."
+                        }
+                      }
+                    }
+                  }
+                },
+                "example": {
+                  "items": [
+                    "ipanema_leblon",
+                    "SP",
+                    "south_brazil"
+                  ],
+                  "paging": {
+                    "page": 1,
+                    "perPage": 15,
+                    "total": 22,
+                    "pages": 2
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
+      "put": {
+        "tags": [
+          "Polygons"
+        ],
+        "summary": "Create or update polygon",
+        "description": "Creates or updates a [polygon](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) of your store, using geolocation coordinates.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "CreateUpdatePolygon",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "required": [
+                  "name",
+                  "geoShape"
+                ],
+                "properties": {
+                  "name": {
+                    "type": "string",
+                    "description": "Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) being created or updated.",
+                    "example": "ipanema_leblon"
+                  },
+                  "geoShape": {
+                    "type": "object",
+                    "description": "Polygon geolocation coordinates.",
+                    "required": [
+                      "coordinates"
+                    ],
+                    "properties": {
+                      "coordinates": {
+                        "type": "array",
+                        "description": "List of geolocation coordinates that make part of the polygon.",
+                        "items": {
+                          "type": "array",
+                          "description": "Polygon geolocation coordinates. The first and the last pair of coordinates must be equal.",
+                          "items": {
+                            "type": "array",
+                            "description": "Polygon geolocation coordinates, first longitude then latitude.",
+                            "items": {
+                              "type": "number",
+                              "description": "Longitude or latitude.",
+                              "example": -43.23171615600586
+                            }
+                          }
+                        },
+                        "example": [
+                          [
+                            [
+                              -43.23171615600586,
+                              -22.990713500405295
+                            ],
+                            [
+                              -43.182621002197266,
+                              -22.990713500405295
+                            ],
+                            [
+                              -43.182621002197266,
+                              -22.977043559707305
+                            ],
+                            [
+                              -43.23171615600586,
+                              -22.977043559707305
+                            ],
+                            [
+                              -43.23171615600586,
+                              -22.990713500405295
+                            ]
+                          ]
+                        ]
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "string",
+                  "description": "Name of the [polygon](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) created or updated."
+                },
+                "example": "ipanema_leblon"
+              }
+            }
+          },
+          "400": {
+            "description": "Bad Request"
+          }
+        }
+      }
+    },
+    "/api/logistics/pvt/configuration/geoshape/{polygonName}": {
+      "get": {
+        "tags": [
+          "Polygons"
+        ],
+        "summary": "List polygon by ID",
+        "description": "Retrieves information about a [polygon](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) of your store, searching by polygon ID.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "PolygonbyId",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "polygonName",
+            "in": "path",
+            "description": "[Polygon](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) ID (same as the polygon name).",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "ipanema_leblon"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "isActive": {
+                      "type": "boolean",
+                      "description": "Defines if the polygon is active (`true`) or inactive (`false`)."
+                    },
+                    "name": {
+                      "type": "string",
+                      "description": "[Polygon](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) ID, which is the same as the polygon name."
+                    },
+                    "geoShape": {
+                      "type": "object",
+                      "description": "Polygon geolocation coordinates.",
+                      "properties": {
+                        "coordinates": {
+                          "type": "array",
+                          "description": "List of geolocation coordinates that make part of the polygon.",
+                          "items": {
+                            "type": "array",
+                            "description": "Polygon geolocation coordinates. The first and the last pair of coordinates must be equal.",
+                            "items": {
+                              "type": "array",
+                              "description": "Polygon geolocation coordinates, first longitude then latitude.",
+                              "items": {
+                                "type": "number",
+                                "description": "Longitude or latitude."
+                              }
+                            }
+                          }
+                        },
+                        "type": {
+                          "type": "string",
+                          "description": "Polygon identification."
+                        }
+                      }
+                    }
+                  }
+                },
+                "example": {
+                  "isActive": true,
+                  "name": "ipanema_leblon",
+                  "geoShape": {
+                    "coordinates": [
+                      [
+                        [
+                          -43.23171615600586,
+                          -22.990713500405295
+                        ],
+                        [
+                          -43.182621002197266,
+                          -22.990713500405295
+                        ],
+                        [
+                          -43.182621002197266,
+                          -22.977043559707305
+                        ],
+                        [
+                          -43.23171615600586,
+                          -22.977043559707305
+                        ],
+                        [
+                          -43.23171615600586,
+                          -22.990713500405295
+                        ]
+                      ]
+                    ],
+                    "type": "polygon"
+                  }
+                }
+              }
+            }
+          }
+        }
+      },
+      "delete": {
+        "tags": [
+          "Polygons"
+        ],
+        "summary": "Delete polygon",
+        "description": "Deletes a [polygon](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) of your store, searching by polygon ID.\r\n\r\nSuccessful requests receive a `200 OK` status code with `true` in the response body.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "DeletePolygon",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "polygonName",
+            "in": "path",
+            "description": "[Polygon](https://help.vtex.com/en/tutorial/registering-geolocation--tutorials_138) ID (same as the polygon name).",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "ipanema_leblon"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "boolean",
+                  "description": "Successful requests return the message `true`."
+                },
+                "example": true
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/logistics-capacity/resources/carrier@{capacityType}@{shippingPolicyId}/time-frames": {
+      "get": {
+        "tags": [
+          "Scheduled delivery"
+        ],
+        "summary": "Search capacity reservations in time range",
+        "description": "Retrieves information of all [capacity reservations](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz) made to scheduled delivery windows in a given time range.\r\n\r\n>⚠️ While most of our API endpoints return time fields in UTC format, this endpoint returns time adjusted to the configured time zone of the VTEX account.\n\r\n\r> Note that the combined string `carrier@{capacityType}@{shippingPolicyId}` can be referred to as a `resource` in request messages.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/vnd.vtex.availability.v1+json"
+            }
+          },
+          {
+            "name": "capacityType",
+            "in": "path",
+            "description": "Defines how the [delivery capacity](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz) is set in the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140), which can be by maximum number of orders (`orders_quantity`) or items (`skus_quantity`).",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "orders_quantity"
+            }
+          },
+          {
+            "name": "shippingPolicyId",
+            "in": "path",
+            "description": "ID of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) being searched for capacity reservation.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "168e017"
+            }
+          },
+          {
+            "name": "rangeStart",
+            "in": "query",
+            "description": "Starting date range in the format `YYYY-MM-DD`.",
+            "required": true,
+            "style": "form",
+            "schema": {
+              "type": "string",
+              "example": "2024-07-19"
+            }
+          },
+          {
+            "name": "rangeEnd",
+            "in": "query",
+            "description": "Ending date range in the format `YYYY-MM-DD`.",
+            "required": true,
+            "style": "form",
+            "schema": {
+              "type": "string",
+              "example": "2024-07-26"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "description": "Information about the [capacity reservation](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz) of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).",
+                  "properties": {
+                    "id": {
+                      "type": "string",
+                      "description": "Capacity reservation ID generated by the request."
+                    },
+                    "resourceId": {
+                      "type": "string",
+                      "description": "Combined string `carrier@{capacityType}@{shippingPolicyId}` used in the request."
+                    },
+                    "startDate": {
+                      "type": "string",
+                      "description": "Starting date and time of the period considered for the request, in the format `YYYY-MM-DDTHH:MM:SSZ`. The time zone is set according to the store account."
+                    },
+                    "endDate": {
+                      "type": "string",
+                      "description": "Ending date and time of the period considered for the request, in the format `YYYY-MM-DDTHH:MM:SSZ`. The time zone is set according to the store account."
+                    },
+                    "ownMaxCapacity": {
+                      "type": "number",
+                      "description": "Delivery capacity available, which is the total capacity minus the reserved orders or items, according to the capacity type set."
+                    },
+                    "resourceMaxCapacity": {
+                      "type": "number",
+                      "description": "Maximum delivery capacity of orders or items."
+                    },
+                    "reservedValue": {
+                      "type": "number",
+                      "description": "Orders or items reserved from the delivery capacity."
+                    },
+                    "reservations": {
+                      "type": "array",
+                      "description": "List of [reservations](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92).",
+                      "items": {
+                        "type": "object",
+                        "description": "Reservation details.",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "Reservation ID."
+                          },
+                          "value": {
+                            "type": "number",
+                            "description": "Reservation number of items or orders, according to the capacity type set."
+                          }
+                        }
+                      }
+                    },
+                    "log": {
+                      "type": "array",
+                      "description": "System processing information.",
+                      "items": {
+                        "type": "object",
+                        "description": "Log information.",
+                        "properties": {
+                          "when": {
+                            "type": "string",
+                            "description": "Delivery capacity alteration date and time, in the format `YYYY-MM-DDTHH:MM:SSZ`. The time zone is set according to the store account."
+                          },
+                          "who": {
+                            "type": "string",
+                            "description": "Who altered the delivery capacity."
+                          },
+                          "why": {
+                            "type": "string",
+                            "description": "Reason for the alteration."
+                          },
+                          "what": {
+                            "type": "string",
+                            "description": "Situation of the corresponding [delivery window](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi#delivery-window), which can be `Blocked` or `Unblocked`."
+                          }
+                        }
+                      }
+                    }
+                  }
+                },
+                "example": {
+                  "id": "2024-07-19F1300T1700",
+                  "resourceId": "carrier@skus_quantity@168e017",
+                  "startDate": "2024-07-19T13:00:00+00:00",
+                  "endDate": "2024-07-26T17:00:59+00:00",
+                  "ownMaxCapacity": 10,
+                  "resourceMaxCapacity": 16,
+                  "reservedValue": 6,
+                  "reservations": [
+                    {
+                      "id": "SLR-1379840726134-01",
+                      "value": 4
+                    },
+                    {
+                      "id": "SLR-1379840726341-01",
+                      "value": 2
+                    }
+                  ],
+                  "log": [
+                    {
+                      "when": "2024-07-20T15:56:09.1732357+00:00",
+                      "who": "Daniel Thompson",
+                      "why": "Reservation `SLR-1379840726134-01` with 4.0 units.",
+                      "what": "Unblocked"
+                    },
+                    {
+                      "when": "2024-07-22T17:29:11.9250354+00:00",
+                      "who": "Daniel Thompson",
+                      "why": "Reservation `SLR-1379840726341-01` with 2.0 units.",
+                      "what": "Unblocked"
+                    }
+                  ]
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/logistics-capacity/resources/carrier@{capacityType}@{shippingPolicyId}/time-frames/{windowDay}F{windowStartTime}T{windowEndTime}": {
+      "get": {
+        "tags": [
+          "Scheduled delivery"
+        ],
+        "summary": "Get capacity reservation usage by window",
+        "description": "Retrieves capacity usage of a specific [scheduled delivery](https://help.vtex.com/en/tutorial/entrega-agendada--22g3HAVCGLFiU7xugShOBi) reservation window.\n\r\n\r>⚠️ While most API endpoints return time fields in UTC format, this endpoint returns time adjusted to the configured time zone of the VTEX account.\n\r\n\r> Note that the combined string `carrier@{capacityType}@{shippingPolicyId}` can be referred to as a \"resource\" in the API's messages.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Logistics | Logistics access | **Logistics viewer** |\r\n| Logistics | Logistics access | **Logistics full access** |\r\n| Logistics | Logistics access | **Logistics shipping full access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Logistics - Full access | Logistics viewer |\r\n| Logistics - Read only | Logistics viewer |\r\n| Logistics - Full access | Logistics full access |\r\n| OMS - Full access | Logistics full access |\r\n| Logistics - Full access | Logistics shipping full access |\r\n| OMS - Full access | Logistics shipping full access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm). To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/vnd.vtex.availability.v1+json"
+            }
+          },
+          {
+            "name": "capacityType",
+            "in": "path",
+            "description": "Defines how the [delivery capacity](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz) is set in the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140), which can be by maximum number of orders (`orders_quantity`) or items (`skus_quantity`).",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "orders_quantity"
+            }
+          },
+          {
+            "name": "shippingPolicyId",
+            "in": "path",
+            "description": "ID of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) being searched for capacity reservation.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "168e017"
+            }
+          },
+          {
+            "name": "windowDay",
+            "in": "path",
+            "description": "Date of the [scheduled delivery window](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) being consulted for reservations. The format is `YYYY-MM-DD`.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "2024-07-19"
+            }
+          },
+          {
+            "name": "windowStartTime",
+            "in": "path",
+            "description": "Starting time of the scheduled delivery window being consulted for reservations. The format is `HHMM`.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "1030"
+            }
+          },
+          {
+            "name": "windowEndTime",
+            "in": "path",
+            "description": "Ending time of the scheduled delivery window being consulted for reservations. The format is `HHMM`.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "1159"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "description": "Information about the [capacity reservation](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz) of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).",
+                  "properties": {
+                    "id": {
+                      "type": "string",
+                      "description": "Capacity reservation ID generated by the request."
+                    },
+                    "resourceId": {
+                      "type": "string",
+                      "description": "Combined string `carrier@{capacityType}@{shippingPolicyId}` used in the request."
+                    },
+                    "startDate": {
+                      "type": "string",
+                      "description": "Starting date and time of the period considered for the request, in the format `YYYY-MM-DDTHH:MM:SSZ`. The time zone is set according to the store account."
+                    },
+                    "endDate": {
+                      "type": "string",
+                      "description": "Ending date and time of the period considered for the request, in the format `YYYY-MM-DDTHH:MM:SSZ`. The time zone is set according to the store account."
+                    },
+                    "ownMaxCapacity": {
+                      "type": "number",
+                      "description": "Delivery capacity available, which is the total capacity minus the reserved orders or items, according to the capacity type set."
+                    },
+                    "resourceMaxCapacity": {
+                      "type": "number",
+                      "description": "Maximum delivery capacity of orders or items."
+                    },
+                    "reservedValue": {
+                      "type": "number",
+                      "description": "Orders or items reserved from the delivery capacity."
+                    },
+                    "reservations": {
+                      "type": "array",
+                      "description": "List of [reservations](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92).",
+                      "items": {
+                        "type": "object",
+                        "description": "Reservation details.",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "Reservation ID."
+                          },
+                          "value": {
+                            "type": "number",
+                            "description": "Reservation number of items or orders, according to the capacity type set."
+                          }
+                        }
+                      }
+                    },
+                    "log": {
+                      "type": "array",
+                      "description": "System processing information.",
+                      "items": {
+                        "type": "object",
+                        "description": "Log information.",
+                        "properties": {
+                          "when": {
+                            "type": "string",
+                            "description": "Delivery capacity alteration date and time, in the format `YYYY-MM-DDTHH:MM:SSZ`. The time zone is set according to the store account."
+                          },
+                          "who": {
+                            "type": "string",
+                            "description": "Who altered the delivery capacity."
+                          },
+                          "why": {
+                            "type": "string",
+                            "description": "Reason for the alteration."
+                          },
+                          "what": {
+                            "type": "string",
+                            "description": "Situation of the corresponding [delivery window](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi#delivery-window), which can be `Blocked` or `Unblocked`."
+                          }
+                        }
+                      }
+                    }
+                  }
+                },
+                "example": {
+                  "id": "2024-07-19F1300T1700",
+                  "resourceId": "carrier@skus_quantity@168e017",
+                  "startDate": "2024-07-19T13:00:00+00:00",
+                  "endDate": "2024-07-26T17:00:59+00:00",
+                  "ownMaxCapacity": 10,
+                  "resourceMaxCapacity": 16,
+                  "reservedValue": 6,
+                  "reservations": [
+                    {
+                      "id": "SLR-1379840726134-01",
+                      "value": 4
+                    },
+                    {
+                      "id": "SLR-1379840726341-01",
+                      "value": 2
+                    }
+                  ],
+                  "log": [
+                    {
+                      "when": "2024-07-20T15:56:09.1732357+00:00",
+                      "who": "Daniel Thompson",
+                      "why": "Reservation `SLR-1379840726134-01` with 4.0 units.",
+                      "what": "Unblocked"
+                    },
+                    {
+                      "when": "2024-07-22T17:29:11.9250354+00:00",
+                      "who": "Daniel Thompson",
+                      "why": "Reservation `SLR-1379840726341-01` with 2.0 units.",
+                      "what": "Unblocked"
+                    }
+                  ]
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "security": [
+    {
+      "appKey": [],
+      "appToken": []
+    },
+    {
+      "VtexIdclientAutCookie": []
+    }
+  ],
+  "components": {
+    "parameters": {
+      "Content-Type": {
+        "name": "Content-Type",
+        "in": "header",
+        "description": "Type of the content being sent.",
+        "required": true,
+        "style": "simple",
+        "schema": {
+          "type": "string",
+          "example": "application/json"
+        }
+      },
+      "Accept": {
+        "name": "Accept",
+        "in": "header",
+        "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+        "required": true,
+        "style": "simple",
+        "schema": {
+          "type": "string",
+          "example": "application/json"
+        }
+      }
+    },
+    "schemas": {
+      "PickupPoint": {
+        "type": "object",
+        "description": "Pickup point information.",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "[Pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) ID."
+          },
+          "name": {
+            "type": "string",
+            "description": "Pickup point name displayed to customers at checkout."
+          },
+          "description": {
+            "type": "string",
+            "description": "Pickup point description displayed to customers at checkout."
+          },
+          "instructions": {
+            "type": "string",
+            "description": "Instructions for customers when collecting their package."
+          },
+          "formatted_address": {
+            "type": "string",
+            "description": "Formatted address.",
+            "nullable": true
+          },
+          "address": {
+            "type": "object",
+            "description": "Pickup point address information.",
+            "properties": {
+              "postalCode": {
+                "type": "string",
+                "description": "Pickup point address postal code."
+              },
+              "country": {
+                "type": "object",
+                "description": "Information about the pickup point address country.",
+                "properties": {
+                  "acronym": {
+                    "type": "string",
+                    "description": "Three-digit country code of the pickup point address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format."
+                  },
+                  "name": {
+                    "type": "string",
+                    "description": "Country name of the pickup point address."
+                  }
+                }
+              },
+              "city": {
+                "type": "string",
+                "description": "Pickup point address city."
+              },
+              "state": {
+                "type": "string",
+                "description": "Pickup point address state."
+              },
+              "neighborhood": {
+                "type": "string",
+                "description": "Pickup point address neighborhood."
+              },
+              "street": {
+                "type": "string",
+                "description": "Pickup point address street."
+              },
+              "number": {
+                "type": "string",
+                "description": "Pickup point address number."
+              },
+              "complement": {
+                "type": "string",
+                "description": "Pickup point address complement."
+              },
+              "reference": {
+                "type": "string",
+                "description": "Reference point to help the customer find the pickup point."
+              },
+              "location": {
+                "type": "object",
+                "description": "Pickup point address geolocation coordinates.",
+                "properties": {
+                  "latitude": {
+                    "type": "number",
+                    "description": "Latitude coordinate."
+                  },
+                  "longitude": {
+                    "type": "number",
+                    "description": "Longitude coordinate."
+                  }
+                }
+              }
+            }
+          },
+          "isActive": {
+            "type": "boolean",
+            "description": "Defines if the pickup point is active (`true`) or inactive (`false`)."
+          },
+          "distance": {
+            "type": "number",
+            "description": "Pickup point configured distance."
+          },
+          "seller": {
+            "type": "string",
+            "description": "Seller that corresponds to the pickup point."
+          },
+          "_sort": {
+            "type": "array",
+            "description": "Sort array.",
+            "items": {
+              "type": "number",
+              "description": "Pickup point sort information."
+            }
+          },
+          "businessHours": {
+            "type": "array",
+            "description": "Pickup point business hours configurations.",
+            "items": {
+              "type": "object",
+              "description": "Business hours configurations from Monday to Friday.",
+              "properties": {
+                "dayOfWeek": {
+                  "type": "integer",
+                  "description": "Day of the week identification, as in `1` = Monday, `2` = Tuesday, `3` = Wednesday, `4` = Thursday, and `5` = Friday."
+                },
+                "openingTime": {
+                  "type": "string",
+                  "description": "Opening time in `HH:MM:SS` format."
+                },
+                "closingTime": {
+                  "type": "string",
+                  "description": "Closing time in `HH:MM:SS` format."
+                }
+              }
+            }
+          },
+          "tagsLabel": {
+            "type": "array",
+            "description": "Tags that identify a group of pickup points.",
+            "items": {
+              "type": "string",
+              "description": "Pickup point tag label."
+            }
+          },
+          "pickupHolidays": {
+            "type": "array",
+            "description": "[Holidays](https://help.vtex.com/en/tutorial/registering-holidays--2ItOthSEAoyAmcwsuiO6Yk) configured for the pickup point.",
+            "items": {
+              "type": "object",
+              "description": "Holiday information.",
+              "properties": {
+                "date": {
+                  "type": "string",
+                  "description": "Holiday date and time, in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss.ssZ`."
+                },
+                "hourBegin": {
+                  "type": "string",
+                  "description": "Holiday beginning time in `HH:MM` format."
+                },
+                "hourEnd": {
+                  "type": "string",
+                  "description": "Holiday ending time in `HH:MM` format."
+                }
+              }
+            }
+          },
+          "isThirdPartyPickup": {
+            "type": "boolean",
+            "description": "Defines if the pickup point is third-party (`true`) or not (`false`)."
+          },
+          "accountOwnerName": {
+            "type": "string",
+            "description": "Account owner name."
+          },
+          "accountOwnerId": {
+            "type": "string",
+            "description": "Account owner ID."
+          },
+          "parentAccountName": {
+            "type": "string",
+            "description": "Parent account name."
+          },
+          "originalId": {
+            "type": "string",
+            "description": "Original ID.",
+            "nullable": true
+          }
+        }
+      },
+      "ListDocksById": {
+        "type": "object",
+        "description": "Loading dock information.",
+        "properties": {
+          "pickupStoreInfo": {
+            "type": "object",
+            "description": "Information about a loading dock that was transformed into a [pickup point](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R).",
+            "deprecated": true,
+            "properties": {
+              "isPickupStore": {
+                "type": "boolean",
+                "description": "Defines if the shipping type was pickup (`true`) or not (`false`).",
+                "nullable": true,
+                "deprecated": true
+              },
+              "storeId": {
+                "type": "string",
+                "description": "Store ID for stores that acted as pickup points.",
+                "nullable": true,
+                "deprecated": true
+              },
+              "friendlyName": {
+                "type": "string",
+                "description": "Name of the pickup point displayed at checkout.",
+                "nullable": true,
+                "deprecated": true
+              },
+              "address": {
+                "type": "object",
+                "description": "Pickup point address information.",
+                "nullable": true,
+                "deprecated": true,
+                "properties": {
+                  "postalCode": {
+                    "type": "string",
+                    "description": "Pickup point address postal code.",
+                    "deprecated": true
+                  },
+                  "country": {
+                    "type": "object",
+                    "description": "Information about the pickup point address country.",
+                    "deprecated": true,
+                    "properties": {
+                      "acronym": {
+                        "type": "string",
+                        "description": "Three-digit country code of the pickup point address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format.",
+                        "deprecated": true
+                      },
+                      "name": {
+                        "type": "string",
+                        "description": "Country name of the pickup point address.",
+                        "deprecated": true
+                      }
+                    }
+                  },
+                  "city": {
+                    "type": "string",
+                    "description": "Pickup point address city.",
+                    "deprecated": true
+                  },
+                  "state": {
+                    "type": "string",
+                    "description": "Pickup point address state.",
+                    "deprecated": true
+                  },
+                  "neighborhood": {
+                    "type": "string",
+                    "description": "Pickup point address neighborhood.",
+                    "deprecated": true
+                  },
+                  "street": {
+                    "type": "string",
+                    "description": "Pickup point address street.",
+                    "deprecated": true
+                  },
+                  "number": {
+                    "type": "string",
+                    "description": "Pickup point address number.",
+                    "deprecated": true
+                  },
+                  "complement": {
+                    "type": "string",
+                    "description": "Pickup point address complement.",
+                    "deprecated": true,
+                    "nullable": true
+                  },
+                  "reference": {
+                    "type": "string",
+                    "description": "Pickup point address reference point.",
+                    "deprecated": true,
+                    "nullable": true
+                  },
+                  "location": {
+                    "type": "object",
+                    "description": "Pickup point address geolocation coordinates.",
+                    "deprecated": true,
+                    "properties": {
+                      "latitude": {
+                        "type": "number",
+                        "description": "Latitude coordinate.",
+                        "deprecated": true
+                      },
+                      "longitude": {
+                        "type": "number",
+                        "description": "Longitude coordinate.",
+                        "deprecated": true
+                      }
+                    }
+                  }
+                }
+              },
+              "additionalInfo": {
+                "type": "string",
+                "description": "Additional information about the delivery or the pickup point.",
+                "nullable": true,
+                "deprecated": true
+              },
+              "dockId": {
+                "type": "string",
+                "description": "ID of the [loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj related to the delivery or the pickup point ID.",
+                "nullable": true,
+                "deprecated": true
+              },
+              "distance": {
+                "type": "number",
+                "description": "Distance in kilometers between the pickup point and the customer's address, measured as a straight line.",
+                "nullable": true,
+                "deprecated": true
+              },
+              "businessHours": {
+                "type": "string",
+                "description": "Pickup point business hours configurations.",
+                "nullable": true,
+                "deprecated": true
+              },
+              "pickupHolidays": {
+                "type": "string",
+                "description": "Holiday's configurations applicable to the pickup point.",
+                "nullable": true,
+                "deprecated": true
+              },
+              "sellerId": {
+                "type": "string",
+                "description": "Seller ID.",
+                "nullable": true,
+                "deprecated": true
+              },
+              "isThirdPartyPickup": {
+                "type": "boolean",
+                "description": "Defines if the pickup was third party (`true`) or not (`false`).",
+                "deprecated": true
+              }
+            }
+          },
+          "storeId": {
+            "type": "string",
+            "description": "Store ID.",
+            "nullable": true
+          },
+          "pickupInStoreInfo": {
+            "type": "object",
+            "description": "Information about the physical store as a pickup point.",
+            "properties": {
+              "isActice": {
+                "type": "boolean",
+                "description": "Defines if the physical store is a pickup point (`true`) or not (`false`)."
+              },
+              "additionalInfo": {
+                "type": "string",
+                "description": "Additional information of the store as a pickup point.",
+                "nullable": true
+              }
+            }
+          },
+          "deliveryFromStoreInfo": {
+            "type": "object",
+            "description": "Settings for delivery from a physical store.",
+            "properties": {
+              "isActice": {
+                "type": "boolean",
+                "description": "Defines if the settings for delivery from physical stores are active (`true`) or inactive (`false`)."
+              },
+              "deliveryRadius": {
+                "type": "number",
+                "description": "Delivery radius."
+              },
+              "deliveryFee": {
+                "type": "number",
+                "description": "Delivery fee."
+              },
+              "deliveryTime": {
+                "type": "string",
+                "description": "Delivery time in the format `DD.HH:MM:SS`."
+              },
+              "maximumWeight": {
+                "type": "number",
+                "description": "Delivery maximum weight."
+              }
+            }
+          },
+          "address": {
+            "type": "object",
+            "description": "Loading dock address.",
+            "properties": {
+              "postalCode": {
+                "type": "string",
+                "description": "Loading dock address postal code."
+              },
+              "country": {
+                "type": "object",
+                "description": "Information about the loading dock address country.",
+                "properties": {
+                  "acronym": {
+                    "type": "string",
+                    "description": "Three-digit country code of the loading dock address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format."
+                  },
+                  "name": {
+                    "type": "string",
+                    "description": "Country name of the loading dock address."
+                  }
+                }
+              },
+              "city": {
+                "type": "string",
+                "description": "Loading dock address city."
+              },
+              "state": {
+                "type": "string",
+                "description": "Loading dock address state."
+              },
+              "neighborhood": {
+                "type": "string",
+                "description": "Loading dock address neighborhood."
+              },
+              "street": {
+                "type": "string",
+                "description": "Loading dock address street."
+              },
+              "number": {
+                "type": "string",
+                "description": "Loading dock address number."
+              },
+              "complement": {
+                "type": "string",
+                "description": "Loading dock address complement.",
+                "nullable": true
+              },
+              "reference": {
+                "type": "string",
+                "description": "Loading dock address reference point.",
+                "nullable": true
+              },
+              "location": {
+                "type": "object",
+                "description": "Loading dock address geolocation coordinates.",
+                "properties": {
+                  "latitude": {
+                    "type": "number",
+                    "description": "Latitude coordinate."
+                  },
+                  "longitude": {
+                    "type": "number",
+                    "description": "Longitude coordinate."
+                  }
+                }
+              }
+            }
+          },
+          "location": {
+            "type": "object",
+            "description": "Loading dock location details.",
+            "nullable": true,
+            "properties": {
+              "zipCode": {
+                "type": "string",
+                "description": "Loading dock address postal code."
+              },
+              "country": {
+                "type": "string",
+                "description": "Three-digit country code of the loading dock address, in [ISO 3166 ALPHA-3](https://www.iban.com/country-codes) format."
+              },
+              "inStore": {
+                "type": "object",
+                "description": "Information related to orders made via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc).",
+                "properties": {
+                  "IsCheckedIn": {
+                    "type": "boolean",
+                    "description": "Defines if orders can be placed via [VTEX Sales App](https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc) (`true`) or not (`false`)."
+                  },
+                  "StoreId": {
+                    "type": "string",
+                    "description": "ID of purchases made in the GoCommerce context.",
+                    "nullable": true
+                  }
+                }
+              }
+            }
+          },
+          "shippingRatesProviders": {
+            "type": "array",
+            "description": "Shipping rates providers information.",
+            "items": {
+              "type": "string",
+              "description": "Shipping rates."
+            },
+            "nullable": true
+          },
+          "deliveryAgreementsIds": {
+            "type": "array",
+            "description": "Delivery agreements IDs information.",
+            "items": {
+              "type": "string",
+              "description": "Delivery agreements IDs."
+            },
+            "nullable": true
+          },
+          "id": {
+            "type": "string",
+            "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) ID."
+          },
+          "name": {
+            "type": "string",
+            "description": "Loading dock name."
+          },
+          "priority": {
+            "type": "integer",
+            "description": "Value from `0` to `10` used as a tie-breaking rule for loading dock selecting. The greater the priority, the greater the possibility of the loading dock being chosen in [shipping calculation](https://help.vtex.com/en/tutorial/how-shipping-calculation-works--tutorials_116). When no priority was set, it corresponds to `0`."
+          },
+          "dockTimeFake": {
+            "type": "string",
+            "description": "[Loading dock](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) processing time in the format `D.HH:MM:SS`. When not configured, it returns `00:00:00`."
+          },
+          "timeFakeOverhead": {
+            "type": "string",
+            "description": "Time frame used to choose a loading dock when there is more than one loading dock with the same processing time. The lower the value entered in this field, the greater the possibility of the loading dock being chosen. \r\n>ℹ️ This field is not considered when calculating the delivery time."
+          },
+          "salesChannels": {
+            "type": "array",
+            "description": "Sales channels ([trade policies](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) associated with the loading dock.",
+            "items": {
+              "type": "string",
+              "description": "Sales channel ID."
+            }
+          },
+          "salesChannel": {
+            "type": "string",
+            "description": "Main sales channel ([trade policy](https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV)) associated with the loading dock."
+          },
+          "freightTableIds": {
+            "type": "array",
+            "description": "List with freight table IDs associated with the loading dock.",
+            "items": {
+              "type": "string",
+              "description": "Freight table ID."
+            }
+          },
+          "wmsEndPoint": {
+            "type": "string",
+            "description": "Endpoint for integrating an external Warehouse Management System (WMS).",
+            "nullable": true
+          },
+          "isActive": {
+            "type": "boolean",
+            "description": "Defines if the loading dock is active (`true`) or inactive (`false`)."
+          }
+        }
+      },
+      "DeliveryCapacity": {
+        "type": "object",
+        "description": "Information about the [capacity reservation](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz) of the [shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140).",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "Capacity reservation ID generated by the request."
+          },
+          "resourceId": {
+            "type": "string",
+            "description": "Combined string `carrier@{capacityType}@{shippingPolicyId}` used in the request."
+          },
+          "startDate": {
+            "type": "string",
+            "description": "Starting date and time of the period considered for the request, in the format `YYYY-MM-DDTHH:MM:SSZ`. The time zone is set according to the store account."
+          },
+          "endDate": {
+            "type": "string",
+            "description": "Ending date and time of the period considered for the request, in the format `YYYY-MM-DDTHH:MM:SSZ`. The time zone is set according to the store account."
+          },
+          "ownMaxCapacity": {
+            "type": "number",
+            "description": "Delivery capacity available, which is the total capacity minus the reserved orders or items, according to the capacity type set."
+          },
+          "resourceMaxCapacity": {
+            "type": "number",
+            "description": "Maximum delivery capacity of orders or items."
+          },
+          "reservedValue": {
+            "type": "number",
+            "description": "Orders or items reserved from the delivery capacity."
+          },
+          "reservations": {
+            "type": "array",
+            "description": "List of [reservations](https://help.vtex.com/en/tutorial/how-does-reservation-work--tutorials_92).",
+            "items": {
+              "type": "object",
+              "description": "Reservation details.",
+              "properties": {
+                "id": {
+                  "type": "string",
+                  "description": "Reservation ID."
+                },
+                "value": {
+                  "type": "number",
+                  "description": "Reservation number of items or orders, according to the capacity type set."
+                }
+              }
+            }
+          },
+          "log": {
+            "type": "array",
+            "description": "System processing information.",
+            "items": {
+              "type": "object",
+              "description": "Log information.",
+              "properties": {
+                "when": {
+                  "type": "string",
+                  "description": "Delivery capacity alteration date and time, in the format `YYYY-MM-DDTHH:MM:SSZ`. The time zone is set according to the store account."
+                },
+                "who": {
+                  "type": "string",
+                  "description": "Who altered the delivery capacity."
+                },
+                "why": {
+                  "type": "string",
+                  "description": "Reason for the alteration."
+                },
+                "what": {
+                  "type": "string",
+                  "description": "Situation of the corresponding [delivery window](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi#delivery-window), which can be `Blocked` or `Unblocked`."
+                }
+              }
+            }
+          }
+        }
+      },
+      "ShippingPolicy": {
+        "type": "object",
+        "description": "Details about a given shipping policy.",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "[Shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) ID."
+          },
+          "name": {
+            "type": "string",
+            "description": "[Shipping policy](https://help.vtex.com/en/tutorial/shipping-policy--tutorials_140) name."
+          },
+          "shippingMethod": {
+            "type": "string",
+            "description": "Type of shipping available for this shipping policy (carrier). Options are shown on [shipping simulation](https://help.vtex.com/en/tutorial/shipping-simulation--tutorials_144)."
+          },
+          "weekendAndHolidays": {
+            "type": "object",
+            "description": "If the shipping policy includes deliveries on weekends and holidays.",
+            "properties": {
+              "saturday": {
+                "type": "boolean",
+                "description": "Defines if shipping on Saturdays is valid (`true`) or not (`false`)."
+              },
+              "sunday": {
+                "type": "boolean",
+                "description": "Defines if shipping on Sundays is valid (`true`) or not (`false`)."
+              },
+              "holiday": {
+                "type": "boolean",
+                "description": "Defines if shipping on holidays is valid (`true`) or not (`false`)."
+              }
+            }
+          },
+          "maxDimension": {
+            "type": "object",
+            "description": "Object containing attributes of maximum dimension permitted by the shipping policy (carrier).",
+            "properties": {
+              "largestMeasure": {
+                "type": "number",
+                "description": "Largest measure acceptable of the package."
+              },
+              "maxMeasureSum": {
+                "type": "number",
+                "description": "Limit for the sum of all maximum measures of the package."
+              }
+            }
+          },
+          "numberOfItemsPerShipment": {
+            "type": "integer",
+            "description": "Determines the number of items allowed per shipment."
+          },
+          "minimumValueAceptable": {
+            "type": "number",
+            "description": "Minimum value accepted by the carrier for delivering."
+          },
+          "maximumValueAceptable": {
+            "type": "number",
+            "description": "Maximum value accepted by the carrier for delivering."
+          },
+          "additionalTime": {
+            "type": "string",
+            "description": "Additional time configured in `HH:MM:SS` format.",
+            "deprecated": true
+          },
+          "additionalPrice": {
+            "type": "object",
+            "description": "Additional price object.",
+            "properties": {
+              "method": {
+                "type": "integer",
+                "description": "Additional price method.",
+                "deprecated": true
+              },
+              "value": {
+                "type": "number",
+                "description": "Payment value.",
+                "deprecated": true
+              }
+            },
+            "deprecated": true
+          },
+          "deliveryScheduleSettings": {
+            "type": "object",
+            "description": "[Scheduled delivery](https://help.vtex.com/en/tutorial/scheduled-delivery--22g3HAVCGLFiU7xugShOBi) settings.",
+            "properties": {
+              "useDeliverySchedule": {
+                "type": "boolean",
+                "description": "Defines if the scheduled delivery configuration is active (`true`) or not (`false`)."
+              },
+              "maxRangeDelivery": {
+                "type": "number",
+                "description": "Range of days available within a delivery window, for the customer to choose the scheduled delivery. For example, if the configured `maxRangeDelivery` is equal `7`, and the customer buys something on a Tuesday, the options for scheduled delivery will be shown until the following Tuesday (7 days from the purchase day). If no options are available within the `maxRangeDelivery` set, the shipping policy will not be shown on the checkout."
+              },
+              "dayOfWeekForDelivery": {
+                "type": "array",
+                "description": "Selected days for delivery, from `0` (Sunday) to `6` (Saturday).",
+                "items": {
+                  "type": "object",
+                  "description": "Selected days for delivery objects.",
+                  "properties": {
+                    "dayOfWeek": {
+                      "type": "integer",
+                      "description": "Day of the week, from `0` (Sunday) to `6` (Saturday)."
+                    },
+                    "deliveryRanges": {
+                      "type": "array",
+                      "description": "Reservation window for scheduled delivery.",
+                      "items": {
+                        "type": "object",
+                        "description": "Reservation window for scheduled delivery object.",
+                        "properties": {
+                          "startTime": {
+                            "type": "string",
+                            "description": "Start time for day of the week in `hh:mm:ss` format."
+                          },
+                          "endTime": {
+                            "type": "string",
+                            "description": "End time for day of the week in `hh:mm:ss` format."
+                          },
+                          "listPrice": {
+                            "type": "number",
+                            "description": "List price for day of the week."
+                          },
+                          "deliveryCapacity": {
+                            "type": "array",
+                            "description": "Sets maximum [delivery capacity](https://help.vtex.com/en/tutorial/managing-delivery-capacity--2y217FQZCjD0I1n62yxVcz) for a given reservation window for scheduled delivery.",
+                            "nullable": true,
+                            "items": {
+                              "type": "object",
+                              "description": "Object with the maximum delivery capacity for a reservation window.",
+                              "properties": {
+                                "capacityType": {
+                                  "type": "string",
+                                  "description": "Defines how the delivery capacity is measured for this reservation window, by maximum number of orders (`ORDERS_QUANTITY`) or items (`SKUS_QUANTITY`)."
+                                },
+                                "maxValue": {
+                                  "type": "number",
+                                  "description": "Maximum number of orders or SKUs that the store is capable of fulfilling."
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              },
+              "dayOfWeekBlockeds": {
+                "type": "array",
+                "description": "Defines if there are any days of the week that are blocked.",
+                "items": {
+                  "type": "string",
+                  "description": "Date and time of the blocked day in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ss`."
+                },
+                "nullable": true,
+                "deprecated": true
+              }
+            }
+          },
+          "carrierSchedule": {
+            "type": "array",
+            "description": "Schedule sent by the carrier to configure the shipping policy.",
+            "items": {
+              "type": "object",
+              "description": "Carrier schedule for configuring the shipping policy object.",
+              "properties": {
+                "dayOfWeek": {
+                  "type": "integer",
+                  "description": "Day of the week from `0` (Sunday) to `6` (Saturday)."
+                },
+                "timeLimit": {
+                  "type": "string",
+                  "description": "Time limit in `HH:MM:SS` format."
+                }
+              }
+            }
+          },
+          "cubicWeightSettings": {
+            "type": "object",
+            "description": "Settings for the cubic weight of a package, which accounts for the [package's volume](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128), and not only weight.",
+            "properties": {
+              "volumetricFactor": {
+                "type": "number",
+                "description": "Factor that will be used on the cubic weight calculation, usually given by the carrier."
+              },
+              "minimunAcceptableVolumetricWeight": {
+                "type": "number",
+                "description": "Packages' minimum acceptable [volumetric weight](https://help.vtex.com/en/tutorial/understanding-the-cubic-weight-factor--tutorials_128)."
+              }
+            }
+          },
+          "modalSettings": {
+            "type": "object",
+            "description": "Configurations for the [modal](https://help.vtex.com/en/tutorial/how-does-the-modal-work--tutorials_125), which is the attachement of a specific product to a carrier specialized in delivering that type of product.",
+            "properties": {
+              "modals": {
+                "type": "array",
+                "description": "Type of special freight.",
+                "items": {
+                  "type": "string",
+                  "enum": [
+                    "CHEMICALS",
+                    "ELECTRONICS",
+                    "FURNITURE",
+                    "GLASS",
+                    "LIQUID",
+                    "MATTRESSES",
+                    "REFRIGERATED",
+                    "TIRES",
+                    "WHITE_GOODS",
+                    "FIREARMS"
+                  ],
+                  "description": "Modal values assigned to the special freight."
+                }
+              },
+              "useOnlyItemsWithDefinedModal": {
+                "type": "boolean",
+                "description": "When set as `true`, the modal's configurations will apply only for items with a defined modal, when `false`, the modal configuration will not be set."
+              }
+            }
+          },
+          "businessHourSettings": {
+            "type": "object",
+            "description": "Business hours configurations.",
+            "properties": {
+              "carrierBusinessHours": {
+                "type": "array",
+                "description": "Business hours configurations array for the days of the week.",
+                "items": {
+                  "type": "object",
+                  "description": "Business hours configurations for a single day of the week.",
+                  "properties": {
+                    "openingTime": {
+                      "type": "string",
+                      "description": "Opening time in `HH:MM:SS` format."
+                    },
+                    "closingTime": {
+                      "type": "string",
+                      "description": "Closing time in `HH:MM:SS` format."
+                    },
+                    "dayOfWeek": {
+                      "type": "integer",
+                      "description": "Day of the week from `0` (Sunday) to `6` (Saturday).",
+                      "enum": [
+                        0,
+                        1,
+                        2,
+                        3,
+                        4,
+                        5,
+                        6
+                      ]
+                    }
+                  }
+                }
+              },
+              "isOpenOutsideBusinessHours": {
+                "type": "boolean",
+                "description": "Defines if deliveries outside business hours are allowed (`true`) or not (`false`)."
+              }
+            }
+          },
+          "pickupPointsSettings": {
+            "type": "object",
+            "description": "[Pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) configurations of the shipping policy.",
+            "properties": {
+              "pickupPointIds": {
+                "type": "array",
+                "description": "Pickup point IDs configured for the shipping policy.",
+                "items": {
+                  "type": "string",
+                  "description": "Pickup point ID."
+                }
+              },
+              "pickupPointTags": {
+                "type": "array",
+                "description": "Pickup points tags configured for the shipping policy.",
+                "items": {
+                  "type": "string",
+                  "description": "Tag identification."
+                }
+              },
+              "sellers": {
+                "type": "array",
+                "description": "Sellers associated with [pickup points](https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) related to the shipping policy.",
+                "items": {
+                  "type": "string",
+                  "description": "Sellers IDS."
+                }
+              }
+            }
+          },
+          "processingStatus": {
+            "type": "object",
+            "description": "Shipping policy processing status.",
+            "properties": {
+              "status": {
+                "type": "integer",
+                "format": "int32",
+                "description": "Shipping policy processing status code."
+              },
+              "errorMessage": {
+                "type": "string",
+                "description": "Error message, when applicable.",
+                "nullable": true
+              },
+              "errorsMetadata": {
+                "type": "string",
+                "description": "Error metadata, when applicable.",
+                "nullable": true
+              }
+            }
+          },
+          "deliveryChannel": {
+            "type": "string",
+            "description": "Defines if the shipping type is `delivery` or `pickup`."
+          },
+          "calculationType": {
+            "type": "integer",
+            "description": "Shipping policy calculation type."
+          },
+          "isActive": {
+            "type": "boolean",
+            "description": "Defines if the shipping policy is active (`true`) or not (`false`)."
+          },
+          "lastIndexedAt": {
+            "type": "string",
+            "description": "Date and time since the last [indexing](https://help.vtex.com/en/tutorial/understanding-how-indexation-works--tutorials_256), in [ISO 8601 time zone offset format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DD hh:mm:ss[.nnnnnnn]+hh:mm`.",
+            "nullable": true
+          },
+          "shippingHoursSettings": {
+            "type": "object",
+            "description": "Shipping hours settings configurations.",
+            "properties": {
+              "shippingHours": {
+                "type": "array",
+                "description": "Shipping hours settings array.",
+                "items": {
+                  "type": "object",
+                  "description": "Object with details on shipping hours settings.",
+                  "properties": {
+                    "dayOfWeek": {
+                      "type": "integer",
+                      "description": "Day of the week from `0` (Sunday) to `6` (Saturday)."
+                    },
+                    "openingTime": {
+                      "type": "string",
+                      "description": "Opening time in `hh:mm:ss` format."
+                    },
+                    "closingTime": {
+                      "type": "string",
+                      "description": "Closing time in `hh:mm:ss` format."
+                    }
+                  }
+                }
+              },
+              "acceptOrdersOutsideShippingHours": {
+                "type": "boolean",
+                "description": "Defines if the configuration that allows accepting orders outside shipping hours is active (`true`) or not (`false`)."
+              }
+            }
+          },
+          "carrierInfo": {
+            "type": "object",
+            "description": "[Carrier](https://help.vtex.com/en/tutorial/carriers-on-vtex--7u9duMD5UQa2QQwukAWMcE) information.",
+            "properties": {
+              "carrierAccountName": {
+                "type": "string",
+                "description": "VTEX store account name related to the shipping policy."
+              },
+              "deliveryAgreementId": {
+                "type": "string",
+                "description": "Delivery agreement ID.",
+                "nullable": true
+              },
+              "linkedDocks": {
+                "type": "array",
+                "description": "Shipping policy [loading docks](https://help.vtex.com/en/tutorial/loading-dock--5DY8xHEjOLYDVL41Urd5qj) valid for the carrier.",
+                "items": {
+                  "type": "object",
+                  "description": "Loading dock object.",
+                  "properties": {
+                    "id": {
+                      "type": "string",
+                      "description": "Loading dock ID."
+                    },
+                    "name": {
+                      "type": "string",
+                      "description": "Loading dock name."
+                    }
+                  }
+                }
+              },
+              "readyToUse": {
+                "type": "boolean",
+                "description": "Defines if shipping configurations related to the carrier make them ready for shipping (`true`) or not (`false`)."
+              }
+            }
+          }
+        }
+      }
+    },
+    "securitySchemes": {
+      "appKey": {
+        "type": "apiKey",
+        "in": "header",
+        "name": "X-VTEX-API-AppKey",
+        "description": "Unique identifier of the [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys)."
+      },
+      "appToken": {
+        "type": "apiKey",
+        "in": "header",
+        "name": "X-VTEX-API-AppToken",
+        "description": "Secret token of the [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys)."
+      },
+      "VtexIdclientAutCookie": {
+        "type": "apiKey",
+        "in": "header",
+        "name": "VtexIdclientAutCookie",
+        "description": "[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours."
+      }
+    }
+  },
+  "tags": [
+    {
+      "name": "Scheduled delivery"
+    },
+    {
+      "name": "Shipping policies"
+    },
+    {
+      "name": "Docks"
+    },
+    {
+      "name": "Warehouses"
+    },
+    {
+      "name": "Inventory"
+    },
+    {
+      "name": "Holidays"
+    },
+    {
+      "name": "Reservations"
+    },
+    {
+      "name": "SLA"
+    },
+    {
+      "name": "Pickup points"
+    },
+    {
+      "name": "Polygons"
+    },
+    {
+      "name": "Freight values"
+    }
+  ]
+}
\ No newline at end of file
diff --git a/vtex/utils/openapi/vcs.openapi.json b/vtex/utils/openapi/vcs.openapi.json
index d978962a9..cc5e7d91c 100644
--- a/vtex/utils/openapi/vcs.openapi.json
+++ b/vtex/utils/openapi/vcs.openapi.json
@@ -53402,4 +53402,4 @@
     },
     "tags": []
   }
-}
+}
\ No newline at end of file

From cf86157405c3e6d806d5c13790ac5c2c50680615 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Mon, 15 Dec 2025 18:22:41 -0400
Subject: [PATCH 67/93] feat: set holidays api visibility to private

---
 vtex/loaders/logistics/listHolidays.ts | 1 +
 1 file changed, 1 insertion(+)

diff --git a/vtex/loaders/logistics/listHolidays.ts b/vtex/loaders/logistics/listHolidays.ts
index 23e6802e0..4c6fe57d0 100644
--- a/vtex/loaders/logistics/listHolidays.ts
+++ b/vtex/loaders/logistics/listHolidays.ts
@@ -30,3 +30,4 @@ export const cache = {
 export const cacheKey = (_props: unknown, _req: Request, _ctx: AppContext) => {
   return "logistics-holidays";
 };
+export const defaultVisibility = "private";

From 63ded9ac5ff579d01eee576b8d118fa2835dbd29 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Tue, 30 Dec 2025 13:14:12 -0400
Subject: [PATCH 68/93] feat: accept fit property in Source component

---
 website/components/Image.tsx   | 2 +-
 website/components/Picture.tsx | 5 ++++-
 2 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/website/components/Image.tsx b/website/components/Image.tsx
index 02de935a1..adb1f885d 100644
--- a/website/components/Image.tsx
+++ b/website/components/Image.tsx
@@ -31,7 +31,7 @@ export type Props =
 
 export const FACTORS = [1, 2];
 
-type FitOptions = "contain" | "cover";
+export type FitOptions = "contain" | "cover";
 
 const isImageOptmizationEnabled = () =>
   IS_BROWSER
diff --git a/website/components/Picture.tsx b/website/components/Picture.tsx
index 8ce411852..e967db4de 100644
--- a/website/components/Picture.tsx
+++ b/website/components/Picture.tsx
@@ -5,6 +5,7 @@ import { Head, IS_BROWSER } from "$fresh/runtime.ts";
 
 import {
   FACTORS,
+  FitOptions,
   getEarlyHintFromSrcProps,
   getSrcSet,
   type SetEarlyHint,
@@ -30,6 +31,8 @@ type SourceProps =
     preload?: boolean;
     /** @description Improves Web Vitals (LCP). Use high for LCP image. Auto for other images */
     fetchPriority?: "high" | "low" | "auto";
+    /** @description Object-fit */
+    fit?: FitOptions;
     setEarlyHint?: SetEarlyHint;
   };
 
@@ -42,7 +45,7 @@ export const Source = forwardRef<HTMLSourceElement, SourceProps>(
       props.src,
       props.width,
       props.height,
-      undefined,
+      props.fit,
       shouldSetEarlyHint ? FACTORS.slice(-1) : FACTORS,
     );
     const linkProps = {

From b17fc920fe31dc36415e50a05493f5877f6f64dd Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Thu, 8 Jan 2026 22:58:17 -0400
Subject: [PATCH 69/93] feat: validate credentials api

---
 vtex/actions/credentials/validate.ts     |   42 +
 vtex/manifest.gen.ts                     |   78 +-
 vtex/mod.ts                              |    3 +-
 vtex/utils/openapi/vtexid.openapi.gen.ts |  594 ++++++
 vtex/utils/openapi/vtexid.openapi.json   | 2088 ++++++++++++++++++++++
 vtex/utils/vtexId.ts                     |    1 +
 6 files changed, 2767 insertions(+), 39 deletions(-)
 create mode 100644 vtex/actions/credentials/validate.ts
 create mode 100644 vtex/utils/openapi/vtexid.openapi.gen.ts
 create mode 100644 vtex/utils/openapi/vtexid.openapi.json

diff --git a/vtex/actions/credentials/validate.ts b/vtex/actions/credentials/validate.ts
new file mode 100644
index 000000000..bfbc241ec
--- /dev/null
+++ b/vtex/actions/credentials/validate.ts
@@ -0,0 +1,42 @@
+import { HttpError } from "../../../utils/http.ts";
+import { AppContext } from "../../mod.ts";
+import { parseCookie } from "../../utils/vtexId.ts";
+
+interface Props {
+  /**
+   * @description Token to validate. If empty it will try to get it from the cookie.
+   */
+  token?: string;
+}
+
+export default async function action(
+  props: Props,
+  req: Request,
+  ctx: AppContext,
+): Promise<{ valid: boolean }> {
+  const { cookies } = parseCookie(req.headers, ctx.account);
+  const autCookie = cookies[`VtexIdclientAutCookie_${ctx.account}`];
+  const token = props.token || autCookie;
+
+  try {
+    const response = await ctx.vcs["POST /api/vtexid/credential/validate"]({}, {
+      body: { token },
+    })
+      .then((res) => res.json());
+
+    return {
+      valid: response.authStatus === "Success",
+    };
+  } catch (error) {
+    if (error instanceof HttpError && error.status === 401) {
+      return {
+        valid: false,
+      };
+    }
+
+    throw new HttpError(
+      500,
+      error instanceof Error ? error.message : "Internal Server Error",
+    );
+  }
+}
diff --git a/vtex/manifest.gen.ts b/vtex/manifest.gen.ts
index 9f67f1ce5..8b2c73196 100644
--- a/vtex/manifest.gen.ts
+++ b/vtex/manifest.gen.ts
@@ -33,25 +33,26 @@ import * as $$$$$$$$$27 from "./actions/cart/updateItemPrice.ts";
 import * as $$$$$$$$$28 from "./actions/cart/updateItems.ts";
 import * as $$$$$$$$$29 from "./actions/cart/updateProfile.ts";
 import * as $$$$$$$$$30 from "./actions/cart/updateUser.ts";
-import * as $$$$$$$$$31 from "./actions/masterdata/createDocument.ts";
-import * as $$$$$$$$$32 from "./actions/masterdata/updateDocument.ts";
-import * as $$$$$$$$$33 from "./actions/masterdata/updatePartialDocument.ts";
-import * as $$$$$$$$$34 from "./actions/newsletter/subscribe.ts";
-import * as $$$$$$$$$35 from "./actions/newsletter/updateNewsletterOptIn.ts";
-import * as $$$$$$$$$36 from "./actions/notifyme.ts";
-import * as $$$$$$$$$37 from "./actions/orders/cancel.ts";
-import * as $$$$$$$$$38 from "./actions/payment/deletePaymentToken.ts";
-import * as $$$$$$$$$39 from "./actions/payments/delete.ts";
-import * as $$$$$$$$$40 from "./actions/profile/newsletterProfile.ts";
-import * as $$$$$$$$$41 from "./actions/profile/updateProfile.ts";
-import * as $$$$$$$$$42 from "./actions/review/submit.ts";
-import * as $$$$$$$$$43 from "./actions/session/createSession.ts";
-import * as $$$$$$$$$44 from "./actions/session/deleteSession.ts";
-import * as $$$$$$$$$45 from "./actions/session/editSession.ts";
-import * as $$$$$$$$$46 from "./actions/sessions/delete.ts";
-import * as $$$$$$$$$47 from "./actions/trigger.ts";
-import * as $$$$$$$$$48 from "./actions/wishlist/addItem.ts";
-import * as $$$$$$$$$49 from "./actions/wishlist/removeItem.ts";
+import * as $$$$$$$$$31 from "./actions/credentials/validate.ts";
+import * as $$$$$$$$$32 from "./actions/masterdata/createDocument.ts";
+import * as $$$$$$$$$33 from "./actions/masterdata/updateDocument.ts";
+import * as $$$$$$$$$34 from "./actions/masterdata/updatePartialDocument.ts";
+import * as $$$$$$$$$35 from "./actions/newsletter/subscribe.ts";
+import * as $$$$$$$$$36 from "./actions/newsletter/updateNewsletterOptIn.ts";
+import * as $$$$$$$$$37 from "./actions/notifyme.ts";
+import * as $$$$$$$$$38 from "./actions/orders/cancel.ts";
+import * as $$$$$$$$$39 from "./actions/payment/deletePaymentToken.ts";
+import * as $$$$$$$$$40 from "./actions/payments/delete.ts";
+import * as $$$$$$$$$41 from "./actions/profile/newsletterProfile.ts";
+import * as $$$$$$$$$42 from "./actions/profile/updateProfile.ts";
+import * as $$$$$$$$$43 from "./actions/review/submit.ts";
+import * as $$$$$$$$$44 from "./actions/session/createSession.ts";
+import * as $$$$$$$$$45 from "./actions/session/deleteSession.ts";
+import * as $$$$$$$$$46 from "./actions/session/editSession.ts";
+import * as $$$$$$$$$47 from "./actions/sessions/delete.ts";
+import * as $$$$$$$$$48 from "./actions/trigger.ts";
+import * as $$$$$$$$$49 from "./actions/wishlist/addItem.ts";
+import * as $$$$$$$$$50 from "./actions/wishlist/removeItem.ts";
 import * as $$$$0 from "./handlers/sitemap.ts";
 import * as $$$0 from "./loaders/address/getAddressByPostalCode.ts";
 import * as $$$1 from "./loaders/address/getAddressByZIP.ts";
@@ -216,25 +217,26 @@ const manifest = {
     "vtex/actions/cart/updateItems.ts": $$$$$$$$$28,
     "vtex/actions/cart/updateProfile.ts": $$$$$$$$$29,
     "vtex/actions/cart/updateUser.ts": $$$$$$$$$30,
-    "vtex/actions/masterdata/createDocument.ts": $$$$$$$$$31,
-    "vtex/actions/masterdata/updateDocument.ts": $$$$$$$$$32,
-    "vtex/actions/masterdata/updatePartialDocument.ts": $$$$$$$$$33,
-    "vtex/actions/newsletter/subscribe.ts": $$$$$$$$$34,
-    "vtex/actions/newsletter/updateNewsletterOptIn.ts": $$$$$$$$$35,
-    "vtex/actions/notifyme.ts": $$$$$$$$$36,
-    "vtex/actions/orders/cancel.ts": $$$$$$$$$37,
-    "vtex/actions/payment/deletePaymentToken.ts": $$$$$$$$$38,
-    "vtex/actions/payments/delete.ts": $$$$$$$$$39,
-    "vtex/actions/profile/newsletterProfile.ts": $$$$$$$$$40,
-    "vtex/actions/profile/updateProfile.ts": $$$$$$$$$41,
-    "vtex/actions/review/submit.ts": $$$$$$$$$42,
-    "vtex/actions/session/createSession.ts": $$$$$$$$$43,
-    "vtex/actions/session/deleteSession.ts": $$$$$$$$$44,
-    "vtex/actions/session/editSession.ts": $$$$$$$$$45,
-    "vtex/actions/sessions/delete.ts": $$$$$$$$$46,
-    "vtex/actions/trigger.ts": $$$$$$$$$47,
-    "vtex/actions/wishlist/addItem.ts": $$$$$$$$$48,
-    "vtex/actions/wishlist/removeItem.ts": $$$$$$$$$49,
+    "vtex/actions/credentials/validate.ts": $$$$$$$$$31,
+    "vtex/actions/masterdata/createDocument.ts": $$$$$$$$$32,
+    "vtex/actions/masterdata/updateDocument.ts": $$$$$$$$$33,
+    "vtex/actions/masterdata/updatePartialDocument.ts": $$$$$$$$$34,
+    "vtex/actions/newsletter/subscribe.ts": $$$$$$$$$35,
+    "vtex/actions/newsletter/updateNewsletterOptIn.ts": $$$$$$$$$36,
+    "vtex/actions/notifyme.ts": $$$$$$$$$37,
+    "vtex/actions/orders/cancel.ts": $$$$$$$$$38,
+    "vtex/actions/payment/deletePaymentToken.ts": $$$$$$$$$39,
+    "vtex/actions/payments/delete.ts": $$$$$$$$$40,
+    "vtex/actions/profile/newsletterProfile.ts": $$$$$$$$$41,
+    "vtex/actions/profile/updateProfile.ts": $$$$$$$$$42,
+    "vtex/actions/review/submit.ts": $$$$$$$$$43,
+    "vtex/actions/session/createSession.ts": $$$$$$$$$44,
+    "vtex/actions/session/deleteSession.ts": $$$$$$$$$45,
+    "vtex/actions/session/editSession.ts": $$$$$$$$$46,
+    "vtex/actions/sessions/delete.ts": $$$$$$$$$47,
+    "vtex/actions/trigger.ts": $$$$$$$$$48,
+    "vtex/actions/wishlist/addItem.ts": $$$$$$$$$49,
+    "vtex/actions/wishlist/removeItem.ts": $$$$$$$$$50,
   },
   "workflows": {
     "vtex/workflows/events.ts": $$$$$$$$$$0,
diff --git a/vtex/mod.ts b/vtex/mod.ts
index 675729f0e..ad8ef63bc 100644
--- a/vtex/mod.ts
+++ b/vtex/mod.ts
@@ -24,9 +24,10 @@ import { OpenAPI as MY } from "./utils/openapi/my.openapi.gen.ts";
 import { OpenAPI as VPAY } from "./utils/openapi/payments.openapi.gen.ts";
 import { OpenAPI as SUB } from "./utils/openapi/subscriptions.openapi.gen.ts";
 import { OpenAPI as _VCS } from "./utils/openapi/vcs.openapi.gen.ts";
+import { OpenAPI as VTEXID } from "./utils/openapi/vtexid.openapi.gen.ts";
 import { OpenAPI as LOGISTICS } from "./utils/openapi/logistics.openapi.gen.ts";
 
-type VCS = _VCS & LOGISTICS;
+type VCS = _VCS & LOGISTICS & VTEXID;
 
 import { Segment } from "./utils/types.ts";
 
diff --git a/vtex/utils/openapi/vtexid.openapi.gen.ts b/vtex/utils/openapi/vtexid.openapi.gen.ts
new file mode 100644
index 000000000..cdda6f1dd
--- /dev/null
+++ b/vtex/utils/openapi/vtexid.openapi.gen.ts
@@ -0,0 +1,594 @@
+
+// deno-fmt-ignore-file
+// deno-lint-ignore-file no-explicit-any ban-types ban-unused-ignore
+//
+// DO NOT EDIT. This file is generated by deco.
+// This file SHOULD be checked into source version control.
+// To generate this file: deno task start
+//        
+
+
+export interface OpenAPI {
+/**
+ * Registers a new storefront user in VTEX ID using a unique login key (username) as `identifier`.
+ * 
+ *  The created user is not linked to any Organization Unit and does not have storefront permissions.
+ * 
+ * Once a storefront user is added, it cannot be edited or removed. If incorrect data is uploaded, create a new username.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | VTEX ID | User Management | **Create User** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.
+ * To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"POST /api/authenticator/storefront/users": {
+searchParams: {
+/**
+ * Defines whether the storefront user should recover their password via an external service (`true`) or define a new password on first login (`false`, default).
+ */
+isLegacyPassword?: boolean
+}
+body: {
+/**
+ * Unique login key (username) for the user. Case-insensitive string (3-70 characters, accepts special characters and whitespace) used for login.
+ */
+identifier: string
+/**
+ * Type of identifier. Only `username` is supported.
+ */
+identifierType: "username"
+}
+response: {
+/**
+ * Unique user identifier (GUID).
+ */
+userId?: string
+}
+}
+/**
+ * Fetches a storefront user by their identifier (username or email). The identifier must be provided as a URL-encoded query parameter.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | VTEX ID | User Management | **View User** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.
+ * To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"GET /api/vtexid/pvt/user/info": {
+searchParams: {
+/**
+ * URL-encoded storefront user identifier (username or email).
+ */
+user: string
+}
+/**
+ * Storefront user information.
+ */
+response: {
+/**
+ * Storefront user unique identifier.
+ */
+userId?: string
+/**
+ * Storefront user email.
+ */
+user?: string
+/**
+ * Storefront user full name.
+ */
+name?: string
+/**
+ * VTEX account ID.
+ */
+accountId?: string
+/**
+ * VTEX VTEX account name.
+ */
+accountName?: string
+}
+}
+/**
+ * Generate a [token](https://developers.vtex.com/vtex-rest-api/docs/getting-started-authentication#user-token) from a given [app key and app token](https://help.vtex.com/en/tutorial/api-keys--2iffYzlvvz4BDMr6WGUtet) pair. You can use this token to authenticate requests to VTEX APIs by sending it as a header named `VtexIdclientAutCookie`. The token's permissions are the same as [defined to the credential pair](https://help.vtex.com/en/tutorial/api-keys--2iffYzlvvz4BDMr6WGUtet#managing-app-key-permissions).
+ * 
+ * 
> Since you are sending the credentials on the request body, there is no need to send authentication headers. 
+ * 
+ * 
> It is also possible to make this request using the `https://api.vtexcommercestable.com.br/api/vtexid/apptoken/login?an={accountName}` route, replacing `{accountName}` with your VTEX account name. This is the only case where you need to use the `an` query parameter.
+ * 
+ * ## Permissions
+ * 
+ * This endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).
+ */
+"POST /api/vtexid/apptoken/login": {
+searchParams: {
+/**
+ * Name of your VTEX account.
+ */
+an?: string
+}
+/**
+ * Credentials object, composed of API key and application token.
+ */
+body: {
+/**
+ * API key.
+ */
+appkey: string
+/**
+ * Application token corresponding to the API key sent with it.
+ */
+apptoken: string
+}
+response: {
+/**
+ * Authentication status.
+ */
+authStatus?: string
+/**
+ * Authentication token.
+ */
+token?: string
+/**
+ * Token expiration Unix timestamp in seconds.
+ */
+expires?: number
+}
+}
+/**
+ * If your store uses a headless frontend, you can authenticate users via OAuth and use this endpoint to exchange the OAuth access token for a VTEX authentication token. This VTEX token can be used to authenticate your frontend requests to VTEX APIs.
+ * 
+ * 
Learn more about how to implement [headless authentication](https://developers.vtex.com/docs/guides/headless-authentication) in your store.
+ * 
+ * ## Permissions
+ * 
+ * This endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).
+ */
+"POST /api/vtexid/audience/webstore/provider/oauth/exchange": {
+body: {
+/**
+ * Name of the [OAuth provider](https://developers.vtex.com/docs/guides/login-integration-guide-webstore-oauth2) set up in your Admin panel.
+ */
+providerId: string
+/**
+ * Access token obtained from your frontend via OAuth integration corresponding with the indicated `providerId`.
+ */
+accessToken: string
+/**
+ * Duration of the token that will be returned, in minutes. The maximum value is `120`. The default is `60` when the duration isn't defined.
+ */
+duration?: number
+}
+response: {
+/**
+ * Authentication token. Use this token to authenticate your requests to VTEX APIs.
+ */
+authToken?: string
+}
+}
+/**
+ * Retrieves information about the user who is currently authenticated in your store, given an user token. If the user is not authenticated, the response for this API will be `401 (Unauthorized)`.
+ * 
+ * ## Permissions
+ * 
+ * This endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).
+ */
+"POST /api/vtexid/credential/validate": {
+searchParams: {
+/**
+ * Name of your VTEX account.
+ */
+an?: string
+}
+/**
+ * Request body object.
+ */
+body: {
+/**
+ * Value of the `VtexIdclientAutCookie`, [user token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.
+ */
+token: string
+}
+response: {
+/**
+ * Authentication status.
+ */
+authStatus?: string
+/**
+ * Unique identifier of the user within VTEX services.
+ */
+id?: string
+/**
+ * User email.
+ */
+user?: string
+/**
+ * VTEX account name.
+ */
+account?: string
+/**
+ * Type of user.
+ */
+audience?: string
+/**
+ * Type of token.
+ */
+tokenType?: string
+}
+}
+/**
+ * Defines if user passwords can be repeated in your store. 
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | VTEX ID | Identity Providers | **Write Identity Providers** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.
+ * To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"POST /api/vtexid/pub/providers/setup/password/webstore/password": {
+body: {
+/**
+ * Defines if password access is active (`true`) or not (`false`).
+ */
+isActive?: boolean
+/**
+ * Defines if passwords can be repeated (`true`) or not (`false`).
+ */
+allowRepeated?: boolean
+}
+}
+/**
+ * Expires an user's password in your store.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | VTEX ID | User Management | **Expire User Password** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.
+ * To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"POST /api/vtexid/password/expire": {
+searchParams: {
+/**
+ * User email.
+ */
+email: string
+}
+}
+/**
+ * Starts the API token renewal process by generating a new token while keeping the current token active. This ensures a smooth transition without service disruption.
+ * 
+ * The previous token and the new token are both valid until the renewal process is completed by making a request to `PATCH` [Complete token renewal](https://developers.vtex.com/docs/api-reference/vtex-id-api#patch-/api/vtexid/apikey/-apiKey-/apitoken/finish-renewal).
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | License Manager | API Key Management | **Renew API Token** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** |
+ * | --------------- | ----------------- |
+ * | User Administrator - RESTRICTED | **Renew API Token** |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).
+ * 
+ * To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).
+ */
+"PATCH /api/vtexid/apikey/:apiKey/apitoken/renew": {
+response: {
+/**
+ * Unique identifier of the API token.
+ */
+id?: string
+/**
+ * Name assigned to the API key.
+ */
+keyName?: string
+/**
+ * ISO 8601 timestamp indicating when the current token was created.
+ */
+creationDateToken?: string
+/**
+ * ISO 8601 timestamp indicating when the new token was generated.
+ */
+creationDateNewToken?: string
+/**
+ * Number of days the token remains valid before expiration.
+ */
+expirationPeriod?: number
+/**
+ * New API token value.
+ */
+newToken?: string
+}
+}
+/**
+ * Finalizes the API token renewal process, deactivating the old token. After this step, the old token can no longer be used, ensuring security by enforcing a controlled rotation.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | License Manager | API Key Management | **Renew API Token** |
+ * 
+ *  You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** |
+ * | --------------- | ----------------- |
+ * | User Administrator - RESTRICTED | **Renew API Token** |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).
+ * 
+ * To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).
+ */
+"PATCH /api/vtexid/apikey/:apiKey/apitoken/finish-renewal": {
+response: {
+/**
+ * Unique identifier of the API token.
+ */
+id?: string
+/**
+ * ISO 8601 timestamp indicating when the current token was created.
+ */
+creationDateToken?: string
+/**
+ * Creation date of the new token. Always `null` after the token creation process is completed.
+ */
+creationDateNewToken?: (null | string)
+}
+}
+/**
+ * Retrieves the unique user ID for a given email address.
+ * 
+ * ## Permissions
+ * 
+ * This endpoint does not require [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). However, it does require a valid user token (`VtexIdclientAutCookie`) to be included in the request headers.
+ * 
+ * To learn more about user authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#user-authentication).
+ */
+"GET /api/vtexid/pvt/user/id": {
+searchParams: {
+/**
+ * URI-encoded user email.
+ */
+usuario: string
+}
+/**
+ * User ID.
+ */
+response: (null | string)
+}
+/**
+ * Starts the authentication flow for a user in your store. This endpoint returns an authentication token valid for 24 hours.
+ * 
+ * ## Permissions
+ * 
+ * This endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).
+ */
+"GET /api/vtexid/pub/authentication/start": {
+searchParams: {
+/**
+ * Account name.
+ */
+scope: string
+/**
+ * Optional device fingerprint for enhanced security. Generated client-side using JavaScript libraries that collect anonymized device and browser parameters to create a unique identifier. When submitted in this request, it must later be provided when making a request to [refresh token](https://developers.vtex.com/docs/api-reference/vtex-id-api#post-/api/vtexid/refreshtoken/webstore).
+ */
+fingerprint?: string
+}
+response: {
+/**
+ * Authentication token provided to the user, valid for 24 hours.
+ */
+authenticationToken?: string
+/**
+ * List of available OAuth providers.
+ */
+oauthProviders?: {
+/**
+ * Name of the OAuth provider.
+ */
+providerName?: string
+/**
+ * Class name associated with the provider.
+ */
+className?: string
+/**
+ * Additional context expected by the provider.
+ */
+expectedContext?: string[]
+}[]
+/**
+ * Indicates whether classic authentication is enabled (`true`) or not (`false`).
+ */
+showClassicAuthentication?: boolean
+/**
+ * Indicates whether access key authentication is enabled (`true`) or not (`false`).
+ */
+showAccessKeyAuthentication?: boolean
+/**
+ * Indicates whether passkey authentication is enabled (`true`) or not (`false`).
+ */
+showPasskeyAuthentication?: boolean
+/**
+ * Authentication cookie if available.
+ */
+authCookie?: (null | string)
+/**
+ * Indicates whether the user is authenticated.
+ */
+isAuthenticated?: boolean
+/**
+ * Currently selected authentication provider, if any.
+ */
+selectedProvider?: (null | string)
+/**
+ * List of available SAML providers.
+ */
+samlProviders?: string[]
+}
+}
+/**
+ * Sends an access key to the user's email address, if the response is empty with 200 OK. The access key is used to authenticate the user in your store.
+ * 
+ * ## Permissions
+ * 
+ * This endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).
+ */
+"POST /api/vtexid/pub/authentication/accesskey/send": {
+searchParams: {
+/**
+ * User email.
+ */
+email: string
+}
+}
+/**
+ * Validates the user session using the access key sent to the user through the [Send access key](https://developers.vtex.com/docs/api-reference/vtex-id-api#post-/api/vtexid/pub/authentication/accesskey/send) endpoint.
+ * 
+ * The refresh token (`vid_rt`) is returned in the `Set-Cookie` header. This token is required for the [Refresh token](https://developers.vtex.com/docs/api-reference/vtex-id-api#post-/api/vtexid/refreshtoken/webstore) request.
+ * 
+ * ## Permissions
+ * 
+ * This endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).
+ */
+"POST /api/vtexid/pub/authentication/accesskey/validate": {
+/**
+ * Validate session response object.
+ */
+response: {
+/**
+ * Authentication status of the user, which can be: 
+ * 
+ * * `Success`: when authentication is completed successfully.
+ * * `InvalidEmail`: When the email informed is not valid.
+ * * `InvalidToken`: When the token is malformed, expired, or has an invalid signature.
+ * * `WrongCredentials`: When the informed credentials are not valid.
+ */
+authStatus?: ("Success" | "InvalidEmail" | "InvalidToken" | "WrongCredentials")
+/**
+ * Indicates whether multi-factor authentication is required.
+ */
+promptMFA?: boolean
+/**
+ * Last authentication attempt available.
+ */
+lastAttemptAvailable?: (null | number)
+/**
+ * Client token.
+ */
+clientToken?: (null | string)
+/**
+ * Authentication cookie.
+ */
+authCookie?: (null | {
+/**
+ * Name of the cookie.
+ */
+Name?: string
+/**
+ * Value of the cookie.
+ */
+Value?: string
+})
+/**
+ * Cookie specific to account authentication.
+ */
+accountAuthCookie?: (null | {
+/**
+ * Name of the cookie.
+ */
+Name?: string
+/**
+ * Value of the cookie.
+ */
+Value?: string
+})
+/**
+ * Time in seconds until authentication expires.
+ */
+expiresIn?: number
+/**
+ * Unique identifier for the authenticated user.
+ */
+userId?: (null | string)
+/**
+ * User's phone number associated with the account.
+ */
+phoneNumber?: (null | string)
+/**
+ * Authentication scope granted.
+ */
+scope?: (null | string)
+}
+}
+/**
+ * Returns a valid refresh token and authentication token (`VtexIdclientAutCookie`) as cookies.
+ * 
+ * ## Permissions
+ * 
+ * This endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).
+ */
+"POST /api/vtexid/refreshtoken/webstore": {
+body: {
+/**
+ * Optional device fingerprint for enhanced security. Generated client-side using JavaScript libraries that collect anonymized device and browser parameters to create a unique identifier. Must remain consistent with the fingerprint provided during [initial authentication](https://developers.vtex.com/docs/api-reference/vtex-id-api#get-/api/vtexid/pub/authentication/start), if previously submitted.
+ */
+fingerprint?: (null | string)
+}
+/**
+ * Refresh token response object.
+ */
+response: {
+/**
+ * Status of the operation. Possible values: 
+ * - `Success`: Token refresh was successful. 
+ * - `InvalidSession`: The session is invalid or expired. 
+ * - `InvalidToken`: The token is invalid. 
+ * - `InvalidEmail`: The email associated with the token is invalid. 
+ * - `InvalidScope`: The scope is invalid.
+ */
+status?: ("Success" | "InvalidSession" | "InvalidToken" | "InvalidEmail" | "InvalidScope")
+/**
+ * Unique identifier assigned to the authenticated user.
+ */
+userId?: string
+/**
+ * The timestamp indicating when the session should be refreshed, in ISO 8601 format (`YYYY-MM-DDTHH:mm:ss±HH:MM`).
+ */
+refreshAfter?: string
+}
+}
+}
diff --git a/vtex/utils/openapi/vtexid.openapi.json b/vtex/utils/openapi/vtexid.openapi.json
new file mode 100644
index 000000000..a3dc465a0
--- /dev/null
+++ b/vtex/utils/openapi/vtexid.openapi.json
@@ -0,0 +1,2088 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "VTEX ID",
+    "description": "VTEX ID API provides endpoints to manage user authentication in your VTEX store. Check the [Authentication](https://developers.vtex.com/docs/guides/authentication) guide for more information.\r\n\r\n## Index\r\n\r\n### Storefront users\r\n\r\n- `POST` [Create storefront user with username](https://developers.vtex.com/docs/api-reference/vtex-id-api#post-/api/authenticator/storefront/users): Registers a new storefront user in VTEX ID using a unique login key (username).\r\n- `GET` [Get storefront user by identifier](https://developers.vtex.com/docs/api-reference/vtex-id-api#get-/api/vtexid/pvt/user/info): Fetches a storefront user by their identifier (username or email).\r\n\r\n### Authentication\r\n\r\n- `POST` [Generate authentication token](https://developers.vtex.com/docs/api-reference/vtex-id-api#post-/api/vtexid/apptoken/login)\r\n- `POST` [Check authenticated user](https://developers.vtex.com/docs/api-reference/vtex-id-api#post-/api/vtexid/credential/validate)\r\n- `POST` [Enable or disable repeated passwords](https://developers.vtex.com/docs/api-reference/vtex-id-api#get-/api/vtexid/pub/providers/setup/password/webstore/password)\r\n- `POST` [Expire user password](https://developers.vtex.com/docs/api-reference/vtex-id-api#post-/api/vtexid/password/expire)\r\n- `GET` [Get user ID by email](https://developers.vtex.com/docs/api-reference/vtex-id-api#get-/api/vtexid/pvt/user/id) \r\n\r\n### Token renewal\r\n- `PATCH` [Initiate token renewal](https://developers.vtex.com/docs/api-reference/vtex-id-api#patch-/api/vtexid/apikey/-apiKey-/apitoken/renew)\r\n- `PATCH` [Complete token renewal](https://developers.vtex.com/docs/api-reference/vtex-id-api#patch-/api/vtexid/apikey/-apiKey-/apitoken/finish-renewal)\r\n\r\n### Refresh token (Headless)\r\n- `GET` [Start authentication](https://developers.vtex.com/docs/api-reference/vtex-id-api#get-/api/vtexid/pub/authentication/start)\r\n- `POST` [Send access key](https://developers.vtex.com/docs/api-reference/vtex-id-api#post-/api/vtexid/pub/authentication/accesskey/send)\r\n- `POST` [Validate session](https://developers.vtex.com/docs/api-reference/vtex-id-api#post-/api/vtexid/pub/authentication/accesskey/validate)\r\n- `POST` [Refresh token](https://developers.vtex.com/docs/api-reference/vtex-id-api#post-/api/vtexid/refreshtoken/webstore)",
+    "version": "1.0"
+  },
+  "servers": [
+    {
+      "url": "https://{accountName}.{environment}.com.br",
+      "description": "VTEX server URL.",
+      "variables": {
+        "accountName": {
+          "description": "Name of the VTEX account. Used as part of the URL.",
+          "default": "apiexamples"
+        },
+        "environment": {
+          "description": "Environment to use. Used as part of the URL.",
+          "enum": [
+            "vtexcommercestable"
+          ],
+          "default": "vtexcommercestable"
+        }
+      }
+    },
+    {
+      "url": "https://{accountName}.{environment}.com",
+      "description": "VTEX server URL.",
+      "variables": {
+        "accountName": {
+          "description": "Name of the VTEX account. Used as part of the URL.",
+          "default": "apiexamples"
+        },
+        "environment": {
+          "description": "Environment to use. Used as part of the URL.",
+          "enum": [
+            "myvtex"
+          ],
+          "default": "myvtex"
+        }
+      }
+    },
+    {
+      "url": "https://{storeDomain}",
+      "description": "Store domain.",
+      "variables": {
+        "storeDomain": {
+          "description": "Store domain.",
+          "default": "apiexamples.com"
+        }
+      }
+    }
+  ],
+  "paths": {
+    "/api/authenticator/storefront/users": {
+      "post": {
+        "tags": [
+          "Storefront users"
+        ],
+        "summary": "Create storefront user with username",
+        "description": "Registers a new storefront user in VTEX ID using a unique login key (username) as `identifier`.\n\n The created user is not linked to any Organization Unit and does not have storefront permissions.\n\nOnce a storefront user is added, it cannot be edited or removed. If incorrect data is uploaded, create a new username.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| VTEX ID | User Management | **Create User** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "isLegacyPassword",
+            "in": "query",
+            "description": "Defines whether the storefront user should recover their password via an external service (`true`) or define a new password on first login (`false`, default).",
+            "required": false,
+            "schema": {
+              "type": "boolean",
+              "default": false
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "required": [
+                  "identifier",
+                  "identifierType"
+                ],
+                "properties": {
+                  "identifier": {
+                    "type": "string",
+                    "description": "Unique login key (username) for the user. Case-insensitive string (3-70 characters, accepts special characters and whitespace) used for login."
+                  },
+                  "identifierType": {
+                    "type": "string",
+                    "enum": [
+                      "username"
+                    ],
+                    "description": "Type of identifier. Only `username` is supported."
+                  }
+                },
+                "example": {
+                  "identifier": "john.doe_2025",
+                  "identifierType": "username"
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "201": {
+            "description": "User created successfully.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "userId": {
+                      "type": "string",
+                      "description": "Unique user identifier (GUID).",
+                      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
+                    }
+                  }
+                },
+                "example": {
+                  "userId": "f0a15a42-f7fc-4b09-a9ab-fabc76d9f332",
+                  "identifier": "john.doe_2025"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad Request - Invalid request or identifier type.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "error": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized - Invalid access token."
+          },
+          "403": {
+            "description": "Forbidden - Insufficient permissions."
+          },
+          "409": {
+            "description": "Conflict - User already exists.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "error": {
+                      "type": "string",
+                      "description": "Error message.",
+                      "example": "User already exists"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "security": [
+          {
+            "appKey": [],
+            "appToken": []
+          }
+        ]
+      }
+    },
+    "/api/vtexid/pvt/user/info": {
+      "get": {
+        "tags": [
+          "Storefront users"
+        ],
+        "summary": "Get storefront user by identifier",
+        "description": "Fetches a storefront user by their identifier (username or email). The identifier must be provided as a URL-encoded query parameter.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| VTEX ID | User Management | **View User** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "parameters": [
+          {
+            "name": "user",
+            "in": "query",
+            "description": "URL-encoded storefront user identifier (username or email).",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "example": "john.doe_2025"
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK - User found.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "description": "Storefront user information.",
+                  "properties": {
+                    "userId": {
+                      "type": "string",
+                      "description": "Storefront user unique identifier."
+                    },
+                    "user": {
+                      "type": "string",
+                      "description": "Storefront user email."
+                    },
+                    "name": {
+                      "type": "string",
+                      "description": "Storefront user full name."
+                    },
+                    "accountId": {
+                      "type": "string",
+                      "description": "VTEX account ID."
+                    },
+                    "accountName": {
+                      "type": "string",
+                      "description": "VTEX VTEX account name."
+                    }
+                  }
+                },
+                "example": {
+                  "userId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
+                  "user": "john.doe@example.com",
+                  "name": "John Doe",
+                  "accountId": "12345",
+                  "accountName": "mystore"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized - Not authenticated."
+          }
+        },
+        "security": [
+          {
+            "appKey": [],
+            "appToken": []
+          }
+        ]
+      }
+    },
+    "/api/vtexid/apptoken/login": {
+      "servers": [
+        {
+          "url": "https://{accountName}.{environment}.com.br",
+          "description": "VTEX server URL.",
+          "variables": {
+            "accountName": {
+              "description": "Name of the VTEX account. Used as part of the URL.",
+              "default": "apiexamples"
+            },
+            "environment": {
+              "description": "Environment to use. Used as part of the URL.",
+              "enum": [
+                "vtexcommercestable"
+              ],
+              "default": "vtexcommercestable"
+            }
+          }
+        }
+      ],
+      "post": {
+        "tags": [
+          "Authentication"
+        ],
+        "summary": "Generate authentication token",
+        "description": "Generate a [token](https://developers.vtex.com/vtex-rest-api/docs/getting-started-authentication#user-token) from a given [app key and app token](https://help.vtex.com/en/tutorial/api-keys--2iffYzlvvz4BDMr6WGUtet) pair. You can use this token to authenticate requests to VTEX APIs by sending it as a header named `VtexIdclientAutCookie`. The token's permissions are the same as [defined to the credential pair](https://help.vtex.com/en/tutorial/api-keys--2iffYzlvvz4BDMr6WGUtet#managing-app-key-permissions).\n\r\n\r> Since you are sending the credentials on the request body, there is no need to send authentication headers. \n\r\n\r> It is also possible to make this request using the `https://api.vtexcommercestable.com.br/api/vtexid/apptoken/login?an={accountName}` route, replacing `{accountName}` with your VTEX account name. This is the only case where you need to use the `an` query parameter.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "an",
+            "in": "query",
+            "description": "Name of your VTEX account.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "string",
+              "example": "exampleAccount"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "description": "Credentials object, composed of API key and application token.",
+                "required": [
+                  "appkey",
+                  "apptoken"
+                ],
+                "properties": {
+                  "appkey": {
+                    "type": "string",
+                    "description": "API key.",
+                    "example": "vtexappkey-example-YSWQFZ"
+                  },
+                  "apptoken": {
+                    "type": "string",
+                    "description": "Application token corresponding to the API key sent with it.",
+                    "example": "eyJhbGciOiJFUzI1NiIsImtpZCI6IjA1MTZFN0IwMDNFODMxRTg0QkFDOTg2NzBCNUM2QTRERTlBN0RFNkUiLCJ0eXAiOiJqd3QifQ.eyJzdWIiOiJwZWRyby5jb3N0YUB2dGV4LmNvbS5iciIsImFjY291bnQiOiJhcHBsaWFuY2V0aGVtZSIsImF1ZGllbmNlIjoiYWRtaW4iLCJzZXNzIjoiZjU3YjMyMGItMWE3YS00YzlkLWJkNDMtZTE4NDdhYmE1MTE1IiwiZXhwIjoxNjE2NzY3Mjc4LCJ1c2VySWQiOiJmYjU0MmU1MS01NDg4LTRjMzQtOGQxNy1lZDhmY2Y1OTdhOTQiLCJpYXQiOjE2MwerY2ODA4NzgsImlzcyI6InRva2VuLWVtaXR0ZXIiLCJqdGkiOiJmYTI0YWJiOC03Y2E5LTQ3NjUtYmYzNC1kMmvU5YTgzYjYxZmUifQ.23rn-2dEdAAYXJX2exrxDEdbieyKWsVKABeSUNeFWyhz7xRd7d5EcxwiMLjM3bRaBOKrAA9Op7ocn89c45qQ"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "authStatus": {
+                      "type": "string",
+                      "description": "Authentication status."
+                    },
+                    "token": {
+                      "type": "string",
+                      "description": "Authentication token."
+                    },
+                    "expires": {
+                      "type": "integer",
+                      "description": "Token expiration Unix timestamp in seconds."
+                    }
+                  }
+                },
+                "example": {
+                  "authStatus": "Success",
+                  "token": "eyJhbGciOiJFUzI1NiIsImtpZCI6IjFBRjI5MUUwRDY0MERENTlEQTkzRTg0REMxNjQyNjA3ODZEQjY3ODAiLCJ0eXAiOiJqd3QifQ.eyJzdWIiOiJ2dGV4YXBwa2V5LXZ0ZXhoZWxwLVdWQ0FCVCIsImFjY291bnQiOiJwerV4aGVscCIsImF1ZGllbmNlIjoiYWRtaW4iLCJleHAiOjE2Njk3NzA3MzcsInVzZXJJZCI6IjM5MjNhMmUy5khmMTctNGNiYy04YzU3LWQ3OGFkNmUxYTU2NiIsImlhdCI6MTY2OTc0OTEzNywiaXNzIjoidG9rZW4tZW1HgoRlciIsImp0aSI6IjNiNjAxODA2LTExMzEtNDcwYS05MWJjLTVhM2JhOThiYWQyNiJ9.Q7N8MFa1FMJsQUpxBY29oije4aa-Jf29wgLFLl6LUY3Wei3MRUVUMRQWkey6Kug8iFPonZ1L-PaFmwfzSz3TCQ",
+                  "expires": 1669770737
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/vtexid/audience/webstore/provider/oauth/exchange": {
+      "servers": [
+        {
+          "url": "https://{accountName}.{environment}.com.br",
+          "description": "VTEX server URL.",
+          "variables": {
+            "accountName": {
+              "description": "Name of the VTEX account. Used as part of the URL.",
+              "default": "apiexamples"
+            },
+            "environment": {
+              "description": "Environment to use. Used as part of the URL.",
+              "enum": [
+                "vtexcommercestable"
+              ],
+              "default": "vtexcommercestable"
+            }
+          }
+        }
+      ],
+      "post": {
+        "tags": [
+          "Authentication"
+        ],
+        "summary": "Exchange OAuth access token for VTEX credential",
+        "description": "If your store uses a headless frontend, you can authenticate users via OAuth and use this endpoint to exchange the OAuth access token for a VTEX authentication token. This VTEX token can be used to authenticate your frontend requests to VTEX APIs.\n\r\n\rLearn more about how to implement [headless authentication](https://developers.vtex.com/docs/guides/headless-authentication) in your store.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "accountName",
+            "in": "path",
+            "required": true,
+            "description": "Name of your VTEX account.",
+            "schema": {
+              "type": "string",
+              "example": "apiexamples"
+            }
+          },
+          {
+            "name": "environment",
+            "in": "path",
+            "required": true,
+            "description": "Environment to be used in the request.",
+            "schema": {
+              "type": "string",
+              "default": "vtexcommercestable"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "required": [
+                  "providerId",
+                  "accessToken"
+                ],
+                "properties": {
+                  "providerId": {
+                    "type": "string",
+                    "description": "Name of the [OAuth provider](https://developers.vtex.com/docs/guides/login-integration-guide-webstore-oauth2) set up in your Admin panel.",
+                    "example": "custom-oauth-provider"
+                  },
+                  "accessToken": {
+                    "type": "string",
+                    "description": "Access token obtained from your frontend via OAuth integration corresponding with the indicated `providerId`.",
+                    "example": "dsfDShdgfhDFI1NiIsIrtyZCI6IjFBRjI5MUUwRDY0MERENTlEQTkzRTg0REMxNjQyNjA3ODZEQjY3ODAiLCJ0eXAiOiJqd3QifQ.eyJzdWIiOiJ2dGV4YXBwa2V5LXZ0ZXhoZWxwLVdWQ0FCVCIsImFjY291bdg465DATU4GVscCIsImF1MBllbmNlIjoiYWRtaW4iLCJleHAiOjE2Njk3NzA3MzcsInVzZXJJZCI6IjM5MjNhMmUy5khmMTctNGNiYy04YzU3LWQ3OGFkNmUxYTU2NiIsImlhdCI6MTY2OTc0OTEzNywiaXNzIjoidG9rZW4tZW1HgoRlciIsImp0aSI6IjNiNjAxODA2LTExMzEtNDcwYS05MWJjLTVhM2JhOThiYWQyNiJ9.Q7N8MFa1FMJsQUpxBY29oije4aa-654fgjLFLl6LUY3Wei3MRUVUMRQWkey6Kug8iFPonZ1L-PaFmwfzSz3TCQ"
+                  },
+                  "duration": {
+                    "type": "integer",
+                    "description": "Duration of the token that will be returned, in minutes. The maximum value is `120`. The default is `60` when the duration isn't defined.",
+                    "example": 90,
+                    "default": 60
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "200 - OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "authToken": {
+                      "type": "string",
+                      "description": "Authentication token. Use this token to authenticate your requests to VTEX APIs."
+                    }
+                  }
+                },
+                "example": {
+                  "authToken": "eyJhbGciOiJFUzI1NiIsIrtyZCI6IjFBRjI5MUUwRDY0MERENTlEQTkzRTg0REMxNjQyNjA3ODZEQjY3ODAiLCJ0eXAiOiJqd3QifQ.eyJzdWIiOiJ2dGV4YXBwa2V5LXZ0ZXhoZWxwLVdWQ0FCVCIsImFjY291bnQiOiJwerV4aGVscCIsImF1MBllbmNlIjoiYWRtaW4iLCJleHAiOjE2Njk3NzA3MzcsInVzZXJJZCI6IjM5MjNhMmUy5khmMTctNGNiYy04YzU3LWQ3OGFkNmUxYTU2NiIsImlhdCI6MTY2OTc0OTEzNywiaXNzIjoidG9rZW4tZW1HgoRlciIsImp0aSI6IjNiNjAxODA2LTExMzEtNDcwYS05MWJjLTVhM2JhOThiYWQyNiJ9.Q7N8MFa1FMJsQUpxBY29oije4aa-Jf463lwgLFLl6LUY3Wei3MRUVUMRQWkey6Kug8iFPonZ1L-PaFmwfzSz3TCQ"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/vtexid/credential/validate": {
+      "servers": [
+        {
+          "url": "https://{accountName}.{environment}.com.br",
+          "description": "VTEX server URL.",
+          "variables": {
+            "accountName": {
+              "description": "Name of the VTEX account. Used as part of the URL.",
+              "default": "apiexamples"
+            },
+            "environment": {
+              "description": "Environment to use. Used as part of the URL.",
+              "enum": [
+                "vtexcommercestable"
+              ],
+              "default": "vtexcommercestable"
+            }
+          }
+        }
+      ],
+      "post": {
+        "tags": [
+          "Authentication"
+        ],
+        "summary": "Check authenticated user",
+        "description": "Retrieves information about the user who is currently authenticated in your store, given an user token. If the user is not authenticated, the response for this API will be `401 (Unauthorized)`.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "an",
+            "in": "query",
+            "description": "Name of your VTEX account.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "string",
+              "example": "exampleAccount"
+            }
+          },
+          {
+            "name": "environment",
+            "in": "path",
+            "required": true,
+            "description": "Environment to be used in the request.",
+            "schema": {
+              "type": "string",
+              "default": "vtexcommercestable"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "description": "Request body object.",
+                "required": [
+                  "token"
+                ],
+                "properties": {
+                  "token": {
+                    "description": "Value of the `VtexIdclientAutCookie`, [user token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.",
+                    "type": "string",
+                    "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "authStatus": {
+                      "type": "string",
+                      "description": "Authentication status."
+                    },
+                    "id": {
+                      "type": "string",
+                      "description": "Unique identifier of the user within VTEX services."
+                    },
+                    "user": {
+                      "type": "string",
+                      "description": "User email."
+                    },
+                    "account": {
+                      "type": "string",
+                      "description": "VTEX account name."
+                    },
+                    "audience": {
+                      "type": "string",
+                      "description": "Type of user."
+                    },
+                    "tokenType": {
+                      "type": "string",
+                      "description": "Type of token."
+                    }
+                  }
+                },
+                "example": {
+                  "authStatus": "Success",
+                  "id": "1f6c17e5-06f9-44a9-a459-b3686e03fa9d",
+                  "user": "john@mail.com",
+                  "account": "apiexamples",
+                  "audience": "admin",
+                  "tokenType": "user"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "description": "Response body object.",
+                  "properties": {
+                    "authStatus": {
+                      "type": "string",
+                      "description": "Authentication status."
+                    }
+                  }
+                },
+                "example": {
+                  "authStatus": "WrongCredentials"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/api/vtexid/pub/providers/setup/password/webstore/password": {
+      "servers": [
+        {
+          "url": "https://{accountName}.{environment}.com.br",
+          "description": "VTEX server URL.",
+          "variables": {
+            "accountName": {
+              "description": "Name of the VTEX account. Used as part of the URL.",
+              "default": "apiexamples"
+            },
+            "environment": {
+              "description": "Environment to use. Used as part of the URL.",
+              "enum": [
+                "vtexcommercestable"
+              ],
+              "default": "vtexcommercestable"
+            }
+          }
+        }
+      ],
+      "post": {
+        "tags": [
+          "Authentication"
+        ],
+        "summary": "Enable or disable repeated passwords",
+        "description": "Defines if user passwords can be repeated in your store. \r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| VTEX ID | Identity Providers | **Write Identity Providers** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "accountName",
+            "in": "path",
+            "required": true,
+            "description": "Name of your VTEX account.",
+            "schema": {
+              "type": "string",
+              "example": "apiexamples"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "isActive": {
+                    "type": "boolean",
+                    "description": "Defines if password access is active (`true`) or not (`false`).",
+                    "example": true
+                  },
+                  "allowRepeated": {
+                    "type": "boolean",
+                    "description": "Defines if passwords can be repeated (`true`) or not (`false`).",
+                    "example": false
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    },
+    "/api/vtexid/password/expire": {
+      "servers": [
+        {
+          "url": "https://{accountName}.{environment}.com.br",
+          "description": "VTEX server URL.",
+          "variables": {
+            "accountName": {
+              "description": "Name of the VTEX account. Used as part of the URL.",
+              "default": "apiexamples"
+            },
+            "environment": {
+              "description": "Environment to use. Used as part of the URL.",
+              "enum": [
+                "vtexcommercestable"
+              ],
+              "default": "vtexcommercestable"
+            }
+          }
+        }
+      ],
+      "post": {
+        "tags": [
+          "Authentication"
+        ],
+        "summary": "Expire user password",
+        "description": "Expires an user's password in your store.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| VTEX ID | User Management | **Expire User Password** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "accountName",
+            "in": "path",
+            "required": true,
+            "description": "Name of your VTEX account.",
+            "schema": {
+              "type": "string",
+              "example": "apiexamples"
+            }
+          },
+          {
+            "name": "environment",
+            "in": "path",
+            "required": true,
+            "description": "Environment to be used in the request.",
+            "schema": {
+              "type": "string",
+              "default": "vtexcommercestable"
+            }
+          },
+          {
+            "name": "email",
+            "in": "query",
+            "description": "User email.",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "example": "email@email.com"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          }
+        }
+      }
+    },
+    "/api/vtexid/apikey/{apiKey}/apitoken/renew": {
+      "servers": [
+        {
+          "url": "https://{accountName}.{environment}.com.br",
+          "description": "VTEX server URL.",
+          "variables": {
+            "accountName": {
+              "description": "Name of the VTEX account. Used as part of the URL.",
+              "default": "apiexamples"
+            },
+            "environment": {
+              "description": "Environment to use. Used as part of the URL.",
+              "enum": [
+                "vtexcommercestable"
+              ],
+              "default": "vtexcommercestable"
+            }
+          }
+        }
+      ],
+      "patch": {
+        "tags": [
+          "Token renewal"
+        ],
+        "summary": "Initiate token renewal",
+        "description": "Starts the API token renewal process by generating a new token while keeping the current token active. This ensures a smooth transition without service disruption.\r\n\r\nThe previous token and the new token are both valid until the renewal process is completed by making a request to `PATCH` [Complete token renewal](https://developers.vtex.com/docs/api-reference/vtex-id-api#patch-/api/vtexid/apikey/-apiKey-/apitoken/finish-renewal).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | API Key Management | **Renew API Token** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** |\r\n| --------------- | ----------------- |\r\n| User Administrator - RESTRICTED | **Renew API Token** |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).",
+        "parameters": [
+          {
+            "name": "apiKey",
+            "in": "path",
+            "description": "API Key name.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "type": "string",
+                      "description": "Unique identifier of the API token."
+                    },
+                    "keyName": {
+                      "type": "string",
+                      "description": "Name assigned to the API key."
+                    },
+                    "creationDateToken": {
+                      "type": "string",
+                      "description": "ISO 8601 timestamp indicating when the current token was created."
+                    },
+                    "creationDateNewToken": {
+                      "type": "string",
+                      "description": "ISO 8601 timestamp indicating when the new token was generated."
+                    },
+                    "expirationPeriod": {
+                      "type": "number",
+                      "description": "Number of days the token remains valid before expiration."
+                    },
+                    "newToken": {
+                      "type": "string",
+                      "description": "New API token value."
+                    }
+                  }
+                },
+                "example": {
+                  "id": "1f6c17e5-06f9-44a9-a459-b3686e03fa9d",
+                  "keyName": "my-api-key",
+                  "creationDateToken": "2025-02-18T12:00:00Z",
+                  "creationDateNewToken": "2025-02-25T12:00:00Z",
+                  "expirationPeriod": 30,
+                  "newToken": "abc123xyz789"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid API key or API key not owned by tenant"
+          },
+          "409": {
+            "description": "Conflict - Already has a renewed token pending"
+          },
+          "500": {
+            "description": "Unknown server error"
+          }
+        }
+      }
+    },
+    "/api/vtexid/apikey/{apiKey}/apitoken/finish-renewal": {
+      "servers": [
+        {
+          "url": "https://{accountName}.{environment}.com.br",
+          "description": "VTEX server URL.",
+          "variables": {
+            "accountName": {
+              "description": "Name of the VTEX account. Used as part of the URL.",
+              "default": "apiexamples"
+            },
+            "environment": {
+              "description": "Environment to use. Used as part of the URL.",
+              "enum": [
+                "vtexcommercestable"
+              ],
+              "default": "vtexcommercestable"
+            }
+          }
+        }
+      ],
+      "patch": {
+        "tags": [
+          "Token renewal"
+        ],
+        "summary": "Complete token renewal",
+        "description": "Finalizes the API token renewal process, deactivating the old token. After this step, the old token can no longer be used, ensuring security by enforcing a controlled rotation.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/authentication-overview#api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | API Key Management | **Renew API Token** |\r\n\r\n You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** |\r\n| --------------- | ----------------- |\r\n| User Administrator - RESTRICTED | **Renew API Token** |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#machine-authentication).",
+        "parameters": [
+          {
+            "name": "apiKey",
+            "in": "path",
+            "description": "API Key name.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "type": "string",
+                      "description": "Unique identifier of the API token."
+                    },
+                    "creationDateToken": {
+                      "type": "string",
+                      "description": "ISO 8601 timestamp indicating when the current token was created."
+                    },
+                    "creationDateNewToken": {
+                      "type": "string",
+                      "nullable": true,
+                      "description": "Creation date of the new token. Always `null` after the token creation process is completed."
+                    }
+                  }
+                },
+                "example": {
+                  "id": "1f6c17e5-06f9-44a9-a459-b3686e03fa9d",
+                  "creationDateToken": "2025-02-18T15:30:00Z",
+                  "creationDateNewToken": null
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Invalid API key or API key not owned by tenant"
+          },
+          "404": {
+            "description": "No renewed API token was found"
+          },
+          "500": {
+            "description": "Unknown server error"
+          }
+        }
+      }
+    },
+    "/api/vtexid/pvt/user/id": {
+      "get": {
+        "tags": [
+          "Authentication"
+        ],
+        "summary": "Get user ID by email",
+        "description": "Retrieves the unique user ID for a given email address.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). However, it does require a valid user token (`VtexIdclientAutCookie`) to be included in the request headers.\r\n\r\nTo learn more about user authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication-overview#user-authentication).",
+        "parameters": [
+          {
+            "name": "usuario",
+            "in": "query",
+            "description": "User email address.",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "description": "URI-encoded user email.",
+              "example": "john%40mail.com"
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "string",
+                  "description": "User ID.",
+                  "example": "1f6c17e5-06f9-44a9-a459-b3686e03fa9d",
+                  "nullable": true
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized. Invalid or missing VtexIdclientAutCookie."
+          }
+        },
+        "security": [
+          {
+            "VtexIdclientAutCookie": []
+          }
+        ]
+      }
+    },
+    "/api/vtexid/pub/authentication/start": {
+      "servers": [
+        {
+          "url": "https://{storeDomain}",
+          "description": "Store domain.",
+          "variables": {
+            "storeDomain": {
+              "description": "Store domain.",
+              "default": "apiexamples.com"
+            }
+          }
+        },
+        {
+          "url": "https://{accountName}.{environment}.com",
+          "description": "VTEX server URL.",
+          "variables": {
+            "accountName": {
+              "description": "Name of the VTEX account. Used as part of the URL.",
+              "default": "apiexamples"
+            },
+            "environment": {
+              "description": "Environment to use. Used as part of the URL.",
+              "enum": [
+                "myvtex"
+              ],
+              "default": "myvtex"
+            }
+          }
+        }
+      ],
+      "get": {
+        "tags": [
+          "Refresh token (Headless)"
+        ],
+        "summary": "Start authentication",
+        "description": "Starts the authentication flow for a user in your store. This endpoint returns an authentication token valid for 24 hours.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "scope",
+            "in": "query",
+            "description": "Account name.",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "example": "accountName"
+            }
+          },
+          {
+            "name": "fingerprint",
+            "in": "query",
+            "description": "Optional device fingerprint for enhanced security. Generated client-side using JavaScript libraries that collect anonymized device and browser parameters to create a unique identifier. When submitted in this request, it must later be provided when making a request to [refresh token](https://developers.vtex.com/docs/api-reference/vtex-id-api#post-/api/vtexid/refreshtoken/webstore).",
+            "required": false,
+            "schema": {
+              "type": "string",
+              "example": "12345"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "authenticationToken": {
+                      "type": "string",
+                      "description": "Authentication token provided to the user, valid for 24 hours."
+                    },
+                    "oauthProviders": {
+                      "type": "array",
+                      "description": "List of available OAuth providers.",
+                      "items": {
+                        "type": "object",
+                        "description": "OAuth provider information.",
+                        "properties": {
+                          "providerName": {
+                            "type": "string",
+                            "description": "Name of the OAuth provider."
+                          },
+                          "className": {
+                            "type": "string",
+                            "description": "Class name associated with the provider."
+                          },
+                          "expectedContext": {
+                            "type": "array",
+                            "description": "Additional context expected by the provider.",
+                            "items": {
+                              "type": "string",
+                              "description": "Additional context."
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "showClassicAuthentication": {
+                      "type": "boolean",
+                      "description": "Indicates whether classic authentication is enabled (`true`) or not (`false`)."
+                    },
+                    "showAccessKeyAuthentication": {
+                      "type": "boolean",
+                      "description": "Indicates whether access key authentication is enabled (`true`) or not (`false`)."
+                    },
+                    "showPasskeyAuthentication": {
+                      "type": "boolean",
+                      "description": "Indicates whether passkey authentication is enabled (`true`) or not (`false`)."
+                    },
+                    "authCookie": {
+                      "type": "string",
+                      "description": "Authentication cookie if available.",
+                      "nullable": true
+                    },
+                    "isAuthenticated": {
+                      "type": "boolean",
+                      "description": "Indicates whether the user is authenticated."
+                    },
+                    "selectedProvider": {
+                      "type": "string",
+                      "description": "Currently selected authentication provider, if any.",
+                      "nullable": true
+                    },
+                    "samlProviders": {
+                      "type": "array",
+                      "description": "List of available SAML providers.",
+                      "items": {
+                        "type": "string",
+                        "description": "SAML provider."
+                      }
+                    }
+                  }
+                },
+                "example": {
+                  "authenticationToken": "C17BCD635B637E66BF2BBE07CEED0B1B7425387FB8D6E42FE68EBCE7A49193F2",
+                  "oauthProviders": [
+                    {
+                      "providerName": "Google",
+                      "className": "google-plus",
+                      "expectedContext": []
+                    },
+                    {
+                      "providerName": "Facebook",
+                      "className": "facebook",
+                      "expectedContext": []
+                    }
+                  ],
+                  "showClassicAuthentication": true,
+                  "showAccessKeyAuthentication": true,
+                  "showPasskeyAuthentication": false,
+                  "authCookie": null,
+                  "isAuthenticated": false,
+                  "selectedProvider": null,
+                  "samlProviders": []
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/vtexid/pub/authentication/accesskey/send": {
+      "servers": [
+        {
+          "url": "https://{storeDomain}",
+          "description": "Store domain.",
+          "variables": {
+            "storeDomain": {
+              "description": "Store domain.",
+              "default": "apiexamples.com"
+            }
+          }
+        },
+        {
+          "url": "https://{accountName}.{environment}.com",
+          "description": "VTEX server URL.",
+          "variables": {
+            "accountName": {
+              "description": "Name of the VTEX account. Used as part of the URL.",
+              "default": "apiexamples"
+            },
+            "environment": {
+              "description": "Environment to use. Used as part of the URL.",
+              "enum": [
+                "myvtex"
+              ],
+              "default": "myvtex"
+            }
+          }
+        }
+      ],
+      "post": {
+        "tags": [
+          "Refresh token (Headless)"
+        ],
+        "summary": "Send access key",
+        "description": "Sends an access key to the user's email address, if the response is empty with 200 OK. The access key is used to authenticate the user in your store.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "email",
+            "in": "query",
+            "description": "User email.",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "example": "jane@mail.com"
+            }
+          },
+          {
+            "name": "_vss",
+            "in": "cookie",
+            "description": "Authentication token obtained in the [Start authentication](https://developers.vtex.com/docs/api-reference/vtex-id-api#get-/api/vtexid/pub/authentication/start) request.",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "example": "C17BCD635B637E66BF2BBE07CEED0B1B7425387FB8D6E42FE68EBCE7A49193F2"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          },
+          "400": {
+            "description": "Bad request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "authStatus": {
+                      "type": "string",
+                      "description": "Error message, which can be `InvalidEmail` (when the email informed is not valid) or `InvalidToken` (when the token is malformed, expired, or has an invalid signature)."
+                    }
+                  }
+                },
+                "example": {
+                  "authStatus": "InvalidEmail"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/vtexid/pub/authentication/accesskey/validate": {
+      "servers": [
+        {
+          "url": "https://{storeDomain}",
+          "description": "Store domain.",
+          "variables": {
+            "storeDomain": {
+              "description": "Store domain.",
+              "default": "apiexamples.com"
+            }
+          }
+        },
+        {
+          "url": "https://{accountName}.{environment}.com",
+          "description": "VTEX server URL.",
+          "variables": {
+            "accountName": {
+              "description": "Name of the VTEX account. Used as part of the URL.",
+              "default": "apiexamples"
+            },
+            "environment": {
+              "description": "Environment to use. Used as part of the URL.",
+              "enum": [
+                "myvtex"
+              ],
+              "default": "myvtex"
+            }
+          }
+        }
+      ],
+      "post": {
+        "tags": [
+          "Refresh token (Headless)"
+        ],
+        "summary": "Validate session",
+        "description": "Validates the user session using the access key sent to the user through the [Send access key](https://developers.vtex.com/docs/api-reference/vtex-id-api#post-/api/vtexid/pub/authentication/accesskey/send) endpoint.\r\n\r\nThe refresh token (`vid_rt`) is returned in the `Set-Cookie` header. This token is required for the [Refresh token](https://developers.vtex.com/docs/api-reference/vtex-id-api#post-/api/vtexid/refreshtoken/webstore) request.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "_vss",
+            "in": "cookie",
+            "description": "Authentication token obtained in the [Start authentication](https://developers.vtex.com/docs/api-reference/vtex-id-api#get-/api/vtexid/pub/authentication/start) request.",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "example": "C17BCD635B637E66BF2BBE07CEED0B1B7425387FB8D6E42FE68EBCE7A49193F2"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "multipart/form-data": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "accessKey": {
+                    "type": "string",
+                    "description": "Access key sent to the user through the [Send access key](https://developers.vtex.com/docs/api-reference/vtex-id-api#post-/api/vtexid/pub/authentication/accesskey/send) endpoint."
+                  },
+                  "login": {
+                    "type": "string",
+                    "description": "User email."
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "headers": {
+              "Set-Cookie": {
+                "description": "Refresh token.",
+                "schema": {
+                  "type": "string",
+                  "example": "vid_rt=QiEOQKuzdRjukvSnsn7F8h1wwkrqq8wWlkk7bXA5LSbTHkbKbYEfDJ7MGb6_pllGWd1VQ-JxQI7UDLvYrCUH9o7i1rOSeSG8zJewZw; expires=Thu, 27 Mar 2025 10:22:49 GMT; domain=apiexamples.myvtex.com; path=/api/vtexid/refreshtoken/webstore; secure; samesite=strict; httponly"
+                }
+              }
+            },
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "description": "Validate session response object.",
+                  "properties": {
+                    "authStatus": {
+                      "type": "string",
+                      "description": "Authentication status of the user, which can be: \n\n* `Success`: when authentication is completed successfully.\n* `InvalidEmail`: When the email informed is not valid.\n* `InvalidToken`: When the token is malformed, expired, or has an invalid signature.\n* `WrongCredentials`: When the informed credentials are not valid.",
+                      "enum": [
+                        "Success",
+                        "InvalidEmail",
+                        "InvalidToken",
+                        "WrongCredentials"
+                      ]
+                    },
+                    "promptMFA": {
+                      "type": "boolean",
+                      "description": "Indicates whether multi-factor authentication is required."
+                    },
+                    "lastAttemptAvailable": {
+                      "type": "integer",
+                      "nullable": true,
+                      "description": "Last authentication attempt available."
+                    },
+                    "clientToken": {
+                      "type": "string",
+                      "nullable": true,
+                      "description": "Client token."
+                    },
+                    "authCookie": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Authentication cookie.",
+                      "properties": {
+                        "Name": {
+                          "type": "string",
+                          "description": "Name of the cookie."
+                        },
+                        "Value": {
+                          "type": "string",
+                          "description": "Value of the cookie."
+                        }
+                      }
+                    },
+                    "accountAuthCookie": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Cookie specific to account authentication.",
+                      "properties": {
+                        "Name": {
+                          "type": "string",
+                          "description": "Name of the cookie."
+                        },
+                        "Value": {
+                          "type": "string",
+                          "description": "Value of the cookie."
+                        }
+                      }
+                    },
+                    "expiresIn": {
+                      "type": "integer",
+                      "description": "Time in seconds until authentication expires."
+                    },
+                    "userId": {
+                      "type": "string",
+                      "nullable": true,
+                      "description": "Unique identifier for the authenticated user."
+                    },
+                    "phoneNumber": {
+                      "type": "string",
+                      "nullable": true,
+                      "description": "User's phone number associated with the account."
+                    },
+                    "scope": {
+                      "type": "string",
+                      "nullable": true,
+                      "description": "Authentication scope granted."
+                    }
+                  }
+                },
+                "example": {
+                  "authStatus": "Success",
+                  "promptMFA": false,
+                  "lastAttemptAvailable": null,
+                  "clientToken": null,
+                  "authCookie": {
+                    "Name": "VtexIdclientAutCookie_apiexamples",
+                    "Value": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
+                  },
+                  "accountAuthCookie": {
+                    "Name": "VtexIdclientAutCookie_a8b27fb4-6516-4cc0-82b6-a5f2b011e6e2",
+                    "Value": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
+                  },
+                  "expiresIn": 86399,
+                  "userId": "1f6c17e5-06f9-44a9-a459-b3686e03fa9d",
+                  "phoneNumber": null,
+                  "scope": null
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "description": "Validate session response object.",
+                  "properties": {
+                    "authStatus": {
+                      "type": "string",
+                      "description": "Authentication status of the user, which can be: \n\n* `Success`: when authentication is completed successfully.\n* `InvalidEmail`: When the email informed is not valid.\n* `InvalidToken`: When the token is malformed, expired, or has an invalid signature.\n* `WrongCredentials`: When the informed credentials are not valid.",
+                      "enum": [
+                        "Success",
+                        "InvalidEmail",
+                        "InvalidToken",
+                        "WrongCredentials"
+                      ]
+                    },
+                    "promptMFA": {
+                      "type": "boolean",
+                      "description": "Indicates whether multi-factor authentication is required."
+                    },
+                    "lastAttemptAvailable": {
+                      "type": "integer",
+                      "nullable": true,
+                      "description": "Last authentication attempt available."
+                    },
+                    "clientToken": {
+                      "type": "string",
+                      "nullable": true,
+                      "description": "Client token."
+                    },
+                    "authCookie": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Authentication cookie.",
+                      "properties": {
+                        "Name": {
+                          "type": "string",
+                          "description": "Name of the cookie."
+                        },
+                        "Value": {
+                          "type": "string",
+                          "description": "Value of the cookie."
+                        }
+                      }
+                    },
+                    "accountAuthCookie": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Cookie specific to account authentication.",
+                      "properties": {
+                        "Name": {
+                          "type": "string",
+                          "description": "Name of the cookie."
+                        },
+                        "Value": {
+                          "type": "string",
+                          "description": "Value of the cookie."
+                        }
+                      }
+                    },
+                    "expiresIn": {
+                      "type": "integer",
+                      "description": "Time in seconds until authentication expires."
+                    },
+                    "userId": {
+                      "type": "string",
+                      "nullable": true,
+                      "description": "Unique identifier for the authenticated user."
+                    },
+                    "phoneNumber": {
+                      "type": "string",
+                      "nullable": true,
+                      "description": "User's phone number associated with the account."
+                    },
+                    "scope": {
+                      "type": "string",
+                      "nullable": true,
+                      "description": "Authentication scope granted."
+                    }
+                  }
+                },
+                "example": {
+                  "authStatus": "InvalidEmail",
+                  "promptMFA": false,
+                  "lastAttemptAvailable": null,
+                  "clientToken": null,
+                  "authCookie": null,
+                  "accountAuthCookie": null,
+                  "expiresIn": 0,
+                  "userId": null,
+                  "phoneNumber": null,
+                  "scope": null
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/vtexid/refreshtoken/webstore": {
+      "servers": [
+        {
+          "url": "https://{storeDomain}",
+          "description": "Store domain.",
+          "variables": {
+            "storeDomain": {
+              "description": "Store domain.",
+              "default": "apiexamples.com"
+            }
+          }
+        },
+        {
+          "url": "https://{accountName}.{environment}.com",
+          "description": "VTEX server URL.",
+          "variables": {
+            "accountName": {
+              "description": "Name of the VTEX account. Used as part of the URL.",
+              "default": "apiexamples"
+            },
+            "environment": {
+              "description": "Environment to use. Used as part of the URL.",
+              "enum": [
+                "myvtex"
+              ],
+              "default": "myvtex"
+            }
+          }
+        }
+      ],
+      "post": {
+        "tags": [
+          "Refresh token (Headless)"
+        ],
+        "summary": "Refresh token",
+        "description": "Returns a valid refresh token and authentication token (`VtexIdclientAutCookie`) as cookies.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "application/json"
+            }
+          },
+          {
+            "name": "Host",
+            "in": "header",
+            "description": "Host address.",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "example": "apiexamples.myvtex.com"
+            }
+          },
+          {
+            "name": "vid_rt",
+            "in": "cookie",
+            "description": "Refresh token obtained in the [Validate session](https://developers.vtex.com/docs/api-reference/vtex-id-api#post-/api/vtexid/pub/authentication/accesskey/validate) request.",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "example": "QiEOQKuzdRjukvSnsn7F8h1wwkrqq8wWlkk7bXA5LSbTHkbKbYEfDJ7MGb6_pllGWd1VQ-JxQI7UDLvYrCUH9o7i1rOSeSG8zJewZw"
+            }
+          },
+          {
+            "name": "VtexIdclientAutCookie_{{accountId}}",
+            "in": "cookie",
+            "description": "Account auth cookie.",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
+            }
+          },
+          {
+            "name": "VtexIdclientAutCookie_{{accountName}}",
+            "in": "cookie",
+            "description": "Auth cookie.",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "fingerprint": {
+                    "type": "string",
+                    "description": "Optional device fingerprint for enhanced security. Generated client-side using JavaScript libraries that collect anonymized device and browser parameters to create a unique identifier. Must remain consistent with the fingerprint provided during [initial authentication](https://developers.vtex.com/docs/api-reference/vtex-id-api#get-/api/vtexid/pub/authentication/start), if previously submitted.",
+                    "nullable": true
+                  }
+                }
+              },
+              "example": {
+                "fingerprint": "12345"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "headers": {
+              "Set-Cookie": {
+                "schema": {
+                  "type": "string",
+                  "description": "Valid refresh token.",
+                  "example": "vid_rt=QiEOQKuzdRjukvSnsn7F8h1wwkrqq8wWlkk7bXA5LSbTHkbKbYEfDJ7MGb6_pllGWd1VQ-JxQI7UDLvYrCUH9o7i1rOSeSG8zJewZw"
+                }
+              }
+            },
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "description": "Refresh token response object.",
+                  "properties": {
+                    "status": {
+                      "type": "string",
+                      "description": "Status of the operation. Possible values: \r\n- `Success`: Token refresh was successful. \r\n- `InvalidSession`: The session is invalid or expired. \r\n- `InvalidToken`: The token is invalid. \r\n- `InvalidEmail`: The email associated with the token is invalid. \r\n- `InvalidScope`: The scope is invalid.",
+                      "enum": [
+                        "Success",
+                        "InvalidSession",
+                        "InvalidToken",
+                        "InvalidEmail",
+                        "InvalidScope"
+                      ]
+                    },
+                    "userId": {
+                      "type": "string",
+                      "description": "Unique identifier assigned to the authenticated user."
+                    },
+                    "refreshAfter": {
+                      "type": "string",
+                      "format": "date-time",
+                      "description": "The timestamp indicating when the session should be refreshed, in ISO 8601 format (`YYYY-MM-DDTHH:mm:ss±HH:MM`)."
+                    }
+                  }
+                },
+                "example": {
+                  "status": "Success",
+                  "userId": "1f6c17e5-06f9-44a9-a459-b3686e03fa9d",
+                  "refreshAfter": "2025-03-27T02:36:30+00:00"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "parameters": {
+      "Content-Type": {
+        "name": "Content-Type",
+        "in": "header",
+        "description": "Type of the content being sent.",
+        "required": true,
+        "style": "simple",
+        "schema": {
+          "type": "string",
+          "example": "application/json"
+        }
+      },
+      "Accept": {
+        "name": "Accept",
+        "in": "header",
+        "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+        "required": true,
+        "style": "simple",
+        "schema": {
+          "type": "string",
+          "example": "application/json"
+        }
+      },
+      "an": {
+        "name": "an",
+        "in": "query",
+        "description": "Name of your VTEX account.",
+        "required": false,
+        "style": "form",
+        "schema": {
+          "type": "string",
+          "example": "exampleAccount"
+        }
+      },
+      "accountName": {
+        "name": "accountName",
+        "in": "path",
+        "required": true,
+        "description": "Name of your VTEX account.",
+        "schema": {
+          "type": "string",
+          "example": "apiexamples"
+        }
+      },
+      "environment": {
+        "name": "environment",
+        "in": "path",
+        "required": true,
+        "description": "Environment to be used in the request.",
+        "schema": {
+          "type": "string",
+          "default": "vtexcommercestable"
+        }
+      },
+      "apiKey": {
+        "name": "apiKey",
+        "in": "path",
+        "description": "API Key name.",
+        "required": true,
+        "style": "simple",
+        "schema": {
+          "type": "string",
+          "example": "application/json"
+        }
+      }
+    },
+    "schemas": {
+      "credentials": {
+        "type": "object",
+        "description": "Credentials object, composed of API key and application token.",
+        "required": [
+          "appkey",
+          "apptoken"
+        ],
+        "properties": {
+          "appkey": {
+            "type": "string",
+            "description": "API key.",
+            "example": "vtexappkey-example-YSWQFZ"
+          },
+          "apptoken": {
+            "type": "string",
+            "description": "Application token corresponding to the API key sent with it.",
+            "example": "eyJhbGciOiJFUzI1NiIsImtpZCI6IjA1MTZFN0IwMDNFODMxRTg0QkFDOTg2NzBCNUM2QTRERTlBN0RFNkUiLCJ0eXAiOiJqd3QifQ.eyJzdWIiOiJwZWRyby5jb3N0YUB2dGV4LmNvbS5iciIsImFjY291bnQiOiJhcHBsaWFuY2V0aGVtZSIsImF1ZGllbmNlIjoiYWRtaW4iLCJzZXNzIjoiZjU3YjMyMGItMWE3YS00YzlkLWJkNDMtZTE4NDdhYmE1MTE1IiwiZXhwIjoxNjE2NzY3Mjc4LCJ1c2VySWQiOiJmYjU0MmU1MS01NDg4LTRjMzQtOGQxNy1lZDhmY2Y1OTdhOTQiLCJpYXQiOjE2MwerY2ODA4NzgsImlzcyI6InRva2VuLWVtaXR0ZXIiLCJqdGkiOiJmYTI0YWJiOC03Y2E5LTQ3NjUtYmYzNC1kMmvU5YTgzYjYxZmUifQ.23rn-2dEdAAYXJX2exrxDEdbieyKWsVKABeSUNeFWyhz7xRd7d5EcxwiMLjM3bRaBOKrAA9Op7ocn89c45qQ"
+          }
+        }
+      },
+      "validateSessionResponse": {
+        "type": "object",
+        "description": "Validate session response object.",
+        "properties": {
+          "authStatus": {
+            "type": "string",
+            "description": "Authentication status of the user, which can be: \n\n* `Success`: when authentication is completed successfully.\n* `InvalidEmail`: When the email informed is not valid.\n* `InvalidToken`: When the token is malformed, expired, or has an invalid signature.\n* `WrongCredentials`: When the informed credentials are not valid.",
+            "enum": [
+              "Success",
+              "InvalidEmail",
+              "InvalidToken",
+              "WrongCredentials"
+            ]
+          },
+          "promptMFA": {
+            "type": "boolean",
+            "description": "Indicates whether multi-factor authentication is required."
+          },
+          "lastAttemptAvailable": {
+            "type": "integer",
+            "nullable": true,
+            "description": "Last authentication attempt available."
+          },
+          "clientToken": {
+            "type": "string",
+            "nullable": true,
+            "description": "Client token."
+          },
+          "authCookie": {
+            "type": "object",
+            "nullable": true,
+            "description": "Authentication cookie.",
+            "properties": {
+              "Name": {
+                "type": "string",
+                "description": "Name of the cookie."
+              },
+              "Value": {
+                "type": "string",
+                "description": "Value of the cookie."
+              }
+            }
+          },
+          "accountAuthCookie": {
+            "type": "object",
+            "nullable": true,
+            "description": "Cookie specific to account authentication.",
+            "properties": {
+              "Name": {
+                "type": "string",
+                "description": "Name of the cookie."
+              },
+              "Value": {
+                "type": "string",
+                "description": "Value of the cookie."
+              }
+            }
+          },
+          "expiresIn": {
+            "type": "integer",
+            "description": "Time in seconds until authentication expires."
+          },
+          "userId": {
+            "type": "string",
+            "nullable": true,
+            "description": "Unique identifier for the authenticated user."
+          },
+          "phoneNumber": {
+            "type": "string",
+            "nullable": true,
+            "description": "User's phone number associated with the account."
+          },
+          "scope": {
+            "type": "string",
+            "nullable": true,
+            "description": "Authentication scope granted."
+          }
+        }
+      }
+    },
+    "securitySchemes": {
+      "appKey": {
+        "type": "apiKey",
+        "in": "header",
+        "name": "X-VTEX-API-AppKey",
+        "description": "Unique identifier of the [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys)."
+      },
+      "appToken": {
+        "type": "apiKey",
+        "in": "header",
+        "name": "X-VTEX-API-AppToken",
+        "description": "Secret token of the [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys)."
+      },
+      "VtexIdclientAutCookie": {
+        "type": "apiKey",
+        "in": "header",
+        "name": "VtexIdclientAutCookie",
+        "description": "[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours."
+      }
+    }
+  },
+  "tags": [
+    {
+      "name": "Authentication"
+    },
+    {
+      "name": "Token renewal"
+    },
+    {
+      "name": "Refresh token (Headless)"
+    },
+    {
+      "name": "Storefront users"
+    }
+  ],
+  "security": [
+    {
+      "appKey": [],
+      "appToken": []
+    },
+    {
+      "VtexIdclientAutCookie": []
+    }
+  ]
+}
\ No newline at end of file
diff --git a/vtex/utils/vtexId.ts b/vtex/utils/vtexId.ts
index eae0fd27b..c9bb462fa 100644
--- a/vtex/utils/vtexId.ts
+++ b/vtex/utils/vtexId.ts
@@ -31,6 +31,7 @@ export const parseCookie = (headers: Headers, account: string) => {
 
   return {
     cookie: stringify(cookies),
+    cookies,
     payload,
   };
 };

From b15da97d826a201aaa5d9d12f7771498fef7a8a4 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Thu, 8 Jan 2026 23:00:59 -0400
Subject: [PATCH 70/93] refactor: return id

---
 vtex/actions/credentials/validate.ts | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/vtex/actions/credentials/validate.ts b/vtex/actions/credentials/validate.ts
index bfbc241ec..e9b2145bb 100644
--- a/vtex/actions/credentials/validate.ts
+++ b/vtex/actions/credentials/validate.ts
@@ -13,7 +13,7 @@ export default async function action(
   props: Props,
   req: Request,
   ctx: AppContext,
-): Promise<{ valid: boolean }> {
+): Promise<{ valid: true; id: string } | { valid: false }> {
   const { cookies } = parseCookie(req.headers, ctx.account);
   const autCookie = cookies[`VtexIdclientAutCookie_${ctx.account}`];
   const token = props.token || autCookie;
@@ -26,6 +26,7 @@ export default async function action(
 
     return {
       valid: response.authStatus === "Success",
+      id: response.id!,
     };
   } catch (error) {
     if (error instanceof HttpError && error.status === 401) {

From 93c39cdb5800e8e07ac1754070df9d20072c7825 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Fri, 9 Jan 2026 13:40:12 -0400
Subject: [PATCH 71/93] feat: ignore set cookie and override orderform

---
 vtex/loaders/cart.ts    | 17 ++++++++++++++---
 vtex/utils/orderForm.ts | 15 +++++++++++++--
 2 files changed, 27 insertions(+), 5 deletions(-)

diff --git a/vtex/loaders/cart.ts b/vtex/loaders/cart.ts
index 7444b05c8..f441d8994 100644
--- a/vtex/loaders/cart.ts
+++ b/vtex/loaders/cart.ts
@@ -6,18 +6,25 @@ import type { MarketingData, OrderForm } from "../utils/types.ts";
 import { DEFAULT_EXPECTED_SECTIONS } from "../actions/cart/removeItemAttachment.ts";
 import { forceHttpsOnAssets } from "../utils/transform.ts";
 
+interface Props {
+  orderformId?: string;
+  ignoreSetCookie?: boolean;
+}
+
 /**
  * @docs https://developers.vtex.com/docs/api-reference/checkout-api#get-/api/checkout/pub/orderForm
  * @title Get Cart
  * @description Get the cart from the user logged in
  */
 const loader = async (
-  _props: unknown,
+  props: Props,
   req: Request,
   ctx: AppContext,
 ): Promise<OrderForm> => {
   const { vcsDeprecated } = ctx;
-  const { cookie } = parseCookie(req.headers);
+  const { cookie } = parseCookie(req.headers, {
+    overwrite: { orderformId: props.orderformId },
+  });
   const segment = getSegmentFromBag(ctx);
 
   const response = await vcsDeprecated["POST /api/checkout/pub/orderForm"](
@@ -27,7 +34,11 @@ const loader = async (
 
   const result = response.json();
 
-  proxySetCookie(response.headers, ctx.response.headers, req.url);
+  if (!props.ignoreSetCookie) {
+    proxySetCookie(response.headers, ctx.response.headers, req.url);
+  } else {
+    response.headers.delete("set-cookie");
+  }
 
   if (!segment?.payload) {
     return forceHttpsOnAssets((await result) as OrderForm);
diff --git a/vtex/utils/orderForm.ts b/vtex/utils/orderForm.ts
index 0953250d5..a54d89b2d 100644
--- a/vtex/utils/orderForm.ts
+++ b/vtex/utils/orderForm.ts
@@ -4,9 +4,20 @@ import { MarketingData } from "./types.ts";
 
 const VTEX_CHECKOUT_COOKIE = "checkout.vtex.com";
 
-export const parseCookie = (headers: Headers) => {
+interface ParseCookieOptions {
+  overwrite?: {
+    orderformId?: string;
+  };
+}
+
+export const parseCookie = (
+  headers: Headers,
+  options?: ParseCookieOptions,
+) => {
   const cookies = getCookies(headers);
-  const ofidCookie = cookies[VTEX_CHECKOUT_COOKIE];
+  const ofidCookie = options?.overwrite?.orderformId
+    ? `__ofid=${options.overwrite.orderformId}`
+    : cookies[VTEX_CHECKOUT_COOKIE];
 
   /**
    * There are two cookies present for VTEX Auth:

From e46dd595f3687fb754822d493ef8eac8234d3ccb Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Fri, 9 Jan 2026 13:48:52 -0400
Subject: [PATCH 72/93] feat: export vcs deprecated

---
 vtex/loaders/config.ts | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/vtex/loaders/config.ts b/vtex/loaders/config.ts
index 0447d9099..1a14a2323 100644
--- a/vtex/loaders/config.ts
+++ b/vtex/loaders/config.ts
@@ -12,6 +12,7 @@ export type Config = {
   sp: ReturnType<typeof createHttpClient<SP>>;
   io: ReturnType<typeof createGraphqlClient>;
   vcs: ReturnType<typeof createHttpClient<VCS>>;
+  vcsDeprecated: ReturnType<typeof createHttpClient<VCS>>;
   my: ReturnType<typeof createHttpClient<MY>>;
   api: ReturnType<typeof createHttpClient<API>>;
   vpay: ReturnType<typeof createHttpClient<VPAY>>;
@@ -30,6 +31,7 @@ const loader = (_props: unknown, _req: Request, ctx: AppContext): Config => ({
   api: ctx.api,
   vpay: ctx.vpay,
   sub: ctx.sub,
+  vcsDeprecated: ctx.vcsDeprecated as unknown as typeof ctx.vcs,
 });
 
 export default loader;

From 02c928a43ce0752f4a5a88166ec98ee101951539 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Fri, 9 Jan 2026 14:03:55 -0400
Subject: [PATCH 73/93] feat: proper checkout api type

---
 vtex/mod.ts                                |     3 +-
 vtex/utils/openapi/checkout.openapi.gen.ts | 27556 ++++++++++++
 vtex/utils/openapi/checkout.openapi.json   | 43725 +++++++++++++++++++
 vtex/utils/openapi/logistics.openapi.json  |     2 +-
 vtex/utils/openapi/vcs.openapi.gen.ts      |  7385 +---
 vtex/utils/openapi/vcs.openapi.json        | 16047 +------
 vtex/utils/openapi/vtexid.openapi.json     |     2 +-
 7 files changed, 72336 insertions(+), 22384 deletions(-)
 create mode 100644 vtex/utils/openapi/checkout.openapi.gen.ts
 create mode 100644 vtex/utils/openapi/checkout.openapi.json

diff --git a/vtex/mod.ts b/vtex/mod.ts
index ad8ef63bc..b5a0901da 100644
--- a/vtex/mod.ts
+++ b/vtex/mod.ts
@@ -25,9 +25,10 @@ import { OpenAPI as VPAY } from "./utils/openapi/payments.openapi.gen.ts";
 import { OpenAPI as SUB } from "./utils/openapi/subscriptions.openapi.gen.ts";
 import { OpenAPI as _VCS } from "./utils/openapi/vcs.openapi.gen.ts";
 import { OpenAPI as VTEXID } from "./utils/openapi/vtexid.openapi.gen.ts";
+import { OpenAPI as CHECKOUT } from "./utils/openapi/checkout.openapi.gen.ts";
 import { OpenAPI as LOGISTICS } from "./utils/openapi/logistics.openapi.gen.ts";
 
-type VCS = _VCS & LOGISTICS & VTEXID;
+type VCS = _VCS & LOGISTICS & VTEXID & CHECKOUT;
 
 import { Segment } from "./utils/types.ts";
 
diff --git a/vtex/utils/openapi/checkout.openapi.gen.ts b/vtex/utils/openapi/checkout.openapi.gen.ts
new file mode 100644
index 000000000..1741a6805
--- /dev/null
+++ b/vtex/utils/openapi/checkout.openapi.gen.ts
@@ -0,0 +1,27556 @@
+
+// deno-fmt-ignore-file
+// deno-lint-ignore-file no-explicit-any ban-types ban-unused-ignore
+//
+// DO NOT EDIT. This file is generated by deco.
+// This file SHOULD be checked into source version control.
+// To generate this file: deno task start
+//        
+
+
+/**
+ * ID of the `orderForm` corresponding to the cart from which to place the order. This is the same as the `orderFormId` parameter.
+ */
+export type ReferenceId = string
+/**
+ * `true` if the shopper's data provided during checkout should be saved for future reference.
+ */
+export type SavePersonalData = boolean
+/**
+ * True if the shopper opted to receive the newsletter.
+ */
+export type OptinNewsLetter = (null | boolean)
+
+export interface OpenAPI {
+/**
+ * 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 seller ID.
+ * 
+ * It returns all information about the cart, such as the selling price of each item, pricing and promotion data, payment and logistics info.
+ * 
+ * This request 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.
+ * 
+ * >⚠️ 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.
+ * 
+ * ## Permissions
+ * 
+ * This endpoint does not require [authentication](https://developers.vtex.com/docs/guides/authentication) or [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).
+ */
+"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`.
+ */
+RnbBehavior?: number
+/**
+ * Trade Policy (Sales Channel) identification.
+ */
+sc?: number
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+body: {
+/**
+ * Array containing information about the SKUs inside the cart to be simulated.
+ */
+items?: {
+/**
+ * The SKU ID.
+ */
+id?: string
+/**
+ * The quantity of items of this specific SKU in the cart to be simulated.
+ */
+quantity?: number
+/**
+ * The ID of the seller responsible for this SKU. This ID can be found in your VTEX Admin.
+ */
+seller?: string
+}[]
+/**
+ * Three letter ISO code of the country of the shipping address. This value must be sent along with the `postalCode` or `geoCoordinates` values.
+ */
+country?: string
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * Array containing two floats with geocoordinates, first longitude, then latitude.
+ */
+geoCoordinates?: number[]
+minItems?: 0
+}
+response: {
+/**
+ * Information on each item in the cart.
+ */
+items?: {
+/**
+ * ID of the item.
+ */
+id?: string
+/**
+ * Request index information.
+ */
+requestIndex?: number
+/**
+ * The quantity of the item the cart.
+ */
+quantity?: number
+/**
+ * The seller responsible for the SKU.
+ */
+seller?: string
+/**
+ * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
+ */
+sellerChain?: string[]
+/**
+ * Tax value in cents.
+ */
+tax?: number
+/**
+ * A unique identifier code assigned to a tax within the VTEX Admin.
+ */
+taxCode?: string
+/**
+ * Price expiration date and time.
+ */
+priceValidUntil?: string
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Reward value in cents.
+ */
+rewardValue?: number
+/**
+ * Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
+ */
+sellingPrice?: number
+/**
+ * Array containing offering information of SKU service. A service is an item that may come with a product, optionally and with cost. It is used to assign a value of an additional service itself to an SKU.
+ */
+offerings?: {
+/**
+ * Service type.
+ */
+type?: string
+/**
+ * Service type ID.
+ */
+id?: string
+/**
+ * Name of the service type.
+ */
+name?: string
+/**
+ * Option to display the service type on the gift card.
+ */
+allowGiftMessage?: boolean
+/**
+ * List of attachments details.
+ */
+attachmentOfferings?: (null | {
+/**
+ * Name of the attachment.
+ */
+name: (null | string)
+/**
+ * Defines if the attachment is required (`true`) or not (`false`).
+ */
+required: (null | boolean)
+/**
+ * Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).
+ */
+schema: (null | {
+
+})
+}[])
+/**
+ * Service type price.
+ */
+price?: number
+}[]
+/**
+ * Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.
+ */
+priceTags?: {
+/**
+ * Promotion unique identifier.
+ */
+identifier?: (null | string)
+/**
+ * Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.
+ */
+isPercentual?: boolean
+/**
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
+ * - `calculationId` is a hash that may vary with each price calculation.
+ */
+name?: string
+/**
+ * Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.
+ */
+rawValue?: number
+/**
+ * Price tag value representing either a promotion (value decrease) or a tax (value increase).
+ */
+value?: number
+}[]
+/**
+ * Measurement unit.
+ */
+measurementUnit?: string
+/**
+ * Unit multiplier.
+ */
+unitMultiplier?: number
+/**
+ * Parent item index.
+ */
+parentItemIndex?: (null | number)
+/**
+ * Parent assembly binding.
+ */
+parentAssemblyBinding?: (null | string)
+/**
+ * Availability.
+ */
+availability?: string
+/**
+ * Price information for all units of a specific item.
+ */
+priceDefinition?: {
+/**
+ * Item's calculated unitary selling price in cents.
+ */
+calculatedSellingPrice?: number
+/**
+ * Total value for all units of the item in cents.
+ */
+total?: number
+/**
+ * Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
+ */
+sellingPrices?: {
+/**
+ * Value in cents for that specific rounding.
+ */
+value?: number
+/**
+ * Rounding quantity, meaning how many items are rounded to this value.
+ */
+quantity?: number
+}[]
+}
+}[]
+/**
+ * Information on pricing and promotions that apply to the order.
+ */
+ratesAndBenefitsData?: {
+/**
+ * List with pricing and promotions identifiers.
+ */
+rateAndBenefitsIdentifiers?: string[]
+/**
+ * List with pricing and promotions teaser.
+ */
+teaser?: string[]
+}
+/**
+ * Payment data information.
+ */
+paymentData?: {
+/**
+ * List of Installment options.
+ */
+installmentOptions?: {
+/**
+ * Payment system identification.
+ */
+paymentSystem?: number
+/**
+ * Card bin.
+ */
+bin?: (null | string)
+/**
+ * Payment name.
+ */
+paymentName?: (null | string)
+/**
+ * Payment group name.
+ */
+paymentGroupName?: (null | string)
+/**
+ * Total value assigned to this payment.
+ */
+value?: number
+/**
+ * Installment information.
+ */
+installments?: {
+/**
+ * Count information.
+ */
+count?: number
+/**
+ * Indicates whether the payment has interest.
+ */
+hasInterestRate?: boolean
+/**
+ * Interest rate value.
+ */
+interestRate?: number
+/**
+ * Value of the order without the interest rate. The value is shown without separating cents.
+ */
+value?: number
+/**
+ * Total value of the order without separating cents. For example, $24.99 is represented `2499`.
+ */
+total?: number
+/**
+ * Seller merchant installments information.
+ */
+sellerMerchantInstallments?: {
+
+}[]
+}[]
+}[]
+/**
+ * Information on payment systems.
+ */
+paymentSystems?: {
+/**
+ * Payment system ID.
+ */
+id?: number
+/**
+ * Payment system name.
+ */
+name?: string
+/**
+ * Payment group name.
+ */
+groupName?: string
+/**
+ * Payment system validator.
+ */
+validator?: (null | {
+
+})
+/**
+ * String ID.
+ */
+stringId?: string
+/**
+ * Template.
+ */
+template?: string
+/**
+ * Indicates whether a document is required.
+ */
+requiresDocument?: boolean
+/**
+ * Indicates whether a document is shown.
+ */
+displayDocument?: boolean
+/**
+ * Indicates whether it is custom.
+ */
+isCustom?: boolean
+/**
+ * Description.
+ */
+description?: string
+/**
+ * Indicates whether a authentication is required.
+ */
+requiresAuthentication?: boolean
+/**
+ * Payment due date.
+ */
+dueDate?: string
+/**
+ * Availability of payment.
+ */
+availablePayments?: (null | string)
+}[]
+/**
+ * Array with information on each payment chosen by the shopper.
+ */
+payments?: {
+/**
+ * Payment system ID.
+ */
+paymentSystem?: number
+/**
+ * Payment system name.
+ */
+paymentSystemName?: string
+/**
+ * Payment system group.
+ */
+group?: string
+/**
+ * Selected number of installments.
+ */
+installments?: number
+/**
+ * Installments' interest rate.
+ */
+installmentsInterestRate?: number
+/**
+ * Value of the installments.
+ */
+installmentsValue?: number
+/**
+ * Total value assigned to this payment.
+ */
+value?: number
+/**
+ * Reference value used to calculate total order value with interest.
+ */
+referenceValue?: number
+/**
+ * Indicates whether billing address for this payment is the default address.
+ */
+hasDefaultBillingAddress?: boolean
+}[]
+/**
+ * Gift card information, if it applies to the order.
+ */
+giftCards?: string[]
+/**
+ * Array of gift card messages.
+ */
+giftCardMessages?: string[]
+/**
+ * Available accounts.
+ */
+availableAccounts?: string[]
+/**
+ * Available tokens.
+ */
+availableTokens?: string[]
+/**
+ * Available associations.
+ */
+availableAssociations?: {
+
+}
+}
+/**
+ * Array containing the data of the items selected as a gift.
+ */
+selectableGifts?: string[]
+/**
+ * Object containing promotion data such as coupon tracking information and internal or external UTMs.
+ */
+marketingData?: (null | {
+
+})
+/**
+ * Postal code.
+ */
+postalCode?: (null | string)
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Array with logistics information on each item of the `items` array in the `orderForm`.
+ */
+logisticsInfo?: {
+/**
+ * Index of item in items array.
+ */
+itemIndex?: number
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Selected SLA. For example, `"normal"` or `"express"`.
+ */
+selectedSla?: (null | string)
+/**
+ * Delivery channel selected by the customer. For example, `"delivery"` or `"pickup-in-point"`.
+ */
+selectedDeliveryChannel?: (null | string)
+/**
+ * Quantity.
+ */
+quantity?: number
+/**
+ * List of countries that the item may be shipped to.
+ */
+shipsTo?: string[]
+/**
+ * Information on available SLAs.
+ */
+slas?: {
+/**
+ * SLA ID.
+ */
+id?: string
+/**
+ * Delivery channel.
+ */
+deliveryChannel?: string
+/**
+ * SLA name.
+ */
+name?: string
+/**
+ * Information on each delivery ID.
+ */
+deliveryIds?: {
+/**
+ * Courier ID.
+ */
+courierId?: string
+/**
+ * Warehouse ID.
+ */
+warehouseId?: string
+/**
+ * Warehouse ID.
+ */
+dockId?: string
+/**
+ * Courier name.
+ */
+courierName?: string
+/**
+ * Quantity.
+ */
+quantity?: number
+}[]
+/**
+ * List of attachments details.
+ */
+attachmentOfferings?: (null | {
+/**
+ * Name of the attachment.
+ */
+name: (null | string)
+/**
+ * Defines if the attachment is required (`true`) or not (`false`).
+ */
+required: (null | boolean)
+/**
+ * Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).
+ */
+schema: (null | {
+
+})
+}[])
+/**
+ * Shipping estimate. For instance, "three business days" will be represented as `3bd`.
+ */
+shippingEstimate?: string
+/**
+ * When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.
+ */
+shippingEstimateDate?: (null | string)
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+useIndividualShippingEstimates?: boolean
+/**
+ * Estimate date of delivery.
+ */
+lockTTL?: (null | string)
+/**
+ * This object contains information about the delivery window available to the shopper.
+ */
+availableDeliveryWindows?: {
+/**
+ * Delivery window starting day and time in UTC.
+ */
+startDateUtc?: string
+/**
+ * Delivery window ending day and time in UTC.
+ */
+endDateUtc?: string
+/**
+ * Delivery window price.
+ */
+price?: number
+/**
+ * Delivery window list price.
+ */
+lisPrice?: number
+/**
+ * Delivery window tax.
+ */
+tax?: number
+}
+/**
+ * In case of scheduled delivery, this object will contain information on the delivery window selected by the shopper.
+ */
+deliveryWindow?: {
+/**
+ * Delivery window starting day and time in UTC.
+ */
+startDateUtc?: string
+/**
+ * Delivery window ending day and time in UTC.
+ */
+endDateUtc?: string
+/**
+ * Delivery window price.
+ */
+price?: number
+/**
+ * Delivery window list price.
+ */
+lisPrice?: number
+/**
+ * Delivery window tax.
+ */
+tax?: number
+}
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Tax in cents.
+ */
+tax?: number
+/**
+ * Information on the pickup store.
+ */
+pickupStoreInfo?: {
+/**
+ * Indicates whether it is the pickup store.
+ */
+isPickupStore?: boolean
+/**
+ * Friendly name.
+ */
+friendlyName?: (null | string)
+/**
+ * Address information.
+ */
+address?: (null | {
+
+})
+/**
+ * Additional information.
+ */
+additionalInfo?: (null | string)
+/**
+ * Corresponding dock ID.
+ */
+dockId?: (null | string)
+}
+/**
+ * Pickup point ID.
+ */
+pickupPointId?: (null | string)
+/**
+ * Pickup point distance.
+ */
+pickupDistance?: number
+/**
+ * Polygon name.
+ */
+polygonName?: (null | string)
+/**
+ * Transit time. For instance, "three business days" is represented as `3bd`.
+ */
+transitTime?: string
+}[]
+/**
+ * List of available delivery channels.
+ */
+deliveryChannels?: {
+/**
+ * Delivery channel ID.
+ */
+id?: string
+}[]
+/**
+ * Array containing an object for each message generated by our servers while processing the request.
+ */
+messages?: string[]
+/**
+ * Purchase conditions information.
+ */
+purchaseConditions?: {
+/**
+ * List of objects containing purchase condition information on each item in the order.
+ */
+itemPurchaseConditions?: {
+/**
+ * Item ID.
+ */
+id?: string
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
+ */
+sellerChain?: string[]
+/**
+ * Information on available SLAs.
+ */
+slas?: {
+/**
+ * SLA ID.
+ */
+id?: string
+/**
+ * Delivery channel.
+ */
+deliveryChannel?: string
+/**
+ * SLA name.
+ */
+name?: string
+/**
+ * Information on each delivery ID.
+ */
+deliveryIds?: {
+/**
+ * Courier ID.
+ */
+courierId?: string
+/**
+ * Warehouse ID.
+ */
+warehouseId?: string
+/**
+ * Warehouse ID.
+ */
+dockId?: string
+/**
+ * Courier name.
+ */
+courierName?: string
+/**
+ * Quantity.
+ */
+quantity?: number
+}[]
+/**
+ * List of attachments details.
+ */
+attachmentOfferings?: (null | {
+/**
+ * Name of the attachment. Ex. `vtex.subscription.weekly`.
+ */
+name: (null | string)
+/**
+ * Defines if the attachment is required (`true`) or not (`false`).
+ */
+required: (null | boolean)
+/**
+ * Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).
+ */
+schema: (null | {
+
+})
+}[])
+/**
+ * Shipping estimate. For instance, "three business days" will be represented as `3bd`.
+ */
+shippingEstimate?: string
+/**
+ * When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.
+ */
+shippingEstimateDate?: (null | string)
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+useIndividualShippingEstimates?: boolean
+/**
+ * Estimate date of delivery.
+ */
+lockTTL?: (null | string)
+/**
+ * This object contains information about the delivery window available to the shopper.
+ */
+availableDeliveryWindows?: {
+/**
+ * Delivery window starting day and time in UTC.
+ */
+startDateUtc?: string
+/**
+ * Delivery window ending day and time in UTC.
+ */
+endDateUtc?: string
+/**
+ * Delivery window price.
+ */
+price?: number
+/**
+ * Delivery window list price.
+ */
+lisPrice?: number
+/**
+ * Delivery window tax.
+ */
+tax?: number
+}
+/**
+ * In case of scheduled delivery, this object will contain information on the delivery window selected by the shopper.
+ */
+deliveryWindow?: {
+/**
+ * Delivery window starting day and time in UTC.
+ */
+startDateUtc?: string
+/**
+ * Delivery window ending day and time in UTC.
+ */
+endDateUtc?: string
+/**
+ * Delivery window price.
+ */
+price?: number
+/**
+ * Delivery window list price.
+ */
+lisPrice?: number
+/**
+ * Delivery window tax.
+ */
+tax?: number
+}
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Tax in cents.
+ */
+tax?: number
+/**
+ * Information on the pickup store.
+ */
+pickupStoreInfo?: {
+/**
+ * Indicates whether it is the pickup store.
+ */
+isPickupStore?: boolean
+/**
+ * Friendly name.
+ */
+friendlyName?: (null | string)
+/**
+ * Address information.
+ */
+address?: (null | {
+
+})
+/**
+ * Additional information.
+ */
+additionalInfo?: (null | string)
+/**
+ * Corresponding dock ID.
+ */
+dockId?: (null | string)
+}
+/**
+ * Pickup point ID.
+ */
+pickupPointId?: (null | string)
+/**
+ * Pickup point distance.
+ */
+pickupDistance?: number
+/**
+ * Polygon name.
+ */
+polygonName?: (null | string)
+/**
+ * Transit time. For instance, "three business days" is represented as `3bd`.
+ */
+transitTime?: string
+}[]
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+}[]
+}
+/**
+ * Array containing pickup points information.
+ */
+pickupPoints?: string[]
+/**
+ * Subscription information.
+ */
+subscriptionData?: (null | {
+
+})
+/**
+ * Information on order totals.
+ */
+totals?: {
+/**
+ * Total ID.
+ */
+id?: string
+/**
+ * Total name.
+ */
+name?: string
+/**
+ * Total value.
+ */
+value?: number
+}[]
+/**
+ * Item metadata.
+ */
+itemMetadata?: {
+/**
+ * List of objects containing metadata on each item in the order.
+ */
+items?: {
+/**
+ * Item ID.
+ */
+id?: string
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Assembly options information.
+ */
+assemblyOptions?: string[]
+}[]
+}
+}[]
+}
+}
+/**
+ * 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"GET /api/checkout/pub/orderForm": {
+searchParams: {
+/**
+ * Use this query parameter to create a new empty shopping cart.
+ */
+forceNewCart?: boolean
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+response: {
+/**
+ * ID of the orderForm corresponding to a specific cart.
+ */
+orderFormId?: string
+/**
+ * Attribute created by the seller, in their VTEX store configuration.
+ */
+salesChannel?: string
+/**
+ * Indicates whether the user is logged into the store.
+ */
+loggedIn?: boolean
+/**
+ * Indicates whether order is checked in.
+ */
+isCheckedIn?: boolean
+/**
+ * ID of the store.
+ */
+storeId?: (null | string)
+/**
+ * Permission to modify item price manually.
+ */
+allowManualPrice?: boolean
+/**
+ * Data can be edited.
+ */
+canEditData?: boolean
+/**
+ * Unique ID associated with the customer profile.
+ */
+userProfileId?: string
+/**
+ * Profile provider.
+ */
+profileProvider?: string
+/**
+ * Available accounts.
+ */
+availableAccounts?: string[]
+/**
+ * Information on each available address.
+ */
+availableAddresses?: {
+/**
+ * Address type.
+ */
+addressType?: string
+/**
+ * Name of the receiver.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * City of the address.
+ */
+city?: string
+/**
+ * State of the address.
+ */
+state?: string
+/**
+ * Country of the address. ISO three-letter code.
+ */
+country?: string
+/**
+ * Street of the address.
+ */
+street?: string
+/**
+ * Number of the address.
+ */
+number?: string
+/**
+ * Neighborhood of the address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Reference that may help in the location of the address.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * User type.
+ */
+userType?: (null | string)
+/**
+ * Ignore customer profile data.
+ */
+ignoreProfileData?: boolean
+/**
+ * Total value of the order without separating cents. For example, $24.99 is represented as `2499`.
+ */
+value?: number
+/**
+ * Array containing an object for each message generated by our servers while processing the request.
+ */
+messages?: string[]
+/**
+ * Information on each item in the order.
+ */
+items?: {
+/**
+ * Unique ID.
+ */
+uniqueId?: string
+/**
+ * ID of the item.
+ */
+id?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Product Ref ID.
+ */
+productRefId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Modal type.
+ */
+modalType?: (null | string)
+/**
+ * Parent item index.
+ */
+parentItemIndex?: (null | number)
+/**
+ * Parent assembly binding.
+ */
+parentAssemblyBinding?: (null | string)
+/**
+ * Price expiration date and time.
+ */
+priceValidUntil?: string
+/**
+ * Tax value in cents.
+ */
+tax?: number
+/**
+ * A unique identifier code assigned to a tax within the VTEX Admin.
+ */
+taxCode?: string
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Manual price in cents.
+ */
+manualPrice?: (null | number)
+/**
+ * User that applied the manual price, if that is the case.
+ */
+manualPriceAppliedBy?: (null | string)
+/**
+ * Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
+ */
+sellingPrice?: number
+/**
+ * Reward value in cents.
+ */
+rewardValue?: number
+/**
+ * Indicates whether item is a gift.
+ */
+isGift?: boolean
+/**
+ * Additional information.
+ */
+additionalInfo?: {
+/**
+ * Dimension.
+ */
+dimension?: (null | string)
+/**
+ * Brand name.
+ */
+brandName?: string
+/**
+ * Brand ID.
+ */
+brandId?: string
+/**
+ * Offering information.
+ */
+offeringInfo?: (null | string)
+/**
+ * Offering type.
+ */
+offeringType?: (null | string)
+/**
+ * Offering type ID.
+ */
+offeringTypeId?: (null | string)
+}
+/**
+ * Presale date.
+ */
+preSaleDate?: (null | string)
+/**
+ * Product category IDs.
+ */
+productCategoryIds?: string
+/**
+ * Object, where each field is an ID from `productCategoryIds`.
+ */
+productCategories?: {
+/**
+ * Product category corresponding to the ID in the field key.
+ */
+"{ID}"?: string
+}
+/**
+ * Quantity.
+ */
+quantity?: number
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
+ */
+sellerChain?: string[]
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+/**
+ * Information on services sold along with the SKU. Example: a gift package.
+ */
+bundleItems?: {
+/**
+ * Service type.
+ */
+type?: string
+/**
+ * Service identifier.
+ */
+id?: number
+/**
+ * Service name.
+ */
+name?: string
+/**
+ * Service price in cents.
+ */
+price?: number
+}[]
+/**
+ * Array containing information on attachments.
+ */
+attachments?: string[]
+/**
+ * Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.
+ */
+priceTags?: {
+/**
+ * Promotion unique identifier.
+ */
+identifier?: (null | string)
+/**
+ * Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.
+ */
+isPercentual?: boolean
+/**
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
+ * - `calculationId` is a hash that may vary with each price calculation.
+ */
+name?: string
+/**
+ * Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.
+ */
+rawValue?: number
+/**
+ * Price tag value representing either a promotion (value decrease) or a tax (value increase).
+ */
+value?: number
+}[]
+/**
+ * Availability.
+ */
+availability?: string
+/**
+ * Measurement unit.
+ */
+measurementUnit?: string
+/**
+ * Unit multiplier.
+ */
+unitMultiplier?: number
+/**
+ * Manufacturer code.
+ */
+manufacturerCode?: (null | string)
+/**
+ * Price information for all units of a specific item.
+ */
+priceDefinition?: {
+/**
+ * Item's calculated unitary selling price in cents.
+ */
+calculatedSellingPrice?: number
+/**
+ * Total value for all units of the item in cents.
+ */
+total?: number
+/**
+ * Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
+ */
+sellingPrices?: {
+/**
+ * Value in cents for that specific rounding.
+ */
+value?: number
+/**
+ * Rounding quantity, meaning how many items are rounded to this value.
+ */
+quantity?: number
+}[]
+}
+}[]
+/**
+ * Array containing the data of the item selected as a gift.
+ */
+selectableGifts?: string[]
+/**
+ * Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).
+ */
+totalizers?: {
+
+}[]
+/**
+ * Shipping information pertinent to the order.
+ */
+shippingData?: (null | {
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.
+ */
+logisticsInfo?: {
+/**
+ * Index corresponding to the position of the object in the `items` array.
+ */
+itemIndex?: number
+/**
+ * SLA selected by the customer.
+ */
+selectedSla?: (null | string)
+/**
+ * Delivery channel selected by the customer.
+ */
+selectedDeliveryChannel?: (null | string)
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Information on available SLAs.
+ */
+slas?: {
+/**
+ * SLA ID.
+ */
+id?: string
+/**
+ * Delivery channel.
+ */
+deliveryChannel?: string
+/**
+ * SLA name.
+ */
+name?: string
+/**
+ * Information on each delivery ID.
+ */
+deliveryIds?: {
+/**
+ * Courier ID.
+ */
+courierId?: string
+/**
+ * Warehouse ID.
+ */
+warehouseId?: string
+/**
+ * Warehouse ID.
+ */
+dockId?: string
+/**
+ * Courier name.
+ */
+courierName?: string
+/**
+ * Quantity.
+ */
+quantity?: number
+}[]
+/**
+ * List of attachments details.
+ */
+attachmentOfferings?: (null | {
+/**
+ * Name of the attachment.
+ */
+name: (null | string)
+/**
+ * Defines if the attachment is required (`true`) or not (`false`).
+ */
+required: (null | boolean)
+/**
+ * Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).
+ */
+schema: (null | {
+
+})
+}[])
+/**
+ * Shipping estimate. For instance, "three business days" will be represented as `3bd`.
+ */
+shippingEstimate?: string
+/**
+ * When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.
+ */
+shippingEstimateDate?: (null | string)
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+useIndividualShippingEstimates?: boolean
+/**
+ * Estimate date of delivery.
+ */
+lockTTL?: (null | string)
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Tax in cents.
+ */
+tax?: number
+/**
+ * Information on the pickup store.
+ */
+pickupStoreInfo?: {
+/**
+ * Indicates whether it is the pickup store.
+ */
+isPickupStore?: boolean
+/**
+ * Friendly name.
+ */
+friendlyName?: (null | string)
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that repesent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Additional information.
+ */
+additionalInfo?: (null | string)
+/**
+ * Corresponding dock ID.
+ */
+dockId?: (null | string)
+}
+/**
+ * Pickup point ID.
+ */
+pickupPointId?: (null | string)
+/**
+ * Pickup point distance.
+ */
+pickupDistance?: number
+/**
+ * Polygon name.
+ */
+polygonName?: (null | string)
+/**
+ * Transit time. For instance, "three business days" is represented as `3bd`.
+ */
+transitTime?: string
+}[]
+/**
+ * List of countries that the item may be shipped to.
+ */
+shipsTo?: string[]
+/**
+ * Item ID.
+ */
+itemId?: string
+/**
+ * List of available delivery channels.
+ */
+deliveryChannels?: {
+/**
+ * Delivery channel ID.
+ */
+id?: string
+}[]
+}[]
+/**
+ * Array with information on the selected addresses for the order.
+ */
+selectedAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * Array with information on the available addresses for the order.
+ */
+availableAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+})
+/**
+ * Customer's profile information.
+ */
+clientProfileData?: (null | {
+/**
+ * Email address.
+ */
+email?: (null | string)
+/**
+ * First name.
+ */
+firstName?: (null | string)
+/**
+ * Last name.
+ */
+lastName?: string
+/**
+ * Type of the document informed by the customer.
+ */
+documentType?: string
+/**
+ * Document informed by the customer.
+ */
+document?: string
+/**
+ * Phone number.
+ */
+phone?: string
+/**
+ * Company name, if the customer is a legal entity.
+ */
+corporateName?: (null | string)
+/**
+ * Trade name, if the customer is a legal entity.
+ */
+tradeName?: (null | string)
+/**
+ * Corporate document, if the customer is a legal entity.
+ */
+corporateDocument?: (null | string)
+/**
+ * State inscription, if the customer is a legal entity.
+ */
+stateInscription?: (null | string)
+/**
+ * Corporate phone number, if the customer is a legal entity.
+ */
+corporatePhone?: (null | string)
+/**
+ * Indicates whether the customer is a legal entity.
+ */
+isCorporate?: boolean
+/**
+ * Indicates whether profile is complete on loading.
+ */
+profileCompleteOnLoading?: boolean
+/**
+ * Indicates whether profile presents error on loading.
+ */
+profileErrorOnLoading?: (null | boolean)
+/**
+ * Customer class.
+ */
+customerClass?: (null | string)
+})
+/**
+ * Information on the order's payment.
+ */
+paymentData?: {
+/**
+ * Gift card information, if it applies to the order.
+ */
+giftCards?: {
+/**
+ * Gift card redemption code.
+ */
+redemptionCode?: string
+/**
+ * Gift card value in cents.
+ */
+value?: number
+/**
+ * Gift card balance in cents.
+ */
+balance?: number
+/**
+ * Gift card name.
+ */
+name?: string
+/**
+ * Gift card ID.
+ */
+id?: string
+/**
+ * Indicates whether gift card is in use.
+ */
+inUse?: boolean
+/**
+ * Indicates whether gift card is special.
+ */
+isSpecialCard?: boolean
+}[]
+/**
+ * Information on each transaction pertinent to the order.
+ */
+transactions?: (null | {
+/**
+ * Indicates whether transaction is active.
+ */
+isActive?: boolean
+/**
+ * Transaction ID.
+ */
+transactionId?: string
+/**
+ * Merchant name.
+ */
+merchantName?: string
+/**
+ * Information on each payment.
+ */
+payments?: {
+/**
+ * Account ID.
+ */
+accountId?: string
+/**
+ * Bin.
+ */
+bin?: (null | string)
+/**
+ * Number of installments.
+ */
+installments?: number
+/**
+ * Payment system.
+ */
+paymentSystem?: string
+/**
+ * Reference value for calculating interest rates, in case it applies. Displayed in cents.
+ */
+referenceValue?: number
+/**
+ * Value including interest, in case it applies. Displayed in cents.
+ */
+value?: number
+}[]
+/**
+ * Indicates whather transaction is shared.
+ */
+sharedTransaction?: boolean
+})[]
+}
+/**
+ * Object containing promotion data such as coupon tracking information and internal or external UTMs.
+ */
+marketingData?: (null | {
+/**
+ * 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.
+ */
+coupon?: string
+/**
+ * UTM source.
+ */
+utmSource?: string
+/**
+ * UTM medium.
+ */
+utmMedium?: string
+/**
+ * UTM campaign.
+ */
+utmCampaign?: string
+/**
+ * utmi_page (internal utm).
+ */
+utmiPage?: (null | string)
+/**
+ * utmi_part (internal utm).
+ */
+utmiPart?: (null | string)
+/**
+ * utmi_campaign (internal utm).
+ */
+utmiCampaign?: (null | string)
+})
+/**
+ * Information on each seller.
+ */
+sellers?: {
+/**
+ * Seller ID.
+ */
+id?: string
+/**
+ * Seller name.
+ */
+name?: string
+/**
+ * Seller logo.
+ */
+logo?: (null | string)
+}[]
+/**
+ * Object containing preferences from the client who placed the order.
+ */
+clientPreferencesData?: {
+/**
+ * Client's locale. Examples: `pt-BR` and `en-US`.
+ */
+locale?: string
+/**
+ * `true` if the client opted to receive newsletter from the store.
+ */
+optinNewsLetter?: (null | boolean)
+}
+/**
+ * Object containing commercial condition information.
+ */
+commercialConditionData?: (null | {
+
+})
+/**
+ * Object containing data from the store's configuration (stored in VTEX's License Manager).
+ */
+storePreferencesData?: {
+
+}
+/**
+ * Gift registry list information.
+ */
+giftRegistryData?: (null | {
+
+})
+/**
+ * Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).
+ */
+openTextField?: (null | string)
+/**
+ * Invoice data including billing address.
+ */
+invoiceData?: (null | {
+/**
+ * Billing address.
+ */
+address?: {
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City name.
+ */
+city?: string
+/**
+ * State name.
+ */
+state?: string
+/**
+ * Country.
+ */
+country?: string
+/**
+ * Street name.
+ */
+street?: string
+/**
+ * Street number.
+ */
+number?: string
+/**
+ * Neighborhood.
+ */
+neighborhood?: string
+/**
+ * Address complement.
+ */
+complement?: string
+/**
+ * Reference for location.
+ */
+reference?: string
+/**
+ * Geographic coordinates (latitude, longitude).
+ */
+geoCoordinates?: number[]
+}
+})
+/**
+ * Customer additional information.
+ */
+customData?: (null | {
+
+})
+/**
+ * Item metadata.
+ */
+itemMetadata?: {
+/**
+ * List of objects containing metadata on each item in the order.
+ */
+items?: {
+/**
+ * Item ID.
+ */
+id?: string
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+}[]
+}
+/**
+ * Hooks information.
+ */
+hooksData?: (null | {
+
+})
+/**
+ * Information on rates and benefits that apply to the order.
+ */
+ratesAndBenefitsData?: {
+/**
+ * List with rates and benefits identifiers.
+ */
+rateAndBenefitsIdentifiers?: string[]
+/**
+ * List with rates and benefits teasers.
+ */
+teaser?: string[]
+}
+/**
+ * Subscription information.
+ */
+subscriptionData?: (null | {
+
+})
+/**
+ * Object containing information about the ordering of items within the `orderForm`.
+ */
+itemsOrdination?: {
+/**
+ * Criteria adopted to order the items in the list.
+ */
+criteria?: string
+/**
+ * Indicates whether the ordering is ascending.
+ */
+ascending?: boolean
+}
+}
+}
+/**
+ * Retrieves 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | Checkout | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"GET /api/checkout/pub/orderForm/:orderFormId": {
+searchParams: {
+/**
+ * It is possible to use the [Update cart items request](https://developers.vtex.com/vtex-rest-api/reference/cart-update#itemsupdate) so as to allow outdated information in the `orderForm`, which may improve performance in some cases. To guarantee that all cart information is updated, send this request with this parameter as `true`. We recommend doing this in the final stages of the shopping experience, starting from the checkout page.
+ */
+refreshOutdatedData?: boolean
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+response: {
+/**
+ * ID of the orderForm corresponding to a specific cart.
+ */
+orderFormId?: string
+/**
+ * Attribute created by the seller, in their VTEX store configuration.
+ */
+salesChannel?: string
+/**
+ * Indicates whether the user is logged into the store.
+ */
+loggedIn?: boolean
+/**
+ * Indicates whether order is checked in.
+ */
+isCheckedIn?: boolean
+/**
+ * ID of the store.
+ */
+storeId?: (null | string)
+/**
+ * Permission to modify item price manually.
+ */
+allowManualPrice?: boolean
+/**
+ * Data can be edited.
+ */
+canEditData?: boolean
+/**
+ * Unique ID associated with the customer profile.
+ */
+userProfileId?: string
+/**
+ * Profile provider.
+ */
+profileProvider?: string
+/**
+ * Available accounts.
+ */
+availableAccounts?: string[]
+/**
+ * Information on each available address.
+ */
+availableAddresses?: {
+/**
+ * Address type.
+ */
+addressType?: string
+/**
+ * Name of the receiver.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * City of the address.
+ */
+city?: string
+/**
+ * State of the address.
+ */
+state?: string
+/**
+ * Country of the address. ISO three-letter code.
+ */
+country?: string
+/**
+ * Street of the address.
+ */
+street?: string
+/**
+ * Number of the address.
+ */
+number?: string
+/**
+ * Neighborhood of the address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Reference that may help in the location of the address.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * User type.
+ */
+userType?: (null | string)
+/**
+ * Ignore customer profile data.
+ */
+ignoreProfileData?: boolean
+/**
+ * Total value of the order without separating cents. For example, $24.99 is represented as `2499`.
+ */
+value?: number
+/**
+ * Array containing an object for each message generated by our servers while processing the request.
+ */
+messages?: string[]
+/**
+ * Information on each item in the order.
+ */
+items?: {
+/**
+ * Unique ID.
+ */
+uniqueId?: string
+/**
+ * ID of the item.
+ */
+id?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Product Ref ID.
+ */
+productRefId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Modal type.
+ */
+modalType?: (null | string)
+/**
+ * Parent item index.
+ */
+parentItemIndex?: (null | number)
+/**
+ * Parent assembly binding.
+ */
+parentAssemblyBinding?: (null | string)
+/**
+ * Price expiration date and time.
+ */
+priceValidUntil?: string
+/**
+ * Tax value in cents.
+ */
+tax?: number
+/**
+ * A unique identifier code assigned to a tax within the VTEX Admin.
+ */
+taxCode?: string
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Manual price in cents.
+ */
+manualPrice?: (null | number)
+/**
+ * User that applied the manual price, if that is the case.
+ */
+manualPriceAppliedBy?: (null | string)
+/**
+ * Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
+ */
+sellingPrice?: number
+/**
+ * Reward value in cents.
+ */
+rewardValue?: number
+/**
+ * Indicates whether item is a gift.
+ */
+isGift?: boolean
+/**
+ * Additional information.
+ */
+additionalInfo?: {
+/**
+ * Dimension.
+ */
+dimension?: (null | string)
+/**
+ * Brand name.
+ */
+brandName?: string
+/**
+ * Brand ID.
+ */
+brandId?: string
+/**
+ * Offering information.
+ */
+offeringInfo?: (null | string)
+/**
+ * Offering type.
+ */
+offeringType?: (null | string)
+/**
+ * Offering type ID.
+ */
+offeringTypeId?: (null | string)
+}
+/**
+ * Presale date.
+ */
+preSaleDate?: (null | string)
+/**
+ * Product category IDs.
+ */
+productCategoryIds?: string
+/**
+ * Object, where each field is an ID from `productCategoryIds`.
+ */
+productCategories?: {
+/**
+ * Product category corresponding to the ID in the field key.
+ */
+"{ID}"?: string
+}
+/**
+ * Quantity.
+ */
+quantity?: number
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
+ */
+sellerChain?: string[]
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+/**
+ * Information on services sold along with the SKU. Example: a gift package.
+ */
+bundleItems?: {
+/**
+ * Service type.
+ */
+type?: string
+/**
+ * Service identifier.
+ */
+id?: number
+/**
+ * Service name.
+ */
+name?: string
+/**
+ * Service price in cents.
+ */
+price?: number
+}[]
+/**
+ * Array containing information on attachments.
+ */
+attachments?: string[]
+/**
+ * Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.
+ */
+priceTags?: {
+/**
+ * Promotion unique identifier.
+ */
+identifier?: (null | string)
+/**
+ * Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.
+ */
+isPercentual?: boolean
+/**
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
+ * - `calculationId` is a hash that may vary with each price calculation.
+ */
+name?: string
+/**
+ * Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.
+ */
+rawValue?: number
+/**
+ * Price tag value representing either a promotion (value decrease) or a tax (value increase).
+ */
+value?: number
+}[]
+/**
+ * Availability.
+ */
+availability?: string
+/**
+ * Measurement unit.
+ */
+measurementUnit?: string
+/**
+ * Unit multiplier.
+ */
+unitMultiplier?: number
+/**
+ * Manufacturer code.
+ */
+manufacturerCode?: (null | string)
+/**
+ * Price information for all units of a specific item.
+ */
+priceDefinition?: {
+/**
+ * Item's calculated unitary selling price in cents.
+ */
+calculatedSellingPrice?: number
+/**
+ * Total value for all units of the item in cents.
+ */
+total?: number
+/**
+ * Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
+ */
+sellingPrices?: {
+/**
+ * Value in cents for that specific rounding.
+ */
+value?: number
+/**
+ * Rounding quantity, meaning how many items are rounded to this value.
+ */
+quantity?: number
+}[]
+}
+}[]
+/**
+ * Array containing the data of the item selected as a gift.
+ */
+selectableGifts?: string[]
+/**
+ * Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).
+ */
+totalizers?: {
+
+}[]
+/**
+ * Shipping information pertinent to the order.
+ */
+shippingData?: (null | {
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.
+ */
+logisticsInfo?: {
+/**
+ * Index corresponding to the position of the object in the `items` array.
+ */
+itemIndex?: number
+/**
+ * SLA selected by the customer.
+ */
+selectedSla?: (null | string)
+/**
+ * Delivery channel selected by the customer.
+ */
+selectedDeliveryChannel?: (null | string)
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Information on available SLAs.
+ */
+slas?: {
+/**
+ * SLA ID.
+ */
+id?: string
+/**
+ * Delivery channel.
+ */
+deliveryChannel?: string
+/**
+ * SLA name.
+ */
+name?: string
+/**
+ * Information on each delivery ID.
+ */
+deliveryIds?: {
+/**
+ * Courier ID.
+ */
+courierId?: string
+/**
+ * Warehouse ID.
+ */
+warehouseId?: string
+/**
+ * Warehouse ID.
+ */
+dockId?: string
+/**
+ * Courier name.
+ */
+courierName?: string
+/**
+ * Quantity.
+ */
+quantity?: number
+}[]
+/**
+ * List of attachments details.
+ */
+attachmentOfferings?: (null | {
+/**
+ * Name of the attachment.
+ */
+name: (null | string)
+/**
+ * Defines if the attachment is required (`true`) or not (`false`).
+ */
+required: (null | boolean)
+/**
+ * Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).
+ */
+schema: (null | {
+
+})
+}[])
+/**
+ * Shipping estimate. For instance, "three business days" will be represented as `3bd`.
+ */
+shippingEstimate?: string
+/**
+ * When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.
+ */
+shippingEstimateDate?: (null | string)
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+useIndividualShippingEstimates?: boolean
+/**
+ * Estimate date of delivery.
+ */
+lockTTL?: (null | string)
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Tax in cents.
+ */
+tax?: number
+/**
+ * Information on the pickup store.
+ */
+pickupStoreInfo?: {
+/**
+ * Indicates whether it is the pickup store.
+ */
+isPickupStore?: boolean
+/**
+ * Friendly name.
+ */
+friendlyName?: (null | string)
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that repesent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Additional information.
+ */
+additionalInfo?: (null | string)
+/**
+ * Corresponding dock ID.
+ */
+dockId?: (null | string)
+}
+/**
+ * Pickup point ID.
+ */
+pickupPointId?: (null | string)
+/**
+ * Pickup point distance.
+ */
+pickupDistance?: number
+/**
+ * Polygon name.
+ */
+polygonName?: (null | string)
+/**
+ * Transit time. For instance, "three business days" is represented as `3bd`.
+ */
+transitTime?: string
+}[]
+/**
+ * List of countries that the item may be shipped to.
+ */
+shipsTo?: string[]
+/**
+ * Item ID.
+ */
+itemId?: string
+/**
+ * List of available delivery channels.
+ */
+deliveryChannels?: {
+/**
+ * Delivery channel ID.
+ */
+id?: string
+}[]
+}[]
+/**
+ * Array with information on the selected addresses for the order.
+ */
+selectedAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * Array with information on the available addresses for the order.
+ */
+availableAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+})
+/**
+ * Customer's profile information.
+ */
+clientProfileData?: (null | {
+/**
+ * Email address.
+ */
+email?: (null | string)
+/**
+ * First name.
+ */
+firstName?: (null | string)
+/**
+ * Last name.
+ */
+lastName?: string
+/**
+ * Type of the document informed by the customer.
+ */
+documentType?: string
+/**
+ * Document informed by the customer.
+ */
+document?: string
+/**
+ * Phone number.
+ */
+phone?: string
+/**
+ * Company name, if the customer is a legal entity.
+ */
+corporateName?: (null | string)
+/**
+ * Trade name, if the customer is a legal entity.
+ */
+tradeName?: (null | string)
+/**
+ * Corporate document, if the customer is a legal entity.
+ */
+corporateDocument?: (null | string)
+/**
+ * State inscription, if the customer is a legal entity.
+ */
+stateInscription?: (null | string)
+/**
+ * Corporate phone number, if the customer is a legal entity.
+ */
+corporatePhone?: (null | string)
+/**
+ * Indicates whether the customer is a legal entity.
+ */
+isCorporate?: boolean
+/**
+ * Indicates whether profile is complete on loading.
+ */
+profileCompleteOnLoading?: boolean
+/**
+ * Indicates whether profile presents error on loading.
+ */
+profileErrorOnLoading?: (null | boolean)
+/**
+ * Customer class.
+ */
+customerClass?: (null | string)
+})
+/**
+ * Information on the order's payment.
+ */
+paymentData?: {
+/**
+ * Gift card information, if it applies to the order.
+ */
+giftCards?: {
+/**
+ * Gift card redemption code.
+ */
+redemptionCode?: string
+/**
+ * Gift card value in cents.
+ */
+value?: number
+/**
+ * Gift card balance in cents.
+ */
+balance?: number
+/**
+ * Gift card name.
+ */
+name?: string
+/**
+ * Gift card ID.
+ */
+id?: string
+/**
+ * Indicates whether gift card is in use.
+ */
+inUse?: boolean
+/**
+ * Indicates whether gift card is special.
+ */
+isSpecialCard?: boolean
+}[]
+/**
+ * Information on each transaction pertinent to the order.
+ */
+transactions?: (null | {
+/**
+ * Indicates whether transaction is active.
+ */
+isActive?: boolean
+/**
+ * Transaction ID.
+ */
+transactionId?: string
+/**
+ * Merchant name.
+ */
+merchantName?: string
+/**
+ * Information on each payment.
+ */
+payments?: {
+/**
+ * Account ID.
+ */
+accountId?: string
+/**
+ * Bin.
+ */
+bin?: (null | string)
+/**
+ * Number of installments.
+ */
+installments?: number
+/**
+ * Payment system.
+ */
+paymentSystem?: string
+/**
+ * Reference value for calculating interest rates, in case it applies. Displayed in cents.
+ */
+referenceValue?: number
+/**
+ * Value including interest, in case it applies. Displayed in cents.
+ */
+value?: number
+}[]
+/**
+ * Indicates whather transaction is shared.
+ */
+sharedTransaction?: boolean
+})[]
+}
+/**
+ * Object containing promotion data such as coupon tracking information and internal or external UTMs.
+ */
+marketingData?: (null | {
+/**
+ * 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.
+ */
+coupon?: string
+/**
+ * UTM source.
+ */
+utmSource?: string
+/**
+ * UTM medium.
+ */
+utmMedium?: string
+/**
+ * UTM campaign.
+ */
+utmCampaign?: string
+/**
+ * utmi_page (internal utm).
+ */
+utmiPage?: (null | string)
+/**
+ * utmi_part (internal utm).
+ */
+utmiPart?: (null | string)
+/**
+ * utmi_campaign (internal utm).
+ */
+utmiCampaign?: (null | string)
+})
+/**
+ * Information on each seller.
+ */
+sellers?: {
+/**
+ * Seller ID.
+ */
+id?: string
+/**
+ * Seller name.
+ */
+name?: string
+/**
+ * Seller logo.
+ */
+logo?: (null | string)
+}[]
+/**
+ * Object containing preferences from the client who placed the order.
+ */
+clientPreferencesData?: {
+/**
+ * Client's locale. Examples: `pt-BR` and `en-US`.
+ */
+locale?: string
+/**
+ * `true` if the client opted to receive newsletter from the store.
+ */
+optinNewsLetter?: (null | boolean)
+}
+/**
+ * Object containing commercial condition information.
+ */
+commercialConditionData?: (null | {
+
+})
+/**
+ * Object containing data from the store's configuration (stored in VTEX's License Manager).
+ */
+storePreferencesData?: {
+
+}
+/**
+ * Gift registry list information.
+ */
+giftRegistryData?: (null | {
+
+})
+/**
+ * Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).
+ */
+openTextField?: (null | string)
+/**
+ * Invoice data including billing address.
+ */
+invoiceData?: (null | {
+/**
+ * Billing address.
+ */
+address?: {
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City name.
+ */
+city?: string
+/**
+ * State name.
+ */
+state?: string
+/**
+ * Country.
+ */
+country?: string
+/**
+ * Street name.
+ */
+street?: string
+/**
+ * Street number.
+ */
+number?: string
+/**
+ * Neighborhood.
+ */
+neighborhood?: string
+/**
+ * Address complement.
+ */
+complement?: string
+/**
+ * Reference for location.
+ */
+reference?: string
+/**
+ * Geographic coordinates (latitude, longitude).
+ */
+geoCoordinates?: number[]
+}
+})
+/**
+ * Customer additional information.
+ */
+customData?: (null | {
+
+})
+/**
+ * Item metadata.
+ */
+itemMetadata?: {
+/**
+ * List of objects containing metadata on each item in the order.
+ */
+items?: {
+/**
+ * Item ID.
+ */
+id?: string
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+}[]
+}
+/**
+ * Hooks information.
+ */
+hooksData?: (null | {
+
+})
+/**
+ * Information on rates and benefits that apply to the order.
+ */
+ratesAndBenefitsData?: {
+/**
+ * List with rates and benefits identifiers.
+ */
+rateAndBenefitsIdentifiers?: string[]
+/**
+ * List with rates and benefits teasers.
+ */
+teaser?: string[]
+}
+/**
+ * Subscription information.
+ */
+subscriptionData?: (null | {
+
+})
+/**
+ * Object containing information about the ordering of items within the `orderForm`.
+ */
+itemsOrdination?: {
+/**
+ * Criteria adopted to order the items in the list.
+ */
+criteria?: string
+/**
+ * Indicates whether the ordering is ascending.
+ */
+ascending?: 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.
+ * 
+ * >ℹ️ Request body must always be sent with empty value "{ }" in this endpoint.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Shopping Cart Full Access** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"POST /api/checkout/pub/orderForm/:orderFormId/items/removeAll": {
+searchParams: {
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+/**
+ * This object must be empty.
+ */
+body: {
+
+}
+response: {
+/**
+ * ID of the orderForm corresponding to a specific cart.
+ */
+orderFormId?: string
+/**
+ * Attribute created by the seller, in their VTEX store configuration.
+ */
+salesChannel?: string
+/**
+ * Indicates whether the user is logged into the store.
+ */
+loggedIn?: boolean
+/**
+ * Indicates whether order is checked in.
+ */
+isCheckedIn?: boolean
+/**
+ * ID of the store.
+ */
+storeId?: (null | string)
+/**
+ * Permission to modify item price manually.
+ */
+allowManualPrice?: boolean
+/**
+ * Data can be edited.
+ */
+canEditData?: boolean
+/**
+ * Unique ID associated with the customer profile.
+ */
+userProfileId?: string
+/**
+ * Profile provider.
+ */
+profileProvider?: string
+/**
+ * Available accounts.
+ */
+availableAccounts?: string[]
+/**
+ * Information on each available address.
+ */
+availableAddresses?: {
+/**
+ * Address type.
+ */
+addressType?: string
+/**
+ * Name of the receiver.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * City of the address.
+ */
+city?: string
+/**
+ * State of the address.
+ */
+state?: string
+/**
+ * Country of the address. ISO three-letter code.
+ */
+country?: string
+/**
+ * Street of the address.
+ */
+street?: string
+/**
+ * Number of the address.
+ */
+number?: string
+/**
+ * Neighborhood of the address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Reference that may help in the location of the address.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * User type.
+ */
+userType?: (null | string)
+/**
+ * Ignore customer profile data.
+ */
+ignoreProfileData?: boolean
+/**
+ * Total value of the order without separating cents. For example, $24.99 is represented as `2499`.
+ */
+value?: number
+/**
+ * Array containing an object for each message generated by our servers while processing the request.
+ */
+messages?: string[]
+/**
+ * Information on each item in the order.
+ */
+items?: {
+/**
+ * Unique ID.
+ */
+uniqueId?: string
+/**
+ * ID of the item.
+ */
+id?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Product Ref ID.
+ */
+productRefId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Modal type.
+ */
+modalType?: (null | string)
+/**
+ * Parent item index.
+ */
+parentItemIndex?: (null | number)
+/**
+ * Parent assembly binding.
+ */
+parentAssemblyBinding?: (null | string)
+/**
+ * Price expiration date and time.
+ */
+priceValidUntil?: string
+/**
+ * Tax value in cents.
+ */
+tax?: number
+/**
+ * A unique identifier code assigned to a tax within the VTEX Admin.
+ */
+taxCode?: string
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Manual price in cents.
+ */
+manualPrice?: (null | number)
+/**
+ * User that applied the manual price, if that is the case.
+ */
+manualPriceAppliedBy?: (null | string)
+/**
+ * Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
+ */
+sellingPrice?: number
+/**
+ * Reward value in cents.
+ */
+rewardValue?: number
+/**
+ * Indicates whether item is a gift.
+ */
+isGift?: boolean
+/**
+ * Additional information.
+ */
+additionalInfo?: {
+/**
+ * Dimension.
+ */
+dimension?: (null | string)
+/**
+ * Brand name.
+ */
+brandName?: string
+/**
+ * Brand ID.
+ */
+brandId?: string
+/**
+ * Offering information.
+ */
+offeringInfo?: (null | string)
+/**
+ * Offering type.
+ */
+offeringType?: (null | string)
+/**
+ * Offering type ID.
+ */
+offeringTypeId?: (null | string)
+}
+/**
+ * Presale date.
+ */
+preSaleDate?: (null | string)
+/**
+ * Product category IDs.
+ */
+productCategoryIds?: string
+/**
+ * Object, where each field is an ID from `productCategoryIds`.
+ */
+productCategories?: {
+/**
+ * Product category corresponding to the ID in the field key.
+ */
+"{ID}"?: string
+}
+/**
+ * Quantity.
+ */
+quantity?: number
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
+ */
+sellerChain?: string[]
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+/**
+ * Information on services sold along with the SKU. Example: a gift package.
+ */
+bundleItems?: {
+/**
+ * Service type.
+ */
+type?: string
+/**
+ * Service identifier.
+ */
+id?: number
+/**
+ * Service name.
+ */
+name?: string
+/**
+ * Service price in cents.
+ */
+price?: number
+}[]
+/**
+ * Array containing information on attachments.
+ */
+attachments?: string[]
+/**
+ * Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.
+ */
+priceTags?: {
+/**
+ * Promotion unique identifier.
+ */
+identifier?: (null | string)
+/**
+ * Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.
+ */
+isPercentual?: boolean
+/**
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
+ * - `calculationId` is a hash that may vary with each price calculation.
+ */
+name?: string
+/**
+ * Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.
+ */
+rawValue?: number
+/**
+ * Price tag value representing either a promotion (value decrease) or a tax (value increase).
+ */
+value?: number
+}[]
+/**
+ * Availability.
+ */
+availability?: string
+/**
+ * Measurement unit.
+ */
+measurementUnit?: string
+/**
+ * Unit multiplier.
+ */
+unitMultiplier?: number
+/**
+ * Manufacturer code.
+ */
+manufacturerCode?: (null | string)
+/**
+ * Price information for all units of a specific item.
+ */
+priceDefinition?: {
+/**
+ * Item's calculated unitary selling price in cents.
+ */
+calculatedSellingPrice?: number
+/**
+ * Total value for all units of the item in cents.
+ */
+total?: number
+/**
+ * Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
+ */
+sellingPrices?: {
+/**
+ * Value in cents for that specific rounding.
+ */
+value?: number
+/**
+ * Rounding quantity, meaning how many items are rounded to this value.
+ */
+quantity?: number
+}[]
+}
+}[]
+/**
+ * Array containing the data of the item selected as a gift.
+ */
+selectableGifts?: string[]
+/**
+ * Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).
+ */
+totalizers?: {
+
+}[]
+/**
+ * Shipping information pertinent to the order.
+ */
+shippingData?: (null | {
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.
+ */
+logisticsInfo?: {
+/**
+ * Index corresponding to the position of the object in the `items` array.
+ */
+itemIndex?: number
+/**
+ * SLA selected by the customer.
+ */
+selectedSla?: (null | string)
+/**
+ * Delivery channel selected by the customer.
+ */
+selectedDeliveryChannel?: (null | string)
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Information on available SLAs.
+ */
+slas?: {
+/**
+ * SLA ID.
+ */
+id?: string
+/**
+ * Delivery channel.
+ */
+deliveryChannel?: string
+/**
+ * SLA name.
+ */
+name?: string
+/**
+ * Information on each delivery ID.
+ */
+deliveryIds?: {
+/**
+ * Courier ID.
+ */
+courierId?: string
+/**
+ * Warehouse ID.
+ */
+warehouseId?: string
+/**
+ * Warehouse ID.
+ */
+dockId?: string
+/**
+ * Courier name.
+ */
+courierName?: string
+/**
+ * Quantity.
+ */
+quantity?: number
+}[]
+/**
+ * List of attachments details.
+ */
+attachmentOfferings?: (null | {
+/**
+ * Name of the attachment.
+ */
+name: (null | string)
+/**
+ * Defines if the attachment is required (`true`) or not (`false`).
+ */
+required: (null | boolean)
+/**
+ * Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).
+ */
+schema: (null | {
+
+})
+}[])
+/**
+ * Shipping estimate. For instance, "three business days" will be represented as `3bd`.
+ */
+shippingEstimate?: string
+/**
+ * When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.
+ */
+shippingEstimateDate?: (null | string)
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+useIndividualShippingEstimates?: boolean
+/**
+ * Estimate date of delivery.
+ */
+lockTTL?: (null | string)
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Tax in cents.
+ */
+tax?: number
+/**
+ * Information on the pickup store.
+ */
+pickupStoreInfo?: {
+/**
+ * Indicates whether it is the pickup store.
+ */
+isPickupStore?: boolean
+/**
+ * Friendly name.
+ */
+friendlyName?: (null | string)
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that repesent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Additional information.
+ */
+additionalInfo?: (null | string)
+/**
+ * Corresponding dock ID.
+ */
+dockId?: (null | string)
+}
+/**
+ * Pickup point ID.
+ */
+pickupPointId?: (null | string)
+/**
+ * Pickup point distance.
+ */
+pickupDistance?: number
+/**
+ * Polygon name.
+ */
+polygonName?: (null | string)
+/**
+ * Transit time. For instance, "three business days" is represented as `3bd`.
+ */
+transitTime?: string
+}[]
+/**
+ * List of countries that the item may be shipped to.
+ */
+shipsTo?: string[]
+/**
+ * Item ID.
+ */
+itemId?: string
+/**
+ * List of available delivery channels.
+ */
+deliveryChannels?: {
+/**
+ * Delivery channel ID.
+ */
+id?: string
+}[]
+}[]
+/**
+ * Array with information on the selected addresses for the order.
+ */
+selectedAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * Array with information on the available addresses for the order.
+ */
+availableAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+})
+/**
+ * Customer's profile information.
+ */
+clientProfileData?: (null | {
+/**
+ * Email address.
+ */
+email?: (null | string)
+/**
+ * First name.
+ */
+firstName?: (null | string)
+/**
+ * Last name.
+ */
+lastName?: string
+/**
+ * Type of the document informed by the customer.
+ */
+documentType?: string
+/**
+ * Document informed by the customer.
+ */
+document?: string
+/**
+ * Phone number.
+ */
+phone?: string
+/**
+ * Company name, if the customer is a legal entity.
+ */
+corporateName?: (null | string)
+/**
+ * Trade name, if the customer is a legal entity.
+ */
+tradeName?: (null | string)
+/**
+ * Corporate document, if the customer is a legal entity.
+ */
+corporateDocument?: (null | string)
+/**
+ * State inscription, if the customer is a legal entity.
+ */
+stateInscription?: (null | string)
+/**
+ * Corporate phone number, if the customer is a legal entity.
+ */
+corporatePhone?: (null | string)
+/**
+ * Indicates whether the customer is a legal entity.
+ */
+isCorporate?: boolean
+/**
+ * Indicates whether profile is complete on loading.
+ */
+profileCompleteOnLoading?: boolean
+/**
+ * Indicates whether profile presents error on loading.
+ */
+profileErrorOnLoading?: (null | boolean)
+/**
+ * Customer class.
+ */
+customerClass?: (null | string)
+})
+/**
+ * Information on the order's payment.
+ */
+paymentData?: {
+/**
+ * Gift card information, if it applies to the order.
+ */
+giftCards?: {
+/**
+ * Gift card redemption code.
+ */
+redemptionCode?: string
+/**
+ * Gift card value in cents.
+ */
+value?: number
+/**
+ * Gift card balance in cents.
+ */
+balance?: number
+/**
+ * Gift card name.
+ */
+name?: string
+/**
+ * Gift card ID.
+ */
+id?: string
+/**
+ * Indicates whether gift card is in use.
+ */
+inUse?: boolean
+/**
+ * Indicates whether gift card is special.
+ */
+isSpecialCard?: boolean
+}[]
+/**
+ * Information on each transaction pertinent to the order.
+ */
+transactions?: (null | {
+/**
+ * Indicates whether transaction is active.
+ */
+isActive?: boolean
+/**
+ * Transaction ID.
+ */
+transactionId?: string
+/**
+ * Merchant name.
+ */
+merchantName?: string
+/**
+ * Information on each payment.
+ */
+payments?: {
+/**
+ * Account ID.
+ */
+accountId?: string
+/**
+ * Bin.
+ */
+bin?: (null | string)
+/**
+ * Number of installments.
+ */
+installments?: number
+/**
+ * Payment system.
+ */
+paymentSystem?: string
+/**
+ * Reference value for calculating interest rates, in case it applies. Displayed in cents.
+ */
+referenceValue?: number
+/**
+ * Value including interest, in case it applies. Displayed in cents.
+ */
+value?: number
+}[]
+/**
+ * Indicates whather transaction is shared.
+ */
+sharedTransaction?: boolean
+})[]
+}
+/**
+ * Object containing promotion data such as coupon tracking information and internal or external UTMs.
+ */
+marketingData?: (null | {
+/**
+ * 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.
+ */
+coupon?: string
+/**
+ * UTM source.
+ */
+utmSource?: string
+/**
+ * UTM medium.
+ */
+utmMedium?: string
+/**
+ * UTM campaign.
+ */
+utmCampaign?: string
+/**
+ * utmi_page (internal utm).
+ */
+utmiPage?: (null | string)
+/**
+ * utmi_part (internal utm).
+ */
+utmiPart?: (null | string)
+/**
+ * utmi_campaign (internal utm).
+ */
+utmiCampaign?: (null | string)
+})
+/**
+ * Information on each seller.
+ */
+sellers?: {
+/**
+ * Seller ID.
+ */
+id?: string
+/**
+ * Seller name.
+ */
+name?: string
+/**
+ * Seller logo.
+ */
+logo?: (null | string)
+}[]
+/**
+ * Object containing preferences from the client who placed the order.
+ */
+clientPreferencesData?: {
+/**
+ * Client's locale. Examples: `pt-BR` and `en-US`.
+ */
+locale?: string
+/**
+ * `true` if the client opted to receive newsletter from the store.
+ */
+optinNewsLetter?: (null | boolean)
+}
+/**
+ * Object containing commercial condition information.
+ */
+commercialConditionData?: (null | {
+
+})
+/**
+ * Object containing data from the store's configuration (stored in VTEX's License Manager).
+ */
+storePreferencesData?: {
+
+}
+/**
+ * Gift registry list information.
+ */
+giftRegistryData?: (null | {
+
+})
+/**
+ * Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).
+ */
+openTextField?: (null | string)
+/**
+ * Invoice data including billing address.
+ */
+invoiceData?: (null | {
+/**
+ * Billing address.
+ */
+address?: {
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City name.
+ */
+city?: string
+/**
+ * State name.
+ */
+state?: string
+/**
+ * Country.
+ */
+country?: string
+/**
+ * Street name.
+ */
+street?: string
+/**
+ * Street number.
+ */
+number?: string
+/**
+ * Neighborhood.
+ */
+neighborhood?: string
+/**
+ * Address complement.
+ */
+complement?: string
+/**
+ * Reference for location.
+ */
+reference?: string
+/**
+ * Geographic coordinates (latitude, longitude).
+ */
+geoCoordinates?: number[]
+}
+})
+/**
+ * Customer additional information.
+ */
+customData?: (null | {
+
+})
+/**
+ * Item metadata.
+ */
+itemMetadata?: {
+/**
+ * List of objects containing metadata on each item in the order.
+ */
+items?: {
+/**
+ * Item ID.
+ */
+id?: string
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+}[]
+}
+/**
+ * Hooks information.
+ */
+hooksData?: (null | {
+
+})
+/**
+ * Information on rates and benefits that apply to the order.
+ */
+ratesAndBenefitsData?: {
+/**
+ * List with rates and benefits identifiers.
+ */
+rateAndBenefitsIdentifiers?: string[]
+/**
+ * List with rates and benefits teasers.
+ */
+teaser?: string[]
+}
+/**
+ * Subscription information.
+ */
+subscriptionData?: (null | {
+
+})
+/**
+ * Object containing information about the ordering of items within the `orderForm`.
+ */
+itemsOrdination?: {
+/**
+ * Criteria adopted to order the items in the list.
+ */
+criteria?: string
+/**
+ * Indicates whether the ordering is ascending.
+ */
+ascending?: boolean
+}
+}
+}
+/**
+ * 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`).
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Save OrderForm Configuration** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"GET /checkout/changeToAnonymousUser/:orderFormId": {
+searchParams: {
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+}
+/**
+ * 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).
+ * 
+ * >ℹ️ To remove all items from the cart at the same time, use the [Remove all items](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pub/orderForm/-orderFormId-/items/removeAll?endpoint=post-/api/checkout/pub/orderForm/-orderFormId-/items/removeAll) 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"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”`.
+ */
+allowedOutdatedData?: string[]
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+body: {
+/**
+ * Array containing the cart items. Each object inside this array corresponds to a different item.
+ */
+orderItems?: {
+/**
+ * The quantity of the item in the cart.
+ */
+quantity?: number
+/**
+ * The position of the item in the array.
+ */
+index?: number
+}[]
+}
+response: {
+/**
+ * ID of the orderForm corresponding to a specific cart.
+ */
+orderFormId?: string
+/**
+ * Attribute created by the seller, in their VTEX store configuration.
+ */
+salesChannel?: string
+/**
+ * Indicates whether the user is logged into the store.
+ */
+loggedIn?: boolean
+/**
+ * Indicates whether order is checked in.
+ */
+isCheckedIn?: boolean
+/**
+ * ID of the store.
+ */
+storeId?: (null | string)
+/**
+ * Permission to modify item price manually.
+ */
+allowManualPrice?: boolean
+/**
+ * Data can be edited.
+ */
+canEditData?: boolean
+/**
+ * Unique ID associated with the customer profile.
+ */
+userProfileId?: string
+/**
+ * Profile provider.
+ */
+profileProvider?: string
+/**
+ * Available accounts.
+ */
+availableAccounts?: string[]
+/**
+ * Information on each available address.
+ */
+availableAddresses?: {
+/**
+ * Address type.
+ */
+addressType?: string
+/**
+ * Name of the receiver.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * City of the address.
+ */
+city?: string
+/**
+ * State of the address.
+ */
+state?: string
+/**
+ * Country of the address. ISO three-letter code.
+ */
+country?: string
+/**
+ * Street of the address.
+ */
+street?: string
+/**
+ * Number of the address.
+ */
+number?: string
+/**
+ * Neighborhood of the address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Reference that may help in the location of the address.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * User type.
+ */
+userType?: (null | string)
+/**
+ * Ignore customer profile data.
+ */
+ignoreProfileData?: boolean
+/**
+ * Total value of the order without separating cents. For example, $24.99 is represented as `2499`.
+ */
+value?: number
+/**
+ * Array containing an object for each message generated by our servers while processing the request.
+ */
+messages?: string[]
+/**
+ * Information on each item in the order.
+ */
+items?: {
+/**
+ * Unique ID.
+ */
+uniqueId?: string
+/**
+ * ID of the item.
+ */
+id?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Product Ref ID.
+ */
+productRefId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Modal type.
+ */
+modalType?: (null | string)
+/**
+ * Parent item index.
+ */
+parentItemIndex?: (null | number)
+/**
+ * Parent assembly binding.
+ */
+parentAssemblyBinding?: (null | string)
+/**
+ * Price expiration date and time.
+ */
+priceValidUntil?: string
+/**
+ * Tax value in cents.
+ */
+tax?: number
+/**
+ * A unique identifier code assigned to a tax within the VTEX Admin.
+ */
+taxCode?: string
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Manual price in cents.
+ */
+manualPrice?: (null | number)
+/**
+ * User that applied the manual price, if that is the case.
+ */
+manualPriceAppliedBy?: (null | string)
+/**
+ * Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
+ */
+sellingPrice?: number
+/**
+ * Reward value in cents.
+ */
+rewardValue?: number
+/**
+ * Indicates whether item is a gift.
+ */
+isGift?: boolean
+/**
+ * Additional information.
+ */
+additionalInfo?: {
+/**
+ * Dimension.
+ */
+dimension?: (null | string)
+/**
+ * Brand name.
+ */
+brandName?: string
+/**
+ * Brand ID.
+ */
+brandId?: string
+/**
+ * Offering information.
+ */
+offeringInfo?: (null | string)
+/**
+ * Offering type.
+ */
+offeringType?: (null | string)
+/**
+ * Offering type ID.
+ */
+offeringTypeId?: (null | string)
+}
+/**
+ * Presale date.
+ */
+preSaleDate?: (null | string)
+/**
+ * Product category IDs.
+ */
+productCategoryIds?: string
+/**
+ * Object, where each field is an ID from `productCategoryIds`.
+ */
+productCategories?: {
+/**
+ * Product category corresponding to the ID in the field key.
+ */
+"{ID}"?: string
+}
+/**
+ * Quantity.
+ */
+quantity?: number
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
+ */
+sellerChain?: string[]
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+/**
+ * Information on services sold along with the SKU. Example: a gift package.
+ */
+bundleItems?: {
+/**
+ * Service type.
+ */
+type?: string
+/**
+ * Service identifier.
+ */
+id?: number
+/**
+ * Service name.
+ */
+name?: string
+/**
+ * Service price in cents.
+ */
+price?: number
+}[]
+/**
+ * Array containing information on attachments.
+ */
+attachments?: string[]
+/**
+ * Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.
+ */
+priceTags?: {
+/**
+ * Promotion unique identifier.
+ */
+identifier?: (null | string)
+/**
+ * Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.
+ */
+isPercentual?: boolean
+/**
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
+ * - `calculationId` is a hash that may vary with each price calculation.
+ */
+name?: string
+/**
+ * Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.
+ */
+rawValue?: number
+/**
+ * Price tag value representing either a promotion (value decrease) or a tax (value increase).
+ */
+value?: number
+}[]
+/**
+ * Availability.
+ */
+availability?: string
+/**
+ * Measurement unit.
+ */
+measurementUnit?: string
+/**
+ * Unit multiplier.
+ */
+unitMultiplier?: number
+/**
+ * Manufacturer code.
+ */
+manufacturerCode?: (null | string)
+/**
+ * Price information for all units of a specific item.
+ */
+priceDefinition?: {
+/**
+ * Item's calculated unitary selling price in cents.
+ */
+calculatedSellingPrice?: number
+/**
+ * Total value for all units of the item in cents.
+ */
+total?: number
+/**
+ * Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
+ */
+sellingPrices?: {
+/**
+ * Value in cents for that specific rounding.
+ */
+value?: number
+/**
+ * Rounding quantity, meaning how many items are rounded to this value.
+ */
+quantity?: number
+}[]
+}
+}[]
+/**
+ * Array containing the data of the item selected as a gift.
+ */
+selectableGifts?: string[]
+/**
+ * Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).
+ */
+totalizers?: {
+
+}[]
+/**
+ * Shipping information pertinent to the order.
+ */
+shippingData?: (null | {
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.
+ */
+logisticsInfo?: {
+/**
+ * Index corresponding to the position of the object in the `items` array.
+ */
+itemIndex?: number
+/**
+ * SLA selected by the customer.
+ */
+selectedSla?: (null | string)
+/**
+ * Delivery channel selected by the customer.
+ */
+selectedDeliveryChannel?: (null | string)
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Information on available SLAs.
+ */
+slas?: {
+/**
+ * SLA ID.
+ */
+id?: string
+/**
+ * Delivery channel.
+ */
+deliveryChannel?: string
+/**
+ * SLA name.
+ */
+name?: string
+/**
+ * Information on each delivery ID.
+ */
+deliveryIds?: {
+/**
+ * Courier ID.
+ */
+courierId?: string
+/**
+ * Warehouse ID.
+ */
+warehouseId?: string
+/**
+ * Warehouse ID.
+ */
+dockId?: string
+/**
+ * Courier name.
+ */
+courierName?: string
+/**
+ * Quantity.
+ */
+quantity?: number
+}[]
+/**
+ * List of attachments details.
+ */
+attachmentOfferings?: (null | {
+/**
+ * Name of the attachment.
+ */
+name: (null | string)
+/**
+ * Defines if the attachment is required (`true`) or not (`false`).
+ */
+required: (null | boolean)
+/**
+ * Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).
+ */
+schema: (null | {
+
+})
+}[])
+/**
+ * Shipping estimate. For instance, "three business days" will be represented as `3bd`.
+ */
+shippingEstimate?: string
+/**
+ * When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.
+ */
+shippingEstimateDate?: (null | string)
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+useIndividualShippingEstimates?: boolean
+/**
+ * Estimate date of delivery.
+ */
+lockTTL?: (null | string)
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Tax in cents.
+ */
+tax?: number
+/**
+ * Information on the pickup store.
+ */
+pickupStoreInfo?: {
+/**
+ * Indicates whether it is the pickup store.
+ */
+isPickupStore?: boolean
+/**
+ * Friendly name.
+ */
+friendlyName?: (null | string)
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that repesent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Additional information.
+ */
+additionalInfo?: (null | string)
+/**
+ * Corresponding dock ID.
+ */
+dockId?: (null | string)
+}
+/**
+ * Pickup point ID.
+ */
+pickupPointId?: (null | string)
+/**
+ * Pickup point distance.
+ */
+pickupDistance?: number
+/**
+ * Polygon name.
+ */
+polygonName?: (null | string)
+/**
+ * Transit time. For instance, "three business days" is represented as `3bd`.
+ */
+transitTime?: string
+}[]
+/**
+ * List of countries that the item may be shipped to.
+ */
+shipsTo?: string[]
+/**
+ * Item ID.
+ */
+itemId?: string
+/**
+ * List of available delivery channels.
+ */
+deliveryChannels?: {
+/**
+ * Delivery channel ID.
+ */
+id?: string
+}[]
+}[]
+/**
+ * Array with information on the selected addresses for the order.
+ */
+selectedAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * Array with information on the available addresses for the order.
+ */
+availableAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+})
+/**
+ * Customer's profile information.
+ */
+clientProfileData?: (null | {
+/**
+ * Email address.
+ */
+email?: (null | string)
+/**
+ * First name.
+ */
+firstName?: (null | string)
+/**
+ * Last name.
+ */
+lastName?: string
+/**
+ * Type of the document informed by the customer.
+ */
+documentType?: string
+/**
+ * Document informed by the customer.
+ */
+document?: string
+/**
+ * Phone number.
+ */
+phone?: string
+/**
+ * Company name, if the customer is a legal entity.
+ */
+corporateName?: (null | string)
+/**
+ * Trade name, if the customer is a legal entity.
+ */
+tradeName?: (null | string)
+/**
+ * Corporate document, if the customer is a legal entity.
+ */
+corporateDocument?: (null | string)
+/**
+ * State inscription, if the customer is a legal entity.
+ */
+stateInscription?: (null | string)
+/**
+ * Corporate phone number, if the customer is a legal entity.
+ */
+corporatePhone?: (null | string)
+/**
+ * Indicates whether the customer is a legal entity.
+ */
+isCorporate?: boolean
+/**
+ * Indicates whether profile is complete on loading.
+ */
+profileCompleteOnLoading?: boolean
+/**
+ * Indicates whether profile presents error on loading.
+ */
+profileErrorOnLoading?: (null | boolean)
+/**
+ * Customer class.
+ */
+customerClass?: (null | string)
+})
+/**
+ * Information on the order's payment.
+ */
+paymentData?: {
+/**
+ * Gift card information, if it applies to the order.
+ */
+giftCards?: {
+/**
+ * Gift card redemption code.
+ */
+redemptionCode?: string
+/**
+ * Gift card value in cents.
+ */
+value?: number
+/**
+ * Gift card balance in cents.
+ */
+balance?: number
+/**
+ * Gift card name.
+ */
+name?: string
+/**
+ * Gift card ID.
+ */
+id?: string
+/**
+ * Indicates whether gift card is in use.
+ */
+inUse?: boolean
+/**
+ * Indicates whether gift card is special.
+ */
+isSpecialCard?: boolean
+}[]
+/**
+ * Information on each transaction pertinent to the order.
+ */
+transactions?: (null | {
+/**
+ * Indicates whether transaction is active.
+ */
+isActive?: boolean
+/**
+ * Transaction ID.
+ */
+transactionId?: string
+/**
+ * Merchant name.
+ */
+merchantName?: string
+/**
+ * Information on each payment.
+ */
+payments?: {
+/**
+ * Account ID.
+ */
+accountId?: string
+/**
+ * Bin.
+ */
+bin?: (null | string)
+/**
+ * Number of installments.
+ */
+installments?: number
+/**
+ * Payment system.
+ */
+paymentSystem?: string
+/**
+ * Reference value for calculating interest rates, in case it applies. Displayed in cents.
+ */
+referenceValue?: number
+/**
+ * Value including interest, in case it applies. Displayed in cents.
+ */
+value?: number
+}[]
+/**
+ * Indicates whather transaction is shared.
+ */
+sharedTransaction?: boolean
+})[]
+}
+/**
+ * Object containing promotion data such as coupon tracking information and internal or external UTMs.
+ */
+marketingData?: (null | {
+/**
+ * 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.
+ */
+coupon?: string
+/**
+ * UTM source.
+ */
+utmSource?: string
+/**
+ * UTM medium.
+ */
+utmMedium?: string
+/**
+ * UTM campaign.
+ */
+utmCampaign?: string
+/**
+ * utmi_page (internal utm).
+ */
+utmiPage?: (null | string)
+/**
+ * utmi_part (internal utm).
+ */
+utmiPart?: (null | string)
+/**
+ * utmi_campaign (internal utm).
+ */
+utmiCampaign?: (null | string)
+})
+/**
+ * Information on each seller.
+ */
+sellers?: {
+/**
+ * Seller ID.
+ */
+id?: string
+/**
+ * Seller name.
+ */
+name?: string
+/**
+ * Seller logo.
+ */
+logo?: (null | string)
+}[]
+/**
+ * Object containing preferences from the client who placed the order.
+ */
+clientPreferencesData?: {
+/**
+ * Client's locale. Examples: `pt-BR` and `en-US`.
+ */
+locale?: string
+/**
+ * `true` if the client opted to receive newsletter from the store.
+ */
+optinNewsLetter?: (null | boolean)
+}
+/**
+ * Object containing commercial condition information.
+ */
+commercialConditionData?: (null | {
+
+})
+/**
+ * Object containing data from the store's configuration (stored in VTEX's License Manager).
+ */
+storePreferencesData?: {
+
+}
+/**
+ * Gift registry list information.
+ */
+giftRegistryData?: (null | {
+
+})
+/**
+ * Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).
+ */
+openTextField?: (null | string)
+/**
+ * Invoice data including billing address.
+ */
+invoiceData?: (null | {
+/**
+ * Billing address.
+ */
+address?: {
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City name.
+ */
+city?: string
+/**
+ * State name.
+ */
+state?: string
+/**
+ * Country.
+ */
+country?: string
+/**
+ * Street name.
+ */
+street?: string
+/**
+ * Street number.
+ */
+number?: string
+/**
+ * Neighborhood.
+ */
+neighborhood?: string
+/**
+ * Address complement.
+ */
+complement?: string
+/**
+ * Reference for location.
+ */
+reference?: string
+/**
+ * Geographic coordinates (latitude, longitude).
+ */
+geoCoordinates?: number[]
+}
+})
+/**
+ * Customer additional information.
+ */
+customData?: (null | {
+
+})
+/**
+ * Item metadata.
+ */
+itemMetadata?: {
+/**
+ * List of objects containing metadata on each item in the order.
+ */
+items?: {
+/**
+ * Item ID.
+ */
+id?: string
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+}[]
+}
+/**
+ * Hooks information.
+ */
+hooksData?: (null | {
+
+})
+/**
+ * Information on rates and benefits that apply to the order.
+ */
+ratesAndBenefitsData?: {
+/**
+ * List with rates and benefits identifiers.
+ */
+rateAndBenefitsIdentifiers?: string[]
+/**
+ * List with rates and benefits teasers.
+ */
+teaser?: string[]
+}
+/**
+ * Subscription information.
+ */
+subscriptionData?: (null | {
+
+})
+/**
+ * Object containing information about the ordering of items within the `orderForm`.
+ */
+itemsOrdination?: {
+/**
+ * Criteria adopted to order the items in the list.
+ */
+criteria?: string
+/**
+ * Indicates whether the ordering is ascending.
+ */
+ascending?: boolean
+}
+}
+}
+/**
+ * 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"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”`.
+ */
+allowedOutdatedData?: string[]
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+body: {
+/**
+ * Array containing the cart items. Each object inside this array corresponds to a different item.
+ */
+orderItems?: {
+/**
+ * The quantity of the item (SKU) in the cart.
+ */
+quantity: number
+/**
+ * The seller responsible for the SKU.
+ */
+seller: string
+/**
+ * The ID of the SKU in VTEX platform.
+ */
+id: string
+/**
+ * The position of the item in the array.
+ */
+index: number
+/**
+ * Price of the item in cents. Send this value in case you want to make a bulk price change.
+ */
+price?: number
+}[]
+}
+response: {
+/**
+ * ID of the orderForm corresponding to a specific cart.
+ */
+orderFormId?: string
+/**
+ * Attribute created by the seller, in their VTEX store configuration.
+ */
+salesChannel?: string
+/**
+ * Indicates whether the user is logged into the store.
+ */
+loggedIn?: boolean
+/**
+ * Indicates whether order is checked in.
+ */
+isCheckedIn?: boolean
+/**
+ * ID of the store.
+ */
+storeId?: (null | string)
+/**
+ * Permission to modify item price manually.
+ */
+allowManualPrice?: boolean
+/**
+ * Data can be edited.
+ */
+canEditData?: boolean
+/**
+ * Unique ID associated with the customer profile.
+ */
+userProfileId?: string
+/**
+ * Profile provider.
+ */
+profileProvider?: string
+/**
+ * Available accounts.
+ */
+availableAccounts?: string[]
+/**
+ * Information on each available address.
+ */
+availableAddresses?: {
+/**
+ * Address type.
+ */
+addressType?: string
+/**
+ * Name of the receiver.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * City of the address.
+ */
+city?: string
+/**
+ * State of the address.
+ */
+state?: string
+/**
+ * Country of the address. ISO three-letter code.
+ */
+country?: string
+/**
+ * Street of the address.
+ */
+street?: string
+/**
+ * Number of the address.
+ */
+number?: string
+/**
+ * Neighborhood of the address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Reference that may help in the location of the address.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * User type.
+ */
+userType?: (null | string)
+/**
+ * Ignore customer profile data.
+ */
+ignoreProfileData?: boolean
+/**
+ * Total value of the order without separating cents. For example, $24.99 is represented as `2499`.
+ */
+value?: number
+/**
+ * Array containing an object for each message generated by our servers while processing the request.
+ */
+messages?: string[]
+/**
+ * Information on each item in the order.
+ */
+items?: {
+/**
+ * Unique ID.
+ */
+uniqueId?: string
+/**
+ * ID of the item.
+ */
+id?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Product Ref ID.
+ */
+productRefId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Modal type.
+ */
+modalType?: (null | string)
+/**
+ * Parent item index.
+ */
+parentItemIndex?: (null | number)
+/**
+ * Parent assembly binding.
+ */
+parentAssemblyBinding?: (null | string)
+/**
+ * Price expiration date and time.
+ */
+priceValidUntil?: string
+/**
+ * Tax value in cents.
+ */
+tax?: number
+/**
+ * A unique identifier code assigned to a tax within the VTEX Admin.
+ */
+taxCode?: string
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Manual price in cents.
+ */
+manualPrice?: (null | number)
+/**
+ * User that applied the manual price, if that is the case.
+ */
+manualPriceAppliedBy?: (null | string)
+/**
+ * Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
+ */
+sellingPrice?: number
+/**
+ * Reward value in cents.
+ */
+rewardValue?: number
+/**
+ * Indicates whether item is a gift.
+ */
+isGift?: boolean
+/**
+ * Additional information.
+ */
+additionalInfo?: {
+/**
+ * Dimension.
+ */
+dimension?: (null | string)
+/**
+ * Brand name.
+ */
+brandName?: string
+/**
+ * Brand ID.
+ */
+brandId?: string
+/**
+ * Offering information.
+ */
+offeringInfo?: (null | string)
+/**
+ * Offering type.
+ */
+offeringType?: (null | string)
+/**
+ * Offering type ID.
+ */
+offeringTypeId?: (null | string)
+}
+/**
+ * Presale date.
+ */
+preSaleDate?: (null | string)
+/**
+ * Product category IDs.
+ */
+productCategoryIds?: string
+/**
+ * Object, where each field is an ID from `productCategoryIds`.
+ */
+productCategories?: {
+/**
+ * Product category corresponding to the ID in the field key.
+ */
+"{ID}"?: string
+}
+/**
+ * Quantity.
+ */
+quantity?: number
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
+ */
+sellerChain?: string[]
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+/**
+ * Information on services sold along with the SKU. Example: a gift package.
+ */
+bundleItems?: {
+/**
+ * Service type.
+ */
+type?: string
+/**
+ * Service identifier.
+ */
+id?: number
+/**
+ * Service name.
+ */
+name?: string
+/**
+ * Service price in cents.
+ */
+price?: number
+}[]
+/**
+ * Array containing information on attachments.
+ */
+attachments?: string[]
+/**
+ * Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.
+ */
+priceTags?: {
+/**
+ * Promotion unique identifier.
+ */
+identifier?: (null | string)
+/**
+ * Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.
+ */
+isPercentual?: boolean
+/**
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
+ * - `calculationId` is a hash that may vary with each price calculation.
+ */
+name?: string
+/**
+ * Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.
+ */
+rawValue?: number
+/**
+ * Price tag value representing either a promotion (value decrease) or a tax (value increase).
+ */
+value?: number
+}[]
+/**
+ * Availability.
+ */
+availability?: string
+/**
+ * Measurement unit.
+ */
+measurementUnit?: string
+/**
+ * Unit multiplier.
+ */
+unitMultiplier?: number
+/**
+ * Manufacturer code.
+ */
+manufacturerCode?: (null | string)
+/**
+ * Price information for all units of a specific item.
+ */
+priceDefinition?: {
+/**
+ * Item's calculated unitary selling price in cents.
+ */
+calculatedSellingPrice?: number
+/**
+ * Total value for all units of the item in cents.
+ */
+total?: number
+/**
+ * Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
+ */
+sellingPrices?: {
+/**
+ * Value in cents for that specific rounding.
+ */
+value?: number
+/**
+ * Rounding quantity, meaning how many items are rounded to this value.
+ */
+quantity?: number
+}[]
+}
+}[]
+/**
+ * Array containing the data of the item selected as a gift.
+ */
+selectableGifts?: string[]
+/**
+ * Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).
+ */
+totalizers?: {
+
+}[]
+/**
+ * Shipping information pertinent to the order.
+ */
+shippingData?: (null | {
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.
+ */
+logisticsInfo?: {
+/**
+ * Index corresponding to the position of the object in the `items` array.
+ */
+itemIndex?: number
+/**
+ * SLA selected by the customer.
+ */
+selectedSla?: (null | string)
+/**
+ * Delivery channel selected by the customer.
+ */
+selectedDeliveryChannel?: (null | string)
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Information on available SLAs.
+ */
+slas?: {
+/**
+ * SLA ID.
+ */
+id?: string
+/**
+ * Delivery channel.
+ */
+deliveryChannel?: string
+/**
+ * SLA name.
+ */
+name?: string
+/**
+ * Information on each delivery ID.
+ */
+deliveryIds?: {
+/**
+ * Courier ID.
+ */
+courierId?: string
+/**
+ * Warehouse ID.
+ */
+warehouseId?: string
+/**
+ * Warehouse ID.
+ */
+dockId?: string
+/**
+ * Courier name.
+ */
+courierName?: string
+/**
+ * Quantity.
+ */
+quantity?: number
+}[]
+/**
+ * List of attachments details.
+ */
+attachmentOfferings?: (null | {
+/**
+ * Name of the attachment.
+ */
+name: (null | string)
+/**
+ * Defines if the attachment is required (`true`) or not (`false`).
+ */
+required: (null | boolean)
+/**
+ * Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).
+ */
+schema: (null | {
+
+})
+}[])
+/**
+ * Shipping estimate. For instance, "three business days" will be represented as `3bd`.
+ */
+shippingEstimate?: string
+/**
+ * When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.
+ */
+shippingEstimateDate?: (null | string)
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+useIndividualShippingEstimates?: boolean
+/**
+ * Estimate date of delivery.
+ */
+lockTTL?: (null | string)
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Tax in cents.
+ */
+tax?: number
+/**
+ * Information on the pickup store.
+ */
+pickupStoreInfo?: {
+/**
+ * Indicates whether it is the pickup store.
+ */
+isPickupStore?: boolean
+/**
+ * Friendly name.
+ */
+friendlyName?: (null | string)
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that repesent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Additional information.
+ */
+additionalInfo?: (null | string)
+/**
+ * Corresponding dock ID.
+ */
+dockId?: (null | string)
+}
+/**
+ * Pickup point ID.
+ */
+pickupPointId?: (null | string)
+/**
+ * Pickup point distance.
+ */
+pickupDistance?: number
+/**
+ * Polygon name.
+ */
+polygonName?: (null | string)
+/**
+ * Transit time. For instance, "three business days" is represented as `3bd`.
+ */
+transitTime?: string
+}[]
+/**
+ * List of countries that the item may be shipped to.
+ */
+shipsTo?: string[]
+/**
+ * Item ID.
+ */
+itemId?: string
+/**
+ * List of available delivery channels.
+ */
+deliveryChannels?: {
+/**
+ * Delivery channel ID.
+ */
+id?: string
+}[]
+}[]
+/**
+ * Array with information on the selected addresses for the order.
+ */
+selectedAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * Array with information on the available addresses for the order.
+ */
+availableAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+})
+/**
+ * Customer's profile information.
+ */
+clientProfileData?: (null | {
+/**
+ * Email address.
+ */
+email?: (null | string)
+/**
+ * First name.
+ */
+firstName?: (null | string)
+/**
+ * Last name.
+ */
+lastName?: string
+/**
+ * Type of the document informed by the customer.
+ */
+documentType?: string
+/**
+ * Document informed by the customer.
+ */
+document?: string
+/**
+ * Phone number.
+ */
+phone?: string
+/**
+ * Company name, if the customer is a legal entity.
+ */
+corporateName?: (null | string)
+/**
+ * Trade name, if the customer is a legal entity.
+ */
+tradeName?: (null | string)
+/**
+ * Corporate document, if the customer is a legal entity.
+ */
+corporateDocument?: (null | string)
+/**
+ * State inscription, if the customer is a legal entity.
+ */
+stateInscription?: (null | string)
+/**
+ * Corporate phone number, if the customer is a legal entity.
+ */
+corporatePhone?: (null | string)
+/**
+ * Indicates whether the customer is a legal entity.
+ */
+isCorporate?: boolean
+/**
+ * Indicates whether profile is complete on loading.
+ */
+profileCompleteOnLoading?: boolean
+/**
+ * Indicates whether profile presents error on loading.
+ */
+profileErrorOnLoading?: (null | boolean)
+/**
+ * Customer class.
+ */
+customerClass?: (null | string)
+})
+/**
+ * Information on the order's payment.
+ */
+paymentData?: {
+/**
+ * Gift card information, if it applies to the order.
+ */
+giftCards?: {
+/**
+ * Gift card redemption code.
+ */
+redemptionCode?: string
+/**
+ * Gift card value in cents.
+ */
+value?: number
+/**
+ * Gift card balance in cents.
+ */
+balance?: number
+/**
+ * Gift card name.
+ */
+name?: string
+/**
+ * Gift card ID.
+ */
+id?: string
+/**
+ * Indicates whether gift card is in use.
+ */
+inUse?: boolean
+/**
+ * Indicates whether gift card is special.
+ */
+isSpecialCard?: boolean
+}[]
+/**
+ * Information on each transaction pertinent to the order.
+ */
+transactions?: (null | {
+/**
+ * Indicates whether transaction is active.
+ */
+isActive?: boolean
+/**
+ * Transaction ID.
+ */
+transactionId?: string
+/**
+ * Merchant name.
+ */
+merchantName?: string
+/**
+ * Information on each payment.
+ */
+payments?: {
+/**
+ * Account ID.
+ */
+accountId?: string
+/**
+ * Bin.
+ */
+bin?: (null | string)
+/**
+ * Number of installments.
+ */
+installments?: number
+/**
+ * Payment system.
+ */
+paymentSystem?: string
+/**
+ * Reference value for calculating interest rates, in case it applies. Displayed in cents.
+ */
+referenceValue?: number
+/**
+ * Value including interest, in case it applies. Displayed in cents.
+ */
+value?: number
+}[]
+/**
+ * Indicates whather transaction is shared.
+ */
+sharedTransaction?: boolean
+})[]
+}
+/**
+ * Object containing promotion data such as coupon tracking information and internal or external UTMs.
+ */
+marketingData?: (null | {
+/**
+ * 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.
+ */
+coupon?: string
+/**
+ * UTM source.
+ */
+utmSource?: string
+/**
+ * UTM medium.
+ */
+utmMedium?: string
+/**
+ * UTM campaign.
+ */
+utmCampaign?: string
+/**
+ * utmi_page (internal utm).
+ */
+utmiPage?: (null | string)
+/**
+ * utmi_part (internal utm).
+ */
+utmiPart?: (null | string)
+/**
+ * utmi_campaign (internal utm).
+ */
+utmiCampaign?: (null | string)
+})
+/**
+ * Information on each seller.
+ */
+sellers?: {
+/**
+ * Seller ID.
+ */
+id?: string
+/**
+ * Seller name.
+ */
+name?: string
+/**
+ * Seller logo.
+ */
+logo?: (null | string)
+}[]
+/**
+ * Object containing preferences from the client who placed the order.
+ */
+clientPreferencesData?: {
+/**
+ * Client's locale. Examples: `pt-BR` and `en-US`.
+ */
+locale?: string
+/**
+ * `true` if the client opted to receive newsletter from the store.
+ */
+optinNewsLetter?: (null | boolean)
+}
+/**
+ * Object containing commercial condition information.
+ */
+commercialConditionData?: (null | {
+
+})
+/**
+ * Object containing data from the store's configuration (stored in VTEX's License Manager).
+ */
+storePreferencesData?: {
+
+}
+/**
+ * Gift registry list information.
+ */
+giftRegistryData?: (null | {
+
+})
+/**
+ * Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).
+ */
+openTextField?: (null | string)
+/**
+ * Invoice data including billing address.
+ */
+invoiceData?: (null | {
+/**
+ * Billing address.
+ */
+address?: {
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City name.
+ */
+city?: string
+/**
+ * State name.
+ */
+state?: string
+/**
+ * Country.
+ */
+country?: string
+/**
+ * Street name.
+ */
+street?: string
+/**
+ * Street number.
+ */
+number?: string
+/**
+ * Neighborhood.
+ */
+neighborhood?: string
+/**
+ * Address complement.
+ */
+complement?: string
+/**
+ * Reference for location.
+ */
+reference?: string
+/**
+ * Geographic coordinates (latitude, longitude).
+ */
+geoCoordinates?: number[]
+}
+})
+/**
+ * Customer additional information.
+ */
+customData?: (null | {
+
+})
+/**
+ * Item metadata.
+ */
+itemMetadata?: {
+/**
+ * List of objects containing metadata on each item in the order.
+ */
+items?: {
+/**
+ * Item ID.
+ */
+id?: string
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+}[]
+}
+/**
+ * Hooks information.
+ */
+hooksData?: (null | {
+
+})
+/**
+ * Information on rates and benefits that apply to the order.
+ */
+ratesAndBenefitsData?: {
+/**
+ * List with rates and benefits identifiers.
+ */
+rateAndBenefitsIdentifiers?: string[]
+/**
+ * List with rates and benefits teasers.
+ */
+teaser?: string[]
+}
+/**
+ * Subscription information.
+ */
+subscriptionData?: (null | {
+
+})
+/**
+ * Object containing information about the ordering of items within the `orderForm`.
+ */
+itemsOrdination?: {
+/**
+ * Criteria adopted to order the items in the list.
+ */
+criteria?: string
+/**
+ * Indicates whether the ordering is ascending.
+ */
+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.
+ * 
+ * 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"PATCH /api/checkout/pub/orderForm/:orderFormId/items": {
+searchParams: {
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+body: {
+/**
+ * Array containing the cart items. Each object inside this array corresponds to a different item.
+ */
+orderItems?: {
+/**
+ * The ID of the SKU in VTEX platform.
+ */
+id: string
+/**
+ * The quantity of the item (SKU) in the cart.
+ */
+quantity: number
+/**
+ * The seller responsible for the SKU.
+ */
+seller: string
+/**
+ * The position of the item in the array. This string should be sent only to modify price or quantity of an item. NOTE: This string should not be sent when you are adding a new item to the cart.
+ */
+index?: number
+/**
+ * Price of the item in cents. Send this value in case you want to make a bulk price change.
+ */
+price?: number
+/**
+ * Array containing information on attachments.
+ */
+attachments?: {
+/**
+ * Attachment identification.
+ */
+name?: string
+/**
+ * Attachment content data. E.g. `"Do you want to receive packages?": "Yes"`.
+ */
+content?: (null | {
+/**
+ * Content referring to the customization requested by the customer.
+ */
+content?: string
+})
+}[]
+/**
+ * Indicates whether the item can be splitted.
+ */
+noSplitItem?: boolean
+/**
+ * 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"`.
+ */
+allowedOutdatedData?: string[]
+}[]
+}
+response: {
+/**
+ * ID of the orderForm corresponding to a specific cart.
+ */
+orderFormId?: string
+/**
+ * Attribute created by the seller, in their VTEX store configuration.
+ */
+salesChannel?: string
+/**
+ * Indicates whether the user is logged into the store.
+ */
+loggedIn?: boolean
+/**
+ * Indicates whether order is checked in.
+ */
+isCheckedIn?: boolean
+/**
+ * ID of the store.
+ */
+storeId?: (null | string)
+/**
+ * Permission to modify item price manually.
+ */
+allowManualPrice?: boolean
+/**
+ * Data can be edited.
+ */
+canEditData?: boolean
+/**
+ * Unique ID associated with the customer profile.
+ */
+userProfileId?: string
+/**
+ * Profile provider.
+ */
+profileProvider?: string
+/**
+ * Available accounts.
+ */
+availableAccounts?: string[]
+/**
+ * Information on each available address.
+ */
+availableAddresses?: {
+/**
+ * Address type.
+ */
+addressType?: string
+/**
+ * Name of the receiver.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * City of the address.
+ */
+city?: string
+/**
+ * State of the address.
+ */
+state?: string
+/**
+ * Country of the address. ISO three-letter code.
+ */
+country?: string
+/**
+ * Street of the address.
+ */
+street?: string
+/**
+ * Number of the address.
+ */
+number?: string
+/**
+ * Neighborhood of the address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Reference that may help in the location of the address.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * User type.
+ */
+userType?: (null | string)
+/**
+ * Ignore customer profile data.
+ */
+ignoreProfileData?: boolean
+/**
+ * Total value of the order without separating cents. For example, $24.99 is represented as `2499`.
+ */
+value?: number
+/**
+ * Array containing an object for each message generated by our servers while processing the request.
+ */
+messages?: string[]
+/**
+ * Information on each item in the order.
+ */
+items?: {
+/**
+ * Unique ID.
+ */
+uniqueId?: string
+/**
+ * ID of the item.
+ */
+id?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Product Ref ID.
+ */
+productRefId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Modal type.
+ */
+modalType?: (null | string)
+/**
+ * Parent item index.
+ */
+parentItemIndex?: (null | number)
+/**
+ * Parent assembly binding.
+ */
+parentAssemblyBinding?: (null | string)
+/**
+ * Price expiration date and time.
+ */
+priceValidUntil?: string
+/**
+ * Tax value in cents.
+ */
+tax?: number
+/**
+ * A unique identifier code assigned to a tax within the VTEX Admin.
+ */
+taxCode?: string
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Manual price in cents.
+ */
+manualPrice?: (null | number)
+/**
+ * User that applied the manual price, if that is the case.
+ */
+manualPriceAppliedBy?: (null | string)
+/**
+ * Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
+ */
+sellingPrice?: number
+/**
+ * Reward value in cents.
+ */
+rewardValue?: number
+/**
+ * Indicates whether item is a gift.
+ */
+isGift?: boolean
+/**
+ * Additional information.
+ */
+additionalInfo?: {
+/**
+ * Dimension.
+ */
+dimension?: (null | string)
+/**
+ * Brand name.
+ */
+brandName?: string
+/**
+ * Brand ID.
+ */
+brandId?: string
+/**
+ * Offering information.
+ */
+offeringInfo?: (null | string)
+/**
+ * Offering type.
+ */
+offeringType?: (null | string)
+/**
+ * Offering type ID.
+ */
+offeringTypeId?: (null | string)
+}
+/**
+ * Presale date.
+ */
+preSaleDate?: (null | string)
+/**
+ * Product category IDs.
+ */
+productCategoryIds?: string
+/**
+ * Object, where each field is an ID from `productCategoryIds`.
+ */
+productCategories?: {
+/**
+ * Product category corresponding to the ID in the field key.
+ */
+"{ID}"?: string
+}
+/**
+ * Quantity.
+ */
+quantity?: number
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
+ */
+sellerChain?: string[]
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+/**
+ * Information on services sold along with the SKU. Example: a gift package.
+ */
+bundleItems?: {
+/**
+ * Service type.
+ */
+type?: string
+/**
+ * Service identifier.
+ */
+id?: number
+/**
+ * Service name.
+ */
+name?: string
+/**
+ * Service price in cents.
+ */
+price?: number
+}[]
+/**
+ * Array containing information on attachments.
+ */
+attachments?: string[]
+/**
+ * Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.
+ */
+priceTags?: {
+/**
+ * Promotion unique identifier.
+ */
+identifier?: (null | string)
+/**
+ * Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.
+ */
+isPercentual?: boolean
+/**
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
+ * - `calculationId` is a hash that may vary with each price calculation.
+ */
+name?: string
+/**
+ * Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.
+ */
+rawValue?: number
+/**
+ * Price tag value representing either a promotion (value decrease) or a tax (value increase).
+ */
+value?: number
+}[]
+/**
+ * Availability.
+ */
+availability?: string
+/**
+ * Measurement unit.
+ */
+measurementUnit?: string
+/**
+ * Unit multiplier.
+ */
+unitMultiplier?: number
+/**
+ * Manufacturer code.
+ */
+manufacturerCode?: (null | string)
+/**
+ * Price information for all units of a specific item.
+ */
+priceDefinition?: {
+/**
+ * Item's calculated unitary selling price in cents.
+ */
+calculatedSellingPrice?: number
+/**
+ * Total value for all units of the item in cents.
+ */
+total?: number
+/**
+ * Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
+ */
+sellingPrices?: {
+/**
+ * Value in cents for that specific rounding.
+ */
+value?: number
+/**
+ * Rounding quantity, meaning how many items are rounded to this value.
+ */
+quantity?: number
+}[]
+}
+}[]
+/**
+ * Array containing the data of the item selected as a gift.
+ */
+selectableGifts?: string[]
+/**
+ * Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).
+ */
+totalizers?: {
+
+}[]
+/**
+ * Shipping information pertinent to the order.
+ */
+shippingData?: (null | {
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.
+ */
+logisticsInfo?: {
+/**
+ * Index corresponding to the position of the object in the `items` array.
+ */
+itemIndex?: number
+/**
+ * SLA selected by the customer.
+ */
+selectedSla?: (null | string)
+/**
+ * Delivery channel selected by the customer.
+ */
+selectedDeliveryChannel?: (null | string)
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Information on available SLAs.
+ */
+slas?: {
+/**
+ * SLA ID.
+ */
+id?: string
+/**
+ * Delivery channel.
+ */
+deliveryChannel?: string
+/**
+ * SLA name.
+ */
+name?: string
+/**
+ * Information on each delivery ID.
+ */
+deliveryIds?: {
+/**
+ * Courier ID.
+ */
+courierId?: string
+/**
+ * Warehouse ID.
+ */
+warehouseId?: string
+/**
+ * Warehouse ID.
+ */
+dockId?: string
+/**
+ * Courier name.
+ */
+courierName?: string
+/**
+ * Quantity.
+ */
+quantity?: number
+}[]
+/**
+ * List of attachments details.
+ */
+attachmentOfferings?: (null | {
+/**
+ * Name of the attachment.
+ */
+name: (null | string)
+/**
+ * Defines if the attachment is required (`true`) or not (`false`).
+ */
+required: (null | boolean)
+/**
+ * Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).
+ */
+schema: (null | {
+
+})
+}[])
+/**
+ * Shipping estimate. For instance, "three business days" will be represented as `3bd`.
+ */
+shippingEstimate?: string
+/**
+ * When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.
+ */
+shippingEstimateDate?: (null | string)
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+useIndividualShippingEstimates?: boolean
+/**
+ * Estimate date of delivery.
+ */
+lockTTL?: (null | string)
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Tax in cents.
+ */
+tax?: number
+/**
+ * Information on the pickup store.
+ */
+pickupStoreInfo?: {
+/**
+ * Indicates whether it is the pickup store.
+ */
+isPickupStore?: boolean
+/**
+ * Friendly name.
+ */
+friendlyName?: (null | string)
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that repesent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Additional information.
+ */
+additionalInfo?: (null | string)
+/**
+ * Corresponding dock ID.
+ */
+dockId?: (null | string)
+}
+/**
+ * Pickup point ID.
+ */
+pickupPointId?: (null | string)
+/**
+ * Pickup point distance.
+ */
+pickupDistance?: number
+/**
+ * Polygon name.
+ */
+polygonName?: (null | string)
+/**
+ * Transit time. For instance, "three business days" is represented as `3bd`.
+ */
+transitTime?: string
+}[]
+/**
+ * List of countries that the item may be shipped to.
+ */
+shipsTo?: string[]
+/**
+ * Item ID.
+ */
+itemId?: string
+/**
+ * List of available delivery channels.
+ */
+deliveryChannels?: {
+/**
+ * Delivery channel ID.
+ */
+id?: string
+}[]
+}[]
+/**
+ * Array with information on the selected addresses for the order.
+ */
+selectedAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * Array with information on the available addresses for the order.
+ */
+availableAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+})
+/**
+ * Customer's profile information.
+ */
+clientProfileData?: (null | {
+/**
+ * Email address.
+ */
+email?: (null | string)
+/**
+ * First name.
+ */
+firstName?: (null | string)
+/**
+ * Last name.
+ */
+lastName?: string
+/**
+ * Type of the document informed by the customer.
+ */
+documentType?: string
+/**
+ * Document informed by the customer.
+ */
+document?: string
+/**
+ * Phone number.
+ */
+phone?: string
+/**
+ * Company name, if the customer is a legal entity.
+ */
+corporateName?: (null | string)
+/**
+ * Trade name, if the customer is a legal entity.
+ */
+tradeName?: (null | string)
+/**
+ * Corporate document, if the customer is a legal entity.
+ */
+corporateDocument?: (null | string)
+/**
+ * State inscription, if the customer is a legal entity.
+ */
+stateInscription?: (null | string)
+/**
+ * Corporate phone number, if the customer is a legal entity.
+ */
+corporatePhone?: (null | string)
+/**
+ * Indicates whether the customer is a legal entity.
+ */
+isCorporate?: boolean
+/**
+ * Indicates whether profile is complete on loading.
+ */
+profileCompleteOnLoading?: boolean
+/**
+ * Indicates whether profile presents error on loading.
+ */
+profileErrorOnLoading?: (null | boolean)
+/**
+ * Customer class.
+ */
+customerClass?: (null | string)
+})
+/**
+ * Information on the order's payment.
+ */
+paymentData?: {
+/**
+ * Gift card information, if it applies to the order.
+ */
+giftCards?: {
+/**
+ * Gift card redemption code.
+ */
+redemptionCode?: string
+/**
+ * Gift card value in cents.
+ */
+value?: number
+/**
+ * Gift card balance in cents.
+ */
+balance?: number
+/**
+ * Gift card name.
+ */
+name?: string
+/**
+ * Gift card ID.
+ */
+id?: string
+/**
+ * Indicates whether gift card is in use.
+ */
+inUse?: boolean
+/**
+ * Indicates whether gift card is special.
+ */
+isSpecialCard?: boolean
+}[]
+/**
+ * Information on each transaction pertinent to the order.
+ */
+transactions?: (null | {
+/**
+ * Indicates whether transaction is active.
+ */
+isActive?: boolean
+/**
+ * Transaction ID.
+ */
+transactionId?: string
+/**
+ * Merchant name.
+ */
+merchantName?: string
+/**
+ * Information on each payment.
+ */
+payments?: {
+/**
+ * Account ID.
+ */
+accountId?: string
+/**
+ * Bin.
+ */
+bin?: (null | string)
+/**
+ * Number of installments.
+ */
+installments?: number
+/**
+ * Payment system.
+ */
+paymentSystem?: string
+/**
+ * Reference value for calculating interest rates, in case it applies. Displayed in cents.
+ */
+referenceValue?: number
+/**
+ * Value including interest, in case it applies. Displayed in cents.
+ */
+value?: number
+}[]
+/**
+ * Indicates whather transaction is shared.
+ */
+sharedTransaction?: boolean
+})[]
+}
+/**
+ * Object containing promotion data such as coupon tracking information and internal or external UTMs.
+ */
+marketingData?: (null | {
+/**
+ * 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.
+ */
+coupon?: string
+/**
+ * UTM source.
+ */
+utmSource?: string
+/**
+ * UTM medium.
+ */
+utmMedium?: string
+/**
+ * UTM campaign.
+ */
+utmCampaign?: string
+/**
+ * utmi_page (internal utm).
+ */
+utmiPage?: (null | string)
+/**
+ * utmi_part (internal utm).
+ */
+utmiPart?: (null | string)
+/**
+ * utmi_campaign (internal utm).
+ */
+utmiCampaign?: (null | string)
+})
+/**
+ * Information on each seller.
+ */
+sellers?: {
+/**
+ * Seller ID.
+ */
+id?: string
+/**
+ * Seller name.
+ */
+name?: string
+/**
+ * Seller logo.
+ */
+logo?: (null | string)
+}[]
+/**
+ * Object containing preferences from the client who placed the order.
+ */
+clientPreferencesData?: {
+/**
+ * Client's locale. Examples: `pt-BR` and `en-US`.
+ */
+locale?: string
+/**
+ * `true` if the client opted to receive newsletter from the store.
+ */
+optinNewsLetter?: (null | boolean)
+}
+/**
+ * Object containing commercial condition information.
+ */
+commercialConditionData?: (null | {
+
+})
+/**
+ * Object containing data from the store's configuration (stored in VTEX's License Manager).
+ */
+storePreferencesData?: {
+
+}
+/**
+ * Gift registry list information.
+ */
+giftRegistryData?: (null | {
+
+})
+/**
+ * Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).
+ */
+openTextField?: (null | string)
+/**
+ * Invoice data including billing address.
+ */
+invoiceData?: (null | {
+/**
+ * Billing address.
+ */
+address?: {
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City name.
+ */
+city?: string
+/**
+ * State name.
+ */
+state?: string
+/**
+ * Country.
+ */
+country?: string
+/**
+ * Street name.
+ */
+street?: string
+/**
+ * Street number.
+ */
+number?: string
+/**
+ * Neighborhood.
+ */
+neighborhood?: string
+/**
+ * Address complement.
+ */
+complement?: string
+/**
+ * Reference for location.
+ */
+reference?: string
+/**
+ * Geographic coordinates (latitude, longitude).
+ */
+geoCoordinates?: number[]
+}
+})
+/**
+ * Customer additional information.
+ */
+customData?: (null | {
+
+})
+/**
+ * Item metadata.
+ */
+itemMetadata?: {
+/**
+ * List of objects containing metadata on each item in the order.
+ */
+items?: {
+/**
+ * Item ID.
+ */
+id?: string
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+}[]
+}
+/**
+ * Hooks information.
+ */
+hooksData?: (null | {
+
+})
+/**
+ * Information on rates and benefits that apply to the order.
+ */
+ratesAndBenefitsData?: {
+/**
+ * List with rates and benefits identifiers.
+ */
+rateAndBenefitsIdentifiers?: string[]
+/**
+ * List with rates and benefits teasers.
+ */
+teaser?: string[]
+}
+/**
+ * Subscription information.
+ */
+subscriptionData?: (null | {
+
+})
+/**
+ * Object containing information about the ordering of items within the `orderForm`.
+ */
+itemsOrdination?: {
+/**
+ * Criteria adopted to order the items in the list.
+ */
+criteria?: string
+/**
+ * Indicates whether the ordering is ascending.
+ */
+ascending?: boolean
+}
+}
+}
+/**
+ * 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"PUT /api/checkout/pub/orderForm/:orderFormId/items/:itemIndex/price": {
+searchParams: {
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+body: {
+/**
+ * The new price of the item.
+ */
+price: number
+}
+response: {
+/**
+ * ID of the orderForm corresponding to a specific cart.
+ */
+orderFormId?: string
+/**
+ * Attribute created by the seller, in their VTEX store configuration.
+ */
+salesChannel?: string
+/**
+ * Indicates whether the user is logged into the store.
+ */
+loggedIn?: boolean
+/**
+ * Indicates whether order is checked in.
+ */
+isCheckedIn?: boolean
+/**
+ * ID of the store.
+ */
+storeId?: (null | string)
+/**
+ * Permission to modify item price manually.
+ */
+allowManualPrice?: boolean
+/**
+ * Data can be edited.
+ */
+canEditData?: boolean
+/**
+ * Unique ID associated with the customer profile.
+ */
+userProfileId?: string
+/**
+ * Profile provider.
+ */
+profileProvider?: string
+/**
+ * Available accounts.
+ */
+availableAccounts?: string[]
+/**
+ * Information on each available address.
+ */
+availableAddresses?: {
+/**
+ * Address type.
+ */
+addressType?: string
+/**
+ * Name of the receiver.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * City of the address.
+ */
+city?: string
+/**
+ * State of the address.
+ */
+state?: string
+/**
+ * Country of the address. ISO three-letter code.
+ */
+country?: string
+/**
+ * Street of the address.
+ */
+street?: string
+/**
+ * Number of the address.
+ */
+number?: string
+/**
+ * Neighborhood of the address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Reference that may help in the location of the address.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * User type.
+ */
+userType?: (null | string)
+/**
+ * Ignore customer profile data.
+ */
+ignoreProfileData?: boolean
+/**
+ * Total value of the order without separating cents. For example, $24.99 is represented as `2499`.
+ */
+value?: number
+/**
+ * Array containing an object for each message generated by our servers while processing the request.
+ */
+messages?: string[]
+/**
+ * Information on each item in the order.
+ */
+items?: {
+/**
+ * Unique ID.
+ */
+uniqueId?: string
+/**
+ * ID of the item.
+ */
+id?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Product Ref ID.
+ */
+productRefId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Modal type.
+ */
+modalType?: (null | string)
+/**
+ * Parent item index.
+ */
+parentItemIndex?: (null | number)
+/**
+ * Parent assembly binding.
+ */
+parentAssemblyBinding?: (null | string)
+/**
+ * Price expiration date and time.
+ */
+priceValidUntil?: string
+/**
+ * Tax value in cents.
+ */
+tax?: number
+/**
+ * A unique identifier code assigned to a tax within the VTEX Admin.
+ */
+taxCode?: string
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Manual price in cents.
+ */
+manualPrice?: (null | number)
+/**
+ * User that applied the manual price, if that is the case.
+ */
+manualPriceAppliedBy?: (null | string)
+/**
+ * Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
+ */
+sellingPrice?: number
+/**
+ * Reward value in cents.
+ */
+rewardValue?: number
+/**
+ * Indicates whether item is a gift.
+ */
+isGift?: boolean
+/**
+ * Additional information.
+ */
+additionalInfo?: {
+/**
+ * Dimension.
+ */
+dimension?: (null | string)
+/**
+ * Brand name.
+ */
+brandName?: string
+/**
+ * Brand ID.
+ */
+brandId?: string
+/**
+ * Offering information.
+ */
+offeringInfo?: (null | string)
+/**
+ * Offering type.
+ */
+offeringType?: (null | string)
+/**
+ * Offering type ID.
+ */
+offeringTypeId?: (null | string)
+}
+/**
+ * Presale date.
+ */
+preSaleDate?: (null | string)
+/**
+ * Product category IDs.
+ */
+productCategoryIds?: string
+/**
+ * Object, where each field is an ID from `productCategoryIds`.
+ */
+productCategories?: {
+/**
+ * Product category corresponding to the ID in the field key.
+ */
+"{ID}"?: string
+}
+/**
+ * Quantity.
+ */
+quantity?: number
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
+ */
+sellerChain?: string[]
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+/**
+ * Information on services sold along with the SKU. Example: a gift package.
+ */
+bundleItems?: {
+/**
+ * Service type.
+ */
+type?: string
+/**
+ * Service identifier.
+ */
+id?: number
+/**
+ * Service name.
+ */
+name?: string
+/**
+ * Service price in cents.
+ */
+price?: number
+}[]
+/**
+ * Array containing information on attachments.
+ */
+attachments?: string[]
+/**
+ * Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.
+ */
+priceTags?: {
+/**
+ * Promotion unique identifier.
+ */
+identifier?: (null | string)
+/**
+ * Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.
+ */
+isPercentual?: boolean
+/**
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
+ * - `calculationId` is a hash that may vary with each price calculation.
+ */
+name?: string
+/**
+ * Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.
+ */
+rawValue?: number
+/**
+ * Price tag value representing either a promotion (value decrease) or a tax (value increase).
+ */
+value?: number
+}[]
+/**
+ * Availability.
+ */
+availability?: string
+/**
+ * Measurement unit.
+ */
+measurementUnit?: string
+/**
+ * Unit multiplier.
+ */
+unitMultiplier?: number
+/**
+ * Manufacturer code.
+ */
+manufacturerCode?: (null | string)
+/**
+ * Price information for all units of a specific item.
+ */
+priceDefinition?: {
+/**
+ * Item's calculated unitary selling price in cents.
+ */
+calculatedSellingPrice?: number
+/**
+ * Total value for all units of the item in cents.
+ */
+total?: number
+/**
+ * Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
+ */
+sellingPrices?: {
+/**
+ * Value in cents for that specific rounding.
+ */
+value?: number
+/**
+ * Rounding quantity, meaning how many items are rounded to this value.
+ */
+quantity?: number
+}[]
+}
+}[]
+/**
+ * Array containing the data of the item selected as a gift.
+ */
+selectableGifts?: string[]
+/**
+ * Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).
+ */
+totalizers?: {
+
+}[]
+/**
+ * Shipping information pertinent to the order.
+ */
+shippingData?: (null | {
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.
+ */
+logisticsInfo?: {
+/**
+ * Index corresponding to the position of the object in the `items` array.
+ */
+itemIndex?: number
+/**
+ * SLA selected by the customer.
+ */
+selectedSla?: (null | string)
+/**
+ * Delivery channel selected by the customer.
+ */
+selectedDeliveryChannel?: (null | string)
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Information on available SLAs.
+ */
+slas?: {
+/**
+ * SLA ID.
+ */
+id?: string
+/**
+ * Delivery channel.
+ */
+deliveryChannel?: string
+/**
+ * SLA name.
+ */
+name?: string
+/**
+ * Information on each delivery ID.
+ */
+deliveryIds?: {
+/**
+ * Courier ID.
+ */
+courierId?: string
+/**
+ * Warehouse ID.
+ */
+warehouseId?: string
+/**
+ * Warehouse ID.
+ */
+dockId?: string
+/**
+ * Courier name.
+ */
+courierName?: string
+/**
+ * Quantity.
+ */
+quantity?: number
+}[]
+/**
+ * List of attachments details.
+ */
+attachmentOfferings?: (null | {
+/**
+ * Name of the attachment.
+ */
+name: (null | string)
+/**
+ * Defines if the attachment is required (`true`) or not (`false`).
+ */
+required: (null | boolean)
+/**
+ * Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).
+ */
+schema: (null | {
+
+})
+}[])
+/**
+ * Shipping estimate. For instance, "three business days" will be represented as `3bd`.
+ */
+shippingEstimate?: string
+/**
+ * When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.
+ */
+shippingEstimateDate?: (null | string)
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+useIndividualShippingEstimates?: boolean
+/**
+ * Estimate date of delivery.
+ */
+lockTTL?: (null | string)
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Tax in cents.
+ */
+tax?: number
+/**
+ * Information on the pickup store.
+ */
+pickupStoreInfo?: {
+/**
+ * Indicates whether it is the pickup store.
+ */
+isPickupStore?: boolean
+/**
+ * Friendly name.
+ */
+friendlyName?: (null | string)
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that repesent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Additional information.
+ */
+additionalInfo?: (null | string)
+/**
+ * Corresponding dock ID.
+ */
+dockId?: (null | string)
+}
+/**
+ * Pickup point ID.
+ */
+pickupPointId?: (null | string)
+/**
+ * Pickup point distance.
+ */
+pickupDistance?: number
+/**
+ * Polygon name.
+ */
+polygonName?: (null | string)
+/**
+ * Transit time. For instance, "three business days" is represented as `3bd`.
+ */
+transitTime?: string
+}[]
+/**
+ * List of countries that the item may be shipped to.
+ */
+shipsTo?: string[]
+/**
+ * Item ID.
+ */
+itemId?: string
+/**
+ * List of available delivery channels.
+ */
+deliveryChannels?: {
+/**
+ * Delivery channel ID.
+ */
+id?: string
+}[]
+}[]
+/**
+ * Array with information on the selected addresses for the order.
+ */
+selectedAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * Array with information on the available addresses for the order.
+ */
+availableAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+})
+/**
+ * Customer's profile information.
+ */
+clientProfileData?: (null | {
+/**
+ * Email address.
+ */
+email?: (null | string)
+/**
+ * First name.
+ */
+firstName?: (null | string)
+/**
+ * Last name.
+ */
+lastName?: string
+/**
+ * Type of the document informed by the customer.
+ */
+documentType?: string
+/**
+ * Document informed by the customer.
+ */
+document?: string
+/**
+ * Phone number.
+ */
+phone?: string
+/**
+ * Company name, if the customer is a legal entity.
+ */
+corporateName?: (null | string)
+/**
+ * Trade name, if the customer is a legal entity.
+ */
+tradeName?: (null | string)
+/**
+ * Corporate document, if the customer is a legal entity.
+ */
+corporateDocument?: (null | string)
+/**
+ * State inscription, if the customer is a legal entity.
+ */
+stateInscription?: (null | string)
+/**
+ * Corporate phone number, if the customer is a legal entity.
+ */
+corporatePhone?: (null | string)
+/**
+ * Indicates whether the customer is a legal entity.
+ */
+isCorporate?: boolean
+/**
+ * Indicates whether profile is complete on loading.
+ */
+profileCompleteOnLoading?: boolean
+/**
+ * Indicates whether profile presents error on loading.
+ */
+profileErrorOnLoading?: (null | boolean)
+/**
+ * Customer class.
+ */
+customerClass?: (null | string)
+})
+/**
+ * Information on the order's payment.
+ */
+paymentData?: {
+/**
+ * Gift card information, if it applies to the order.
+ */
+giftCards?: {
+/**
+ * Gift card redemption code.
+ */
+redemptionCode?: string
+/**
+ * Gift card value in cents.
+ */
+value?: number
+/**
+ * Gift card balance in cents.
+ */
+balance?: number
+/**
+ * Gift card name.
+ */
+name?: string
+/**
+ * Gift card ID.
+ */
+id?: string
+/**
+ * Indicates whether gift card is in use.
+ */
+inUse?: boolean
+/**
+ * Indicates whether gift card is special.
+ */
+isSpecialCard?: boolean
+}[]
+/**
+ * Information on each transaction pertinent to the order.
+ */
+transactions?: (null | {
+/**
+ * Indicates whether transaction is active.
+ */
+isActive?: boolean
+/**
+ * Transaction ID.
+ */
+transactionId?: string
+/**
+ * Merchant name.
+ */
+merchantName?: string
+/**
+ * Information on each payment.
+ */
+payments?: {
+/**
+ * Account ID.
+ */
+accountId?: string
+/**
+ * Bin.
+ */
+bin?: (null | string)
+/**
+ * Number of installments.
+ */
+installments?: number
+/**
+ * Payment system.
+ */
+paymentSystem?: string
+/**
+ * Reference value for calculating interest rates, in case it applies. Displayed in cents.
+ */
+referenceValue?: number
+/**
+ * Value including interest, in case it applies. Displayed in cents.
+ */
+value?: number
+}[]
+/**
+ * Indicates whather transaction is shared.
+ */
+sharedTransaction?: boolean
+})[]
+}
+/**
+ * Object containing promotion data such as coupon tracking information and internal or external UTMs.
+ */
+marketingData?: (null | {
+/**
+ * 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.
+ */
+coupon?: string
+/**
+ * UTM source.
+ */
+utmSource?: string
+/**
+ * UTM medium.
+ */
+utmMedium?: string
+/**
+ * UTM campaign.
+ */
+utmCampaign?: string
+/**
+ * utmi_page (internal utm).
+ */
+utmiPage?: (null | string)
+/**
+ * utmi_part (internal utm).
+ */
+utmiPart?: (null | string)
+/**
+ * utmi_campaign (internal utm).
+ */
+utmiCampaign?: (null | string)
+})
+/**
+ * Information on each seller.
+ */
+sellers?: {
+/**
+ * Seller ID.
+ */
+id?: string
+/**
+ * Seller name.
+ */
+name?: string
+/**
+ * Seller logo.
+ */
+logo?: (null | string)
+}[]
+/**
+ * Object containing preferences from the client who placed the order.
+ */
+clientPreferencesData?: {
+/**
+ * Client's locale. Examples: `pt-BR` and `en-US`.
+ */
+locale?: string
+/**
+ * `true` if the client opted to receive newsletter from the store.
+ */
+optinNewsLetter?: (null | boolean)
+}
+/**
+ * Object containing commercial condition information.
+ */
+commercialConditionData?: (null | {
+
+})
+/**
+ * Object containing data from the store's configuration (stored in VTEX's License Manager).
+ */
+storePreferencesData?: {
+
+}
+/**
+ * Gift registry list information.
+ */
+giftRegistryData?: (null | {
+
+})
+/**
+ * Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).
+ */
+openTextField?: (null | string)
+/**
+ * Invoice data including billing address.
+ */
+invoiceData?: (null | {
+/**
+ * Billing address.
+ */
+address?: {
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City name.
+ */
+city?: string
+/**
+ * State name.
+ */
+state?: string
+/**
+ * Country.
+ */
+country?: string
+/**
+ * Street name.
+ */
+street?: string
+/**
+ * Street number.
+ */
+number?: string
+/**
+ * Neighborhood.
+ */
+neighborhood?: string
+/**
+ * Address complement.
+ */
+complement?: string
+/**
+ * Reference for location.
+ */
+reference?: string
+/**
+ * Geographic coordinates (latitude, longitude).
+ */
+geoCoordinates?: number[]
+}
+})
+/**
+ * Customer additional information.
+ */
+customData?: (null | {
+
+})
+/**
+ * Item metadata.
+ */
+itemMetadata?: {
+/**
+ * List of objects containing metadata on each item in the order.
+ */
+items?: {
+/**
+ * Item ID.
+ */
+id?: string
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+}[]
+}
+/**
+ * Hooks information.
+ */
+hooksData?: (null | {
+
+})
+/**
+ * Information on rates and benefits that apply to the order.
+ */
+ratesAndBenefitsData?: {
+/**
+ * List with rates and benefits identifiers.
+ */
+rateAndBenefitsIdentifiers?: string[]
+/**
+ * List with rates and benefits teasers.
+ */
+teaser?: string[]
+}
+/**
+ * Subscription information.
+ */
+subscriptionData?: (null | {
+
+})
+/**
+ * Object containing information about the ordering of items within the `orderForm`.
+ */
+itemsOrdination?: {
+/**
+ * Criteria adopted to order the items in the list.
+ */
+criteria?: string
+/**
+ * Indicates whether the ordering is ascending.
+ */
+ascending?: boolean
+}
+}
+}
+/**
+ * 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 automatically.
+ * 
+ * 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"PATCH /api/checkout/pub/orderForm/:orderFormId/profile": {
+searchParams: {
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+body: {
+/**
+ * Indicates whether profile data should be ignored.
+ */
+ignoreProfileData?: boolean
+}
+response: {
+/**
+ * ID of the orderForm corresponding to a specific cart.
+ */
+orderFormId?: string
+/**
+ * Attribute created by the seller, in their VTEX store configuration.
+ */
+salesChannel?: string
+/**
+ * Indicates whether the user is logged into the store.
+ */
+loggedIn?: boolean
+/**
+ * Indicates whether order is checked in.
+ */
+isCheckedIn?: boolean
+/**
+ * ID of the store.
+ */
+storeId?: (null | string)
+/**
+ * Permission to modify item price manually.
+ */
+allowManualPrice?: boolean
+/**
+ * Data can be edited.
+ */
+canEditData?: boolean
+/**
+ * Unique ID associated with the customer profile.
+ */
+userProfileId?: string
+/**
+ * Profile provider.
+ */
+profileProvider?: string
+/**
+ * Available accounts.
+ */
+availableAccounts?: string[]
+/**
+ * Information on each available address.
+ */
+availableAddresses?: {
+/**
+ * Address type.
+ */
+addressType?: string
+/**
+ * Name of the receiver.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * City of the address.
+ */
+city?: string
+/**
+ * State of the address.
+ */
+state?: string
+/**
+ * Country of the address. ISO three-letter code.
+ */
+country?: string
+/**
+ * Street of the address.
+ */
+street?: string
+/**
+ * Number of the address.
+ */
+number?: string
+/**
+ * Neighborhood of the address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Reference that may help in the location of the address.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * User type.
+ */
+userType?: (null | string)
+/**
+ * Ignore customer profile data.
+ */
+ignoreProfileData?: boolean
+/**
+ * Total value of the order without separating cents. For example, $24.99 is represented as `2499`.
+ */
+value?: number
+/**
+ * Array containing an object for each message generated by our servers while processing the request.
+ */
+messages?: string[]
+/**
+ * Information on each item in the order.
+ */
+items?: {
+/**
+ * Unique ID.
+ */
+uniqueId?: string
+/**
+ * ID of the item.
+ */
+id?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Product Ref ID.
+ */
+productRefId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Modal type.
+ */
+modalType?: (null | string)
+/**
+ * Parent item index.
+ */
+parentItemIndex?: (null | number)
+/**
+ * Parent assembly binding.
+ */
+parentAssemblyBinding?: (null | string)
+/**
+ * Price expiration date and time.
+ */
+priceValidUntil?: string
+/**
+ * Tax value in cents.
+ */
+tax?: number
+/**
+ * A unique identifier code assigned to a tax within the VTEX Admin.
+ */
+taxCode?: string
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Manual price in cents.
+ */
+manualPrice?: (null | number)
+/**
+ * User that applied the manual price, if that is the case.
+ */
+manualPriceAppliedBy?: (null | string)
+/**
+ * Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
+ */
+sellingPrice?: number
+/**
+ * Reward value in cents.
+ */
+rewardValue?: number
+/**
+ * Indicates whether item is a gift.
+ */
+isGift?: boolean
+/**
+ * Additional information.
+ */
+additionalInfo?: {
+/**
+ * Dimension.
+ */
+dimension?: (null | string)
+/**
+ * Brand name.
+ */
+brandName?: string
+/**
+ * Brand ID.
+ */
+brandId?: string
+/**
+ * Offering information.
+ */
+offeringInfo?: (null | string)
+/**
+ * Offering type.
+ */
+offeringType?: (null | string)
+/**
+ * Offering type ID.
+ */
+offeringTypeId?: (null | string)
+}
+/**
+ * Presale date.
+ */
+preSaleDate?: (null | string)
+/**
+ * Product category IDs.
+ */
+productCategoryIds?: string
+/**
+ * Object, where each field is an ID from `productCategoryIds`.
+ */
+productCategories?: {
+/**
+ * Product category corresponding to the ID in the field key.
+ */
+"{ID}"?: string
+}
+/**
+ * Quantity.
+ */
+quantity?: number
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
+ */
+sellerChain?: string[]
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+/**
+ * Information on services sold along with the SKU. Example: a gift package.
+ */
+bundleItems?: {
+/**
+ * Service type.
+ */
+type?: string
+/**
+ * Service identifier.
+ */
+id?: number
+/**
+ * Service name.
+ */
+name?: string
+/**
+ * Service price in cents.
+ */
+price?: number
+}[]
+/**
+ * Array containing information on attachments.
+ */
+attachments?: string[]
+/**
+ * Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.
+ */
+priceTags?: {
+/**
+ * Promotion unique identifier.
+ */
+identifier?: (null | string)
+/**
+ * Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.
+ */
+isPercentual?: boolean
+/**
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
+ * - `calculationId` is a hash that may vary with each price calculation.
+ */
+name?: string
+/**
+ * Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.
+ */
+rawValue?: number
+/**
+ * Price tag value representing either a promotion (value decrease) or a tax (value increase).
+ */
+value?: number
+}[]
+/**
+ * Availability.
+ */
+availability?: string
+/**
+ * Measurement unit.
+ */
+measurementUnit?: string
+/**
+ * Unit multiplier.
+ */
+unitMultiplier?: number
+/**
+ * Manufacturer code.
+ */
+manufacturerCode?: (null | string)
+/**
+ * Price information for all units of a specific item.
+ */
+priceDefinition?: {
+/**
+ * Item's calculated unitary selling price in cents.
+ */
+calculatedSellingPrice?: number
+/**
+ * Total value for all units of the item in cents.
+ */
+total?: number
+/**
+ * Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
+ */
+sellingPrices?: {
+/**
+ * Value in cents for that specific rounding.
+ */
+value?: number
+/**
+ * Rounding quantity, meaning how many items are rounded to this value.
+ */
+quantity?: number
+}[]
+}
+}[]
+/**
+ * Array containing the data of the item selected as a gift.
+ */
+selectableGifts?: string[]
+/**
+ * Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).
+ */
+totalizers?: {
+
+}[]
+/**
+ * Shipping information pertinent to the order.
+ */
+shippingData?: (null | {
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.
+ */
+logisticsInfo?: {
+/**
+ * Index corresponding to the position of the object in the `items` array.
+ */
+itemIndex?: number
+/**
+ * SLA selected by the customer.
+ */
+selectedSla?: (null | string)
+/**
+ * Delivery channel selected by the customer.
+ */
+selectedDeliveryChannel?: (null | string)
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Information on available SLAs.
+ */
+slas?: {
+/**
+ * SLA ID.
+ */
+id?: string
+/**
+ * Delivery channel.
+ */
+deliveryChannel?: string
+/**
+ * SLA name.
+ */
+name?: string
+/**
+ * Information on each delivery ID.
+ */
+deliveryIds?: {
+/**
+ * Courier ID.
+ */
+courierId?: string
+/**
+ * Warehouse ID.
+ */
+warehouseId?: string
+/**
+ * Warehouse ID.
+ */
+dockId?: string
+/**
+ * Courier name.
+ */
+courierName?: string
+/**
+ * Quantity.
+ */
+quantity?: number
+}[]
+/**
+ * List of attachments details.
+ */
+attachmentOfferings?: (null | {
+/**
+ * Name of the attachment.
+ */
+name: (null | string)
+/**
+ * Defines if the attachment is required (`true`) or not (`false`).
+ */
+required: (null | boolean)
+/**
+ * Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).
+ */
+schema: (null | {
+
+})
+}[])
+/**
+ * Shipping estimate. For instance, "three business days" will be represented as `3bd`.
+ */
+shippingEstimate?: string
+/**
+ * When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.
+ */
+shippingEstimateDate?: (null | string)
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+useIndividualShippingEstimates?: boolean
+/**
+ * Estimate date of delivery.
+ */
+lockTTL?: (null | string)
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Tax in cents.
+ */
+tax?: number
+/**
+ * Information on the pickup store.
+ */
+pickupStoreInfo?: {
+/**
+ * Indicates whether it is the pickup store.
+ */
+isPickupStore?: boolean
+/**
+ * Friendly name.
+ */
+friendlyName?: (null | string)
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that repesent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Additional information.
+ */
+additionalInfo?: (null | string)
+/**
+ * Corresponding dock ID.
+ */
+dockId?: (null | string)
+}
+/**
+ * Pickup point ID.
+ */
+pickupPointId?: (null | string)
+/**
+ * Pickup point distance.
+ */
+pickupDistance?: number
+/**
+ * Polygon name.
+ */
+polygonName?: (null | string)
+/**
+ * Transit time. For instance, "three business days" is represented as `3bd`.
+ */
+transitTime?: string
+}[]
+/**
+ * List of countries that the item may be shipped to.
+ */
+shipsTo?: string[]
+/**
+ * Item ID.
+ */
+itemId?: string
+/**
+ * List of available delivery channels.
+ */
+deliveryChannels?: {
+/**
+ * Delivery channel ID.
+ */
+id?: string
+}[]
+}[]
+/**
+ * Array with information on the selected addresses for the order.
+ */
+selectedAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * Array with information on the available addresses for the order.
+ */
+availableAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+})
+/**
+ * Customer's profile information.
+ */
+clientProfileData?: (null | {
+/**
+ * Email address.
+ */
+email?: (null | string)
+/**
+ * First name.
+ */
+firstName?: (null | string)
+/**
+ * Last name.
+ */
+lastName?: string
+/**
+ * Type of the document informed by the customer.
+ */
+documentType?: string
+/**
+ * Document informed by the customer.
+ */
+document?: string
+/**
+ * Phone number.
+ */
+phone?: string
+/**
+ * Company name, if the customer is a legal entity.
+ */
+corporateName?: (null | string)
+/**
+ * Trade name, if the customer is a legal entity.
+ */
+tradeName?: (null | string)
+/**
+ * Corporate document, if the customer is a legal entity.
+ */
+corporateDocument?: (null | string)
+/**
+ * State inscription, if the customer is a legal entity.
+ */
+stateInscription?: (null | string)
+/**
+ * Corporate phone number, if the customer is a legal entity.
+ */
+corporatePhone?: (null | string)
+/**
+ * Indicates whether the customer is a legal entity.
+ */
+isCorporate?: boolean
+/**
+ * Indicates whether profile is complete on loading.
+ */
+profileCompleteOnLoading?: boolean
+/**
+ * Indicates whether profile presents error on loading.
+ */
+profileErrorOnLoading?: (null | boolean)
+/**
+ * Customer class.
+ */
+customerClass?: (null | string)
+})
+/**
+ * Information on the order's payment.
+ */
+paymentData?: {
+/**
+ * Gift card information, if it applies to the order.
+ */
+giftCards?: {
+/**
+ * Gift card redemption code.
+ */
+redemptionCode?: string
+/**
+ * Gift card value in cents.
+ */
+value?: number
+/**
+ * Gift card balance in cents.
+ */
+balance?: number
+/**
+ * Gift card name.
+ */
+name?: string
+/**
+ * Gift card ID.
+ */
+id?: string
+/**
+ * Indicates whether gift card is in use.
+ */
+inUse?: boolean
+/**
+ * Indicates whether gift card is special.
+ */
+isSpecialCard?: boolean
+}[]
+/**
+ * Information on each transaction pertinent to the order.
+ */
+transactions?: (null | {
+/**
+ * Indicates whether transaction is active.
+ */
+isActive?: boolean
+/**
+ * Transaction ID.
+ */
+transactionId?: string
+/**
+ * Merchant name.
+ */
+merchantName?: string
+/**
+ * Information on each payment.
+ */
+payments?: {
+/**
+ * Account ID.
+ */
+accountId?: string
+/**
+ * Bin.
+ */
+bin?: (null | string)
+/**
+ * Number of installments.
+ */
+installments?: number
+/**
+ * Payment system.
+ */
+paymentSystem?: string
+/**
+ * Reference value for calculating interest rates, in case it applies. Displayed in cents.
+ */
+referenceValue?: number
+/**
+ * Value including interest, in case it applies. Displayed in cents.
+ */
+value?: number
+}[]
+/**
+ * Indicates whather transaction is shared.
+ */
+sharedTransaction?: boolean
+})[]
+}
+/**
+ * Object containing promotion data such as coupon tracking information and internal or external UTMs.
+ */
+marketingData?: (null | {
+/**
+ * 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.
+ */
+coupon?: string
+/**
+ * UTM source.
+ */
+utmSource?: string
+/**
+ * UTM medium.
+ */
+utmMedium?: string
+/**
+ * UTM campaign.
+ */
+utmCampaign?: string
+/**
+ * utmi_page (internal utm).
+ */
+utmiPage?: (null | string)
+/**
+ * utmi_part (internal utm).
+ */
+utmiPart?: (null | string)
+/**
+ * utmi_campaign (internal utm).
+ */
+utmiCampaign?: (null | string)
+})
+/**
+ * Information on each seller.
+ */
+sellers?: {
+/**
+ * Seller ID.
+ */
+id?: string
+/**
+ * Seller name.
+ */
+name?: string
+/**
+ * Seller logo.
+ */
+logo?: (null | string)
+}[]
+/**
+ * Object containing preferences from the client who placed the order.
+ */
+clientPreferencesData?: {
+/**
+ * Client's locale. Examples: `pt-BR` and `en-US`.
+ */
+locale?: string
+/**
+ * `true` if the client opted to receive newsletter from the store.
+ */
+optinNewsLetter?: (null | boolean)
+}
+/**
+ * Object containing commercial condition information.
+ */
+commercialConditionData?: (null | {
+
+})
+/**
+ * Object containing data from the store's configuration (stored in VTEX's License Manager).
+ */
+storePreferencesData?: {
+
+}
+/**
+ * Gift registry list information.
+ */
+giftRegistryData?: (null | {
+
+})
+/**
+ * Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).
+ */
+openTextField?: (null | string)
+/**
+ * Invoice data including billing address.
+ */
+invoiceData?: (null | {
+/**
+ * Billing address.
+ */
+address?: {
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City name.
+ */
+city?: string
+/**
+ * State name.
+ */
+state?: string
+/**
+ * Country.
+ */
+country?: string
+/**
+ * Street name.
+ */
+street?: string
+/**
+ * Street number.
+ */
+number?: string
+/**
+ * Neighborhood.
+ */
+neighborhood?: string
+/**
+ * Address complement.
+ */
+complement?: string
+/**
+ * Reference for location.
+ */
+reference?: string
+/**
+ * Geographic coordinates (latitude, longitude).
+ */
+geoCoordinates?: number[]
+}
+})
+/**
+ * Customer additional information.
+ */
+customData?: (null | {
+
+})
+/**
+ * Item metadata.
+ */
+itemMetadata?: {
+/**
+ * List of objects containing metadata on each item in the order.
+ */
+items?: {
+/**
+ * Item ID.
+ */
+id?: string
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+}[]
+}
+/**
+ * Hooks information.
+ */
+hooksData?: (null | {
+
+})
+/**
+ * Information on rates and benefits that apply to the order.
+ */
+ratesAndBenefitsData?: {
+/**
+ * List with rates and benefits identifiers.
+ */
+rateAndBenefitsIdentifiers?: string[]
+/**
+ * List with rates and benefits teasers.
+ */
+teaser?: string[]
+}
+/**
+ * Subscription information.
+ */
+subscriptionData?: (null | {
+
+})
+/**
+ * Object containing information about the ordering of items within the `orderForm`.
+ */
+itemsOrdination?: {
+/**
+ * Criteria adopted to order the items in the list.
+ */
+criteria?: string
+/**
+ * Indicates whether the ordering is ascending.
+ */
+ascending?: boolean
+}
+}
+}
+/**
+ * Retrieves 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).
+ * 
+ * >⚠️ 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Shopping Cart Full Access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Checkout Admin | Shopping Cart Full Access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).
+ * 
+ * To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ */
+"GET /api/checkout/pub/profiles": {
+searchParams: {
+/**
+ * Client's email address to be searched.
+ */
+email: string
+/**
+ * Indicates whether the returned profiles must be complete or not.
+ */
+ensureComplete?: boolean
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+response: {
+/**
+ * Unique ID associated with the customer profile.
+ */
+userProfileId?: string
+/**
+ * Profile provider.
+ */
+profileProvider?: string
+/**
+ * Available accounts.
+ */
+availableAccounts?: string[]
+/**
+ * Information on each available address.
+ */
+availableAddresses?: {
+/**
+ * Address type.
+ */
+addressType?: string
+/**
+ * Name of the receiver.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * City of the address.
+ */
+city?: string
+/**
+ * State of the address.
+ */
+state?: string
+/**
+ * Country of the address. ISO three-letter code.
+ */
+country?: string
+/**
+ * Street of the address.
+ */
+street?: string
+/**
+ * Number of the address.
+ */
+number?: string
+/**
+ * Neighborhood of the address.
+ */
+neighborhood?: string
+/**
+ * Complement to the address.
+ */
+complement?: (null | string)
+/**
+ * Reference that may help in the location of the address.
+ */
+reference?: (null | string)
+/**
+ * Array containing two floats with geocoordinates, first longitude, then latitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * Customer profile information.
+ */
+userProfile?: {
+/**
+ * Email address.
+ */
+email?: (null | string)
+/**
+ * First name.
+ */
+firstName?: (null | string)
+/**
+ * Last name.
+ */
+lastName?: string
+/**
+ * Document.
+ */
+document?: string
+/**
+ * Document type.
+ */
+documentType?: string
+/**
+ * Telephone number.
+ */
+phone?: string
+/**
+ * Name of the company. Used for corporate clients.
+ */
+corporateName?: (null | string)
+/**
+ * Trade name. Used for corporate clients.
+ */
+tradeName?: (null | string)
+/**
+ * Document. Used for corporate clients.
+ */
+corporateDocument?: (null | string)
+/**
+ * State inscription. Used for corporate clients.
+ */
+stateInscription?: (null | string)
+/**
+ * Telephone number. Used for corporate clients.
+ */
+corporatePhone?: (null | string)
+/**
+ * Indicates whether the client is corporate.
+ */
+isCorporate?: boolean
+/**
+ * Profile complete when loading.
+ */
+profileCompleteOnLoading?: (null | boolean)
+/**
+ * Profile error when loading.
+ */
+profileErrorOnLoading?: (null | boolean)
+/**
+ * Customer class.
+ */
+customerClass?: (null | string)
+}
+/**
+ * Indicates whether customer profile is complete.
+ */
+isComplete?: boolean
+}
+}
+/**
+ * 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.
+ * 
+ * >⚠️ 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"POST /api/checkout/pub/orderForm/:orderFormId/attachments/clientProfileData": {
+searchParams: {
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+/**
+ * Customer's profile information.
+ */
+body: {
+/**
+ * Customer's email address.
+ */
+email: (null | string)
+/**
+ * Customer's first name.
+ */
+firstName: (null | string)
+/**
+ * Customer's last name.
+ */
+lastName: string
+/**
+ * Type of the document informed by the customer.
+ */
+documentType: string
+/**
+ * Document number informed by the customer.
+ */
+document: string
+/**
+ * Customer's phone number.
+ */
+phone?: string
+/**
+ * Company name, if the customer is a legal entity.
+ */
+corporateName?: string
+/**
+ * Trade name, if the customer is a legal entity.
+ */
+tradeName?: string
+/**
+ * Corporate document, if the customer is a legal entity.
+ */
+corporateDocument?: string
+/**
+ * State inscription, if the customer is a legal entity.
+ */
+stateInscription?: string
+/**
+ * Corporate phone number, if the customer is a legal entity.
+ */
+corporatePhone?: string
+/**
+ * Set `true` if the customer is a legal entity.
+ */
+isCorporate?: boolean
+}
+response: {
+/**
+ * ID of the orderForm corresponding to a specific cart.
+ */
+orderFormId?: string
+/**
+ * Attribute created by the seller, in their VTEX store configuration.
+ */
+salesChannel?: string
+/**
+ * Indicates whether the user is logged into the store.
+ */
+loggedIn?: boolean
+/**
+ * Indicates whether order is checked in.
+ */
+isCheckedIn?: boolean
+/**
+ * ID of the store.
+ */
+storeId?: (null | string)
+/**
+ * Permission to modify item price manually.
+ */
+allowManualPrice?: boolean
+/**
+ * Data can be edited.
+ */
+canEditData?: boolean
+/**
+ * Unique ID associated with the customer profile.
+ */
+userProfileId?: string
+/**
+ * Profile provider.
+ */
+profileProvider?: string
+/**
+ * Available accounts.
+ */
+availableAccounts?: string[]
+/**
+ * Information on each available address.
+ */
+availableAddresses?: {
+/**
+ * Address type.
+ */
+addressType?: string
+/**
+ * Name of the receiver.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * City of the address.
+ */
+city?: string
+/**
+ * State of the address.
+ */
+state?: string
+/**
+ * Country of the address. ISO three-letter code.
+ */
+country?: string
+/**
+ * Street of the address.
+ */
+street?: string
+/**
+ * Number of the address.
+ */
+number?: string
+/**
+ * Neighborhood of the address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Reference that may help in the location of the address.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * User type.
+ */
+userType?: (null | string)
+/**
+ * Ignore customer profile data.
+ */
+ignoreProfileData?: boolean
+/**
+ * Total value of the order without separating cents. For example, $24.99 is represented as `2499`.
+ */
+value?: number
+/**
+ * Array containing an object for each message generated by our servers while processing the request.
+ */
+messages?: string[]
+/**
+ * Information on each item in the order.
+ */
+items?: {
+/**
+ * Unique ID.
+ */
+uniqueId?: string
+/**
+ * ID of the item.
+ */
+id?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Product Ref ID.
+ */
+productRefId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Modal type.
+ */
+modalType?: (null | string)
+/**
+ * Parent item index.
+ */
+parentItemIndex?: (null | number)
+/**
+ * Parent assembly binding.
+ */
+parentAssemblyBinding?: (null | string)
+/**
+ * Price expiration date and time.
+ */
+priceValidUntil?: string
+/**
+ * Tax value in cents.
+ */
+tax?: number
+/**
+ * A unique identifier code assigned to a tax within the VTEX Admin.
+ */
+taxCode?: string
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Manual price in cents.
+ */
+manualPrice?: (null | number)
+/**
+ * User that applied the manual price, if that is the case.
+ */
+manualPriceAppliedBy?: (null | string)
+/**
+ * Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
+ */
+sellingPrice?: number
+/**
+ * Reward value in cents.
+ */
+rewardValue?: number
+/**
+ * Indicates whether item is a gift.
+ */
+isGift?: boolean
+/**
+ * Additional information.
+ */
+additionalInfo?: {
+/**
+ * Dimension.
+ */
+dimension?: (null | string)
+/**
+ * Brand name.
+ */
+brandName?: string
+/**
+ * Brand ID.
+ */
+brandId?: string
+/**
+ * Offering information.
+ */
+offeringInfo?: (null | string)
+/**
+ * Offering type.
+ */
+offeringType?: (null | string)
+/**
+ * Offering type ID.
+ */
+offeringTypeId?: (null | string)
+}
+/**
+ * Presale date.
+ */
+preSaleDate?: (null | string)
+/**
+ * Product category IDs.
+ */
+productCategoryIds?: string
+/**
+ * Object, where each field is an ID from `productCategoryIds`.
+ */
+productCategories?: {
+/**
+ * Product category corresponding to the ID in the field key.
+ */
+"{ID}"?: string
+}
+/**
+ * Quantity.
+ */
+quantity?: number
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
+ */
+sellerChain?: string[]
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+/**
+ * Information on services sold along with the SKU. Example: a gift package.
+ */
+bundleItems?: {
+/**
+ * Service type.
+ */
+type?: string
+/**
+ * Service identifier.
+ */
+id?: number
+/**
+ * Service name.
+ */
+name?: string
+/**
+ * Service price in cents.
+ */
+price?: number
+}[]
+/**
+ * Array containing information on attachments.
+ */
+attachments?: string[]
+/**
+ * Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.
+ */
+priceTags?: {
+/**
+ * Promotion unique identifier.
+ */
+identifier?: (null | string)
+/**
+ * Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.
+ */
+isPercentual?: boolean
+/**
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
+ * - `calculationId` is a hash that may vary with each price calculation.
+ */
+name?: string
+/**
+ * Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.
+ */
+rawValue?: number
+/**
+ * Price tag value representing either a promotion (value decrease) or a tax (value increase).
+ */
+value?: number
+}[]
+/**
+ * Availability.
+ */
+availability?: string
+/**
+ * Measurement unit.
+ */
+measurementUnit?: string
+/**
+ * Unit multiplier.
+ */
+unitMultiplier?: number
+/**
+ * Manufacturer code.
+ */
+manufacturerCode?: (null | string)
+/**
+ * Price information for all units of a specific item.
+ */
+priceDefinition?: {
+/**
+ * Item's calculated unitary selling price in cents.
+ */
+calculatedSellingPrice?: number
+/**
+ * Total value for all units of the item in cents.
+ */
+total?: number
+/**
+ * Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
+ */
+sellingPrices?: {
+/**
+ * Value in cents for that specific rounding.
+ */
+value?: number
+/**
+ * Rounding quantity, meaning how many items are rounded to this value.
+ */
+quantity?: number
+}[]
+}
+}[]
+/**
+ * Array containing the data of the item selected as a gift.
+ */
+selectableGifts?: string[]
+/**
+ * Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).
+ */
+totalizers?: {
+
+}[]
+/**
+ * Shipping information pertinent to the order.
+ */
+shippingData?: (null | {
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.
+ */
+logisticsInfo?: {
+/**
+ * Index corresponding to the position of the object in the `items` array.
+ */
+itemIndex?: number
+/**
+ * SLA selected by the customer.
+ */
+selectedSla?: (null | string)
+/**
+ * Delivery channel selected by the customer.
+ */
+selectedDeliveryChannel?: (null | string)
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Information on available SLAs.
+ */
+slas?: {
+/**
+ * SLA ID.
+ */
+id?: string
+/**
+ * Delivery channel.
+ */
+deliveryChannel?: string
+/**
+ * SLA name.
+ */
+name?: string
+/**
+ * Information on each delivery ID.
+ */
+deliveryIds?: {
+/**
+ * Courier ID.
+ */
+courierId?: string
+/**
+ * Warehouse ID.
+ */
+warehouseId?: string
+/**
+ * Warehouse ID.
+ */
+dockId?: string
+/**
+ * Courier name.
+ */
+courierName?: string
+/**
+ * Quantity.
+ */
+quantity?: number
+}[]
+/**
+ * List of attachments details.
+ */
+attachmentOfferings?: (null | {
+/**
+ * Name of the attachment.
+ */
+name: (null | string)
+/**
+ * Defines if the attachment is required (`true`) or not (`false`).
+ */
+required: (null | boolean)
+/**
+ * Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).
+ */
+schema: (null | {
+
+})
+}[])
+/**
+ * Shipping estimate. For instance, "three business days" will be represented as `3bd`.
+ */
+shippingEstimate?: string
+/**
+ * When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.
+ */
+shippingEstimateDate?: (null | string)
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+useIndividualShippingEstimates?: boolean
+/**
+ * Estimate date of delivery.
+ */
+lockTTL?: (null | string)
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Tax in cents.
+ */
+tax?: number
+/**
+ * Information on the pickup store.
+ */
+pickupStoreInfo?: {
+/**
+ * Indicates whether it is the pickup store.
+ */
+isPickupStore?: boolean
+/**
+ * Friendly name.
+ */
+friendlyName?: (null | string)
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that repesent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Additional information.
+ */
+additionalInfo?: (null | string)
+/**
+ * Corresponding dock ID.
+ */
+dockId?: (null | string)
+}
+/**
+ * Pickup point ID.
+ */
+pickupPointId?: (null | string)
+/**
+ * Pickup point distance.
+ */
+pickupDistance?: number
+/**
+ * Polygon name.
+ */
+polygonName?: (null | string)
+/**
+ * Transit time. For instance, "three business days" is represented as `3bd`.
+ */
+transitTime?: string
+}[]
+/**
+ * List of countries that the item may be shipped to.
+ */
+shipsTo?: string[]
+/**
+ * Item ID.
+ */
+itemId?: string
+/**
+ * List of available delivery channels.
+ */
+deliveryChannels?: {
+/**
+ * Delivery channel ID.
+ */
+id?: string
+}[]
+}[]
+/**
+ * Array with information on the selected addresses for the order.
+ */
+selectedAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * Array with information on the available addresses for the order.
+ */
+availableAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+})
+/**
+ * Customer's profile information.
+ */
+clientProfileData?: (null | {
+/**
+ * Email address.
+ */
+email?: (null | string)
+/**
+ * First name.
+ */
+firstName?: (null | string)
+/**
+ * Last name.
+ */
+lastName?: string
+/**
+ * Type of the document informed by the customer.
+ */
+documentType?: string
+/**
+ * Document informed by the customer.
+ */
+document?: string
+/**
+ * Phone number.
+ */
+phone?: string
+/**
+ * Company name, if the customer is a legal entity.
+ */
+corporateName?: (null | string)
+/**
+ * Trade name, if the customer is a legal entity.
+ */
+tradeName?: (null | string)
+/**
+ * Corporate document, if the customer is a legal entity.
+ */
+corporateDocument?: (null | string)
+/**
+ * State inscription, if the customer is a legal entity.
+ */
+stateInscription?: (null | string)
+/**
+ * Corporate phone number, if the customer is a legal entity.
+ */
+corporatePhone?: (null | string)
+/**
+ * Indicates whether the customer is a legal entity.
+ */
+isCorporate?: boolean
+/**
+ * Indicates whether profile is complete on loading.
+ */
+profileCompleteOnLoading?: boolean
+/**
+ * Indicates whether profile presents error on loading.
+ */
+profileErrorOnLoading?: (null | boolean)
+/**
+ * Customer class.
+ */
+customerClass?: (null | string)
+})
+/**
+ * Information on the order's payment.
+ */
+paymentData?: {
+/**
+ * Gift card information, if it applies to the order.
+ */
+giftCards?: {
+/**
+ * Gift card redemption code.
+ */
+redemptionCode?: string
+/**
+ * Gift card value in cents.
+ */
+value?: number
+/**
+ * Gift card balance in cents.
+ */
+balance?: number
+/**
+ * Gift card name.
+ */
+name?: string
+/**
+ * Gift card ID.
+ */
+id?: string
+/**
+ * Indicates whether gift card is in use.
+ */
+inUse?: boolean
+/**
+ * Indicates whether gift card is special.
+ */
+isSpecialCard?: boolean
+}[]
+/**
+ * Information on each transaction pertinent to the order.
+ */
+transactions?: (null | {
+/**
+ * Indicates whether transaction is active.
+ */
+isActive?: boolean
+/**
+ * Transaction ID.
+ */
+transactionId?: string
+/**
+ * Merchant name.
+ */
+merchantName?: string
+/**
+ * Information on each payment.
+ */
+payments?: {
+/**
+ * Account ID.
+ */
+accountId?: string
+/**
+ * Bin.
+ */
+bin?: (null | string)
+/**
+ * Number of installments.
+ */
+installments?: number
+/**
+ * Payment system.
+ */
+paymentSystem?: string
+/**
+ * Reference value for calculating interest rates, in case it applies. Displayed in cents.
+ */
+referenceValue?: number
+/**
+ * Value including interest, in case it applies. Displayed in cents.
+ */
+value?: number
+}[]
+/**
+ * Indicates whather transaction is shared.
+ */
+sharedTransaction?: boolean
+})[]
+}
+/**
+ * Object containing promotion data such as coupon tracking information and internal or external UTMs.
+ */
+marketingData?: (null | {
+/**
+ * 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.
+ */
+coupon?: string
+/**
+ * UTM source.
+ */
+utmSource?: string
+/**
+ * UTM medium.
+ */
+utmMedium?: string
+/**
+ * UTM campaign.
+ */
+utmCampaign?: string
+/**
+ * utmi_page (internal utm).
+ */
+utmiPage?: (null | string)
+/**
+ * utmi_part (internal utm).
+ */
+utmiPart?: (null | string)
+/**
+ * utmi_campaign (internal utm).
+ */
+utmiCampaign?: (null | string)
+})
+/**
+ * Information on each seller.
+ */
+sellers?: {
+/**
+ * Seller ID.
+ */
+id?: string
+/**
+ * Seller name.
+ */
+name?: string
+/**
+ * Seller logo.
+ */
+logo?: (null | string)
+}[]
+/**
+ * Object containing preferences from the client who placed the order.
+ */
+clientPreferencesData?: {
+/**
+ * Client's locale. Examples: `pt-BR` and `en-US`.
+ */
+locale?: string
+/**
+ * `true` if the client opted to receive newsletter from the store.
+ */
+optinNewsLetter?: (null | boolean)
+}
+/**
+ * Object containing commercial condition information.
+ */
+commercialConditionData?: (null | {
+
+})
+/**
+ * Object containing data from the store's configuration (stored in VTEX's License Manager).
+ */
+storePreferencesData?: {
+
+}
+/**
+ * Gift registry list information.
+ */
+giftRegistryData?: (null | {
+
+})
+/**
+ * Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).
+ */
+openTextField?: (null | string)
+/**
+ * Invoice data including billing address.
+ */
+invoiceData?: (null | {
+/**
+ * Billing address.
+ */
+address?: {
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City name.
+ */
+city?: string
+/**
+ * State name.
+ */
+state?: string
+/**
+ * Country.
+ */
+country?: string
+/**
+ * Street name.
+ */
+street?: string
+/**
+ * Street number.
+ */
+number?: string
+/**
+ * Neighborhood.
+ */
+neighborhood?: string
+/**
+ * Address complement.
+ */
+complement?: string
+/**
+ * Reference for location.
+ */
+reference?: string
+/**
+ * Geographic coordinates (latitude, longitude).
+ */
+geoCoordinates?: number[]
+}
+})
+/**
+ * Customer additional information.
+ */
+customData?: (null | {
+
+})
+/**
+ * Item metadata.
+ */
+itemMetadata?: {
+/**
+ * List of objects containing metadata on each item in the order.
+ */
+items?: {
+/**
+ * Item ID.
+ */
+id?: string
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+}[]
+}
+/**
+ * Hooks information.
+ */
+hooksData?: (null | {
+
+})
+/**
+ * Information on rates and benefits that apply to the order.
+ */
+ratesAndBenefitsData?: {
+/**
+ * List with rates and benefits identifiers.
+ */
+rateAndBenefitsIdentifiers?: string[]
+/**
+ * List with rates and benefits teasers.
+ */
+teaser?: string[]
+}
+/**
+ * Subscription information.
+ */
+subscriptionData?: (null | {
+
+})
+/**
+ * Object containing information about the ordering of items within the `orderForm`.
+ */
+itemsOrdination?: {
+/**
+ * Criteria adopted to order the items in the list.
+ */
+criteria?: string
+/**
+ * Indicates whether the ordering is ascending.
+ */
+ascending?: 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.
+ * 
+ * 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.
+ * 
+ * >⚠️ 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"POST /api/checkout/pub/orderForm/:orderFormId/attachments/shippingData": {
+searchParams: {
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+body: {
+/**
+ * This field should be sent as `false` to prevent the address information from being filled in automatically based on the `postalCode` information.
+ */
+clearAddressIfPostalCodeNotFound?: boolean
+/**
+ * List of objects with addresses information.
+ */
+selectedAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`, among others.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Postal Code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: string
+/**
+ * Array containing two floats with geocoordinates, first longitude, then latitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * Array with logistics information on each item of the `items` array in the `orderForm`.
+ */
+logisticsInfo?: {
+/**
+ * Index of item in items array.
+ */
+itemIndex?: number
+/**
+ * Delivery channel selected by the customer. For example, `"delivery"` or `"pickup-in-point"`.
+ */
+selectedDeliveryChannel?: (null | string)
+/**
+ * Selected SLA. For example, `"normal"` or `"express"`.
+ */
+selectedSla?: (null | string)
+}[]
+}
+response: {
+/**
+ * ID of the orderForm corresponding to a specific cart.
+ */
+orderFormId?: string
+/**
+ * Attribute created by the seller, in their VTEX store configuration.
+ */
+salesChannel?: string
+/**
+ * Indicates whether the user is logged into the store.
+ */
+loggedIn?: boolean
+/**
+ * Indicates whether order is checked in.
+ */
+isCheckedIn?: boolean
+/**
+ * ID of the store.
+ */
+storeId?: (null | string)
+/**
+ * Permission to modify item price manually.
+ */
+allowManualPrice?: boolean
+/**
+ * Data can be edited.
+ */
+canEditData?: boolean
+/**
+ * Unique ID associated with the customer profile.
+ */
+userProfileId?: string
+/**
+ * Profile provider.
+ */
+profileProvider?: string
+/**
+ * Available accounts.
+ */
+availableAccounts?: string[]
+/**
+ * Information on each available address.
+ */
+availableAddresses?: {
+/**
+ * Address type.
+ */
+addressType?: string
+/**
+ * Name of the receiver.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * City of the address.
+ */
+city?: string
+/**
+ * State of the address.
+ */
+state?: string
+/**
+ * Country of the address. ISO three-letter code.
+ */
+country?: string
+/**
+ * Street of the address.
+ */
+street?: string
+/**
+ * Number of the address.
+ */
+number?: string
+/**
+ * Neighborhood of the address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Reference that may help in the location of the address.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * User type.
+ */
+userType?: (null | string)
+/**
+ * Ignore customer profile data.
+ */
+ignoreProfileData?: boolean
+/**
+ * Total value of the order without separating cents. For example, $24.99 is represented as `2499`.
+ */
+value?: number
+/**
+ * Array containing an object for each message generated by our servers while processing the request.
+ */
+messages?: string[]
+/**
+ * Information on each item in the order.
+ */
+items?: {
+/**
+ * Unique ID.
+ */
+uniqueId?: string
+/**
+ * ID of the item.
+ */
+id?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Product Ref ID.
+ */
+productRefId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Modal type.
+ */
+modalType?: (null | string)
+/**
+ * Parent item index.
+ */
+parentItemIndex?: (null | number)
+/**
+ * Parent assembly binding.
+ */
+parentAssemblyBinding?: (null | string)
+/**
+ * Price expiration date and time.
+ */
+priceValidUntil?: string
+/**
+ * Tax value in cents.
+ */
+tax?: number
+/**
+ * A unique identifier code assigned to a tax within the VTEX Admin.
+ */
+taxCode?: string
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Manual price in cents.
+ */
+manualPrice?: (null | number)
+/**
+ * User that applied the manual price, if that is the case.
+ */
+manualPriceAppliedBy?: (null | string)
+/**
+ * Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
+ */
+sellingPrice?: number
+/**
+ * Reward value in cents.
+ */
+rewardValue?: number
+/**
+ * Indicates whether item is a gift.
+ */
+isGift?: boolean
+/**
+ * Additional information.
+ */
+additionalInfo?: {
+/**
+ * Dimension.
+ */
+dimension?: (null | string)
+/**
+ * Brand name.
+ */
+brandName?: string
+/**
+ * Brand ID.
+ */
+brandId?: string
+/**
+ * Offering information.
+ */
+offeringInfo?: (null | string)
+/**
+ * Offering type.
+ */
+offeringType?: (null | string)
+/**
+ * Offering type ID.
+ */
+offeringTypeId?: (null | string)
+}
+/**
+ * Presale date.
+ */
+preSaleDate?: (null | string)
+/**
+ * Product category IDs.
+ */
+productCategoryIds?: string
+/**
+ * Object, where each field is an ID from `productCategoryIds`.
+ */
+productCategories?: {
+/**
+ * Product category corresponding to the ID in the field key.
+ */
+"{ID}"?: string
+}
+/**
+ * Quantity.
+ */
+quantity?: number
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
+ */
+sellerChain?: string[]
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+/**
+ * Information on services sold along with the SKU. Example: a gift package.
+ */
+bundleItems?: {
+/**
+ * Service type.
+ */
+type?: string
+/**
+ * Service identifier.
+ */
+id?: number
+/**
+ * Service name.
+ */
+name?: string
+/**
+ * Service price in cents.
+ */
+price?: number
+}[]
+/**
+ * Array containing information on attachments.
+ */
+attachments?: string[]
+/**
+ * Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.
+ */
+priceTags?: {
+/**
+ * Promotion unique identifier.
+ */
+identifier?: (null | string)
+/**
+ * Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.
+ */
+isPercentual?: boolean
+/**
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
+ * - `calculationId` is a hash that may vary with each price calculation.
+ */
+name?: string
+/**
+ * Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.
+ */
+rawValue?: number
+/**
+ * Price tag value representing either a promotion (value decrease) or a tax (value increase).
+ */
+value?: number
+}[]
+/**
+ * Availability.
+ */
+availability?: string
+/**
+ * Measurement unit.
+ */
+measurementUnit?: string
+/**
+ * Unit multiplier.
+ */
+unitMultiplier?: number
+/**
+ * Manufacturer code.
+ */
+manufacturerCode?: (null | string)
+/**
+ * Price information for all units of a specific item.
+ */
+priceDefinition?: {
+/**
+ * Item's calculated unitary selling price in cents.
+ */
+calculatedSellingPrice?: number
+/**
+ * Total value for all units of the item in cents.
+ */
+total?: number
+/**
+ * Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
+ */
+sellingPrices?: {
+/**
+ * Value in cents for that specific rounding.
+ */
+value?: number
+/**
+ * Rounding quantity, meaning how many items are rounded to this value.
+ */
+quantity?: number
+}[]
+}
+}[]
+/**
+ * Array containing the data of the item selected as a gift.
+ */
+selectableGifts?: string[]
+/**
+ * Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).
+ */
+totalizers?: {
+
+}[]
+/**
+ * Shipping information pertinent to the order.
+ */
+shippingData?: (null | {
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.
+ */
+logisticsInfo?: {
+/**
+ * Index corresponding to the position of the object in the `items` array.
+ */
+itemIndex?: number
+/**
+ * SLA selected by the customer.
+ */
+selectedSla?: (null | string)
+/**
+ * Delivery channel selected by the customer.
+ */
+selectedDeliveryChannel?: (null | string)
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Information on available SLAs.
+ */
+slas?: {
+/**
+ * SLA ID.
+ */
+id?: string
+/**
+ * Delivery channel.
+ */
+deliveryChannel?: string
+/**
+ * SLA name.
+ */
+name?: string
+/**
+ * Information on each delivery ID.
+ */
+deliveryIds?: {
+/**
+ * Courier ID.
+ */
+courierId?: string
+/**
+ * Warehouse ID.
+ */
+warehouseId?: string
+/**
+ * Warehouse ID.
+ */
+dockId?: string
+/**
+ * Courier name.
+ */
+courierName?: string
+/**
+ * Quantity.
+ */
+quantity?: number
+}[]
+/**
+ * List of attachments details.
+ */
+attachmentOfferings?: (null | {
+/**
+ * Name of the attachment.
+ */
+name: (null | string)
+/**
+ * Defines if the attachment is required (`true`) or not (`false`).
+ */
+required: (null | boolean)
+/**
+ * Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).
+ */
+schema: (null | {
+
+})
+}[])
+/**
+ * Shipping estimate. For instance, "three business days" will be represented as `3bd`.
+ */
+shippingEstimate?: string
+/**
+ * When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.
+ */
+shippingEstimateDate?: (null | string)
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+useIndividualShippingEstimates?: boolean
+/**
+ * Estimate date of delivery.
+ */
+lockTTL?: (null | string)
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Tax in cents.
+ */
+tax?: number
+/**
+ * Information on the pickup store.
+ */
+pickupStoreInfo?: {
+/**
+ * Indicates whether it is the pickup store.
+ */
+isPickupStore?: boolean
+/**
+ * Friendly name.
+ */
+friendlyName?: (null | string)
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that repesent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Additional information.
+ */
+additionalInfo?: (null | string)
+/**
+ * Corresponding dock ID.
+ */
+dockId?: (null | string)
+}
+/**
+ * Pickup point ID.
+ */
+pickupPointId?: (null | string)
+/**
+ * Pickup point distance.
+ */
+pickupDistance?: number
+/**
+ * Polygon name.
+ */
+polygonName?: (null | string)
+/**
+ * Transit time. For instance, "three business days" is represented as `3bd`.
+ */
+transitTime?: string
+}[]
+/**
+ * List of countries that the item may be shipped to.
+ */
+shipsTo?: string[]
+/**
+ * Item ID.
+ */
+itemId?: string
+/**
+ * List of available delivery channels.
+ */
+deliveryChannels?: {
+/**
+ * Delivery channel ID.
+ */
+id?: string
+}[]
+}[]
+/**
+ * Array with information on the selected addresses for the order.
+ */
+selectedAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * Array with information on the available addresses for the order.
+ */
+availableAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+})
+/**
+ * Customer's profile information.
+ */
+clientProfileData?: (null | {
+/**
+ * Email address.
+ */
+email?: (null | string)
+/**
+ * First name.
+ */
+firstName?: (null | string)
+/**
+ * Last name.
+ */
+lastName?: string
+/**
+ * Type of the document informed by the customer.
+ */
+documentType?: string
+/**
+ * Document informed by the customer.
+ */
+document?: string
+/**
+ * Phone number.
+ */
+phone?: string
+/**
+ * Company name, if the customer is a legal entity.
+ */
+corporateName?: (null | string)
+/**
+ * Trade name, if the customer is a legal entity.
+ */
+tradeName?: (null | string)
+/**
+ * Corporate document, if the customer is a legal entity.
+ */
+corporateDocument?: (null | string)
+/**
+ * State inscription, if the customer is a legal entity.
+ */
+stateInscription?: (null | string)
+/**
+ * Corporate phone number, if the customer is a legal entity.
+ */
+corporatePhone?: (null | string)
+/**
+ * Indicates whether the customer is a legal entity.
+ */
+isCorporate?: boolean
+/**
+ * Indicates whether profile is complete on loading.
+ */
+profileCompleteOnLoading?: boolean
+/**
+ * Indicates whether profile presents error on loading.
+ */
+profileErrorOnLoading?: (null | boolean)
+/**
+ * Customer class.
+ */
+customerClass?: (null | string)
+})
+/**
+ * Information on the order's payment.
+ */
+paymentData?: {
+/**
+ * Gift card information, if it applies to the order.
+ */
+giftCards?: {
+/**
+ * Gift card redemption code.
+ */
+redemptionCode?: string
+/**
+ * Gift card value in cents.
+ */
+value?: number
+/**
+ * Gift card balance in cents.
+ */
+balance?: number
+/**
+ * Gift card name.
+ */
+name?: string
+/**
+ * Gift card ID.
+ */
+id?: string
+/**
+ * Indicates whether gift card is in use.
+ */
+inUse?: boolean
+/**
+ * Indicates whether gift card is special.
+ */
+isSpecialCard?: boolean
+}[]
+/**
+ * Information on each transaction pertinent to the order.
+ */
+transactions?: (null | {
+/**
+ * Indicates whether transaction is active.
+ */
+isActive?: boolean
+/**
+ * Transaction ID.
+ */
+transactionId?: string
+/**
+ * Merchant name.
+ */
+merchantName?: string
+/**
+ * Information on each payment.
+ */
+payments?: {
+/**
+ * Account ID.
+ */
+accountId?: string
+/**
+ * Bin.
+ */
+bin?: (null | string)
+/**
+ * Number of installments.
+ */
+installments?: number
+/**
+ * Payment system.
+ */
+paymentSystem?: string
+/**
+ * Reference value for calculating interest rates, in case it applies. Displayed in cents.
+ */
+referenceValue?: number
+/**
+ * Value including interest, in case it applies. Displayed in cents.
+ */
+value?: number
+}[]
+/**
+ * Indicates whather transaction is shared.
+ */
+sharedTransaction?: boolean
+})[]
+}
+/**
+ * Object containing promotion data such as coupon tracking information and internal or external UTMs.
+ */
+marketingData?: (null | {
+/**
+ * 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.
+ */
+coupon?: string
+/**
+ * UTM source.
+ */
+utmSource?: string
+/**
+ * UTM medium.
+ */
+utmMedium?: string
+/**
+ * UTM campaign.
+ */
+utmCampaign?: string
+/**
+ * utmi_page (internal utm).
+ */
+utmiPage?: (null | string)
+/**
+ * utmi_part (internal utm).
+ */
+utmiPart?: (null | string)
+/**
+ * utmi_campaign (internal utm).
+ */
+utmiCampaign?: (null | string)
+})
+/**
+ * Information on each seller.
+ */
+sellers?: {
+/**
+ * Seller ID.
+ */
+id?: string
+/**
+ * Seller name.
+ */
+name?: string
+/**
+ * Seller logo.
+ */
+logo?: (null | string)
+}[]
+/**
+ * Object containing preferences from the client who placed the order.
+ */
+clientPreferencesData?: {
+/**
+ * Client's locale. Examples: `pt-BR` and `en-US`.
+ */
+locale?: string
+/**
+ * `true` if the client opted to receive newsletter from the store.
+ */
+optinNewsLetter?: (null | boolean)
+}
+/**
+ * Object containing commercial condition information.
+ */
+commercialConditionData?: (null | {
+
+})
+/**
+ * Object containing data from the store's configuration (stored in VTEX's License Manager).
+ */
+storePreferencesData?: {
+
+}
+/**
+ * Gift registry list information.
+ */
+giftRegistryData?: (null | {
+
+})
+/**
+ * Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).
+ */
+openTextField?: (null | string)
+/**
+ * Invoice data including billing address.
+ */
+invoiceData?: (null | {
+/**
+ * Billing address.
+ */
+address?: {
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City name.
+ */
+city?: string
+/**
+ * State name.
+ */
+state?: string
+/**
+ * Country.
+ */
+country?: string
+/**
+ * Street name.
+ */
+street?: string
+/**
+ * Street number.
+ */
+number?: string
+/**
+ * Neighborhood.
+ */
+neighborhood?: string
+/**
+ * Address complement.
+ */
+complement?: string
+/**
+ * Reference for location.
+ */
+reference?: string
+/**
+ * Geographic coordinates (latitude, longitude).
+ */
+geoCoordinates?: number[]
+}
+})
+/**
+ * Customer additional information.
+ */
+customData?: (null | {
+
+})
+/**
+ * Item metadata.
+ */
+itemMetadata?: {
+/**
+ * List of objects containing metadata on each item in the order.
+ */
+items?: {
+/**
+ * Item ID.
+ */
+id?: string
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+}[]
+}
+/**
+ * Hooks information.
+ */
+hooksData?: (null | {
+
+})
+/**
+ * Information on rates and benefits that apply to the order.
+ */
+ratesAndBenefitsData?: {
+/**
+ * List with rates and benefits identifiers.
+ */
+rateAndBenefitsIdentifiers?: string[]
+/**
+ * List with rates and benefits teasers.
+ */
+teaser?: string[]
+}
+/**
+ * Subscription information.
+ */
+subscriptionData?: (null | {
+
+})
+/**
+ * Object containing information about the ordering of items within the `orderForm`.
+ */
+itemsOrdination?: {
+/**
+ * Criteria adopted to order the items in the list.
+ */
+criteria?: string
+/**
+ * Indicates whether the ordering is ascending.
+ */
+ascending?: boolean
+}
+}
+}
+/**
+ * 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"POST /api/checkout/pub/orderForm/:orderFormId/attachments/clientPreferencesData": {
+searchParams: {
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+body: {
+/**
+ * Locale chosen by the shopper. Determines website language.
+ */
+locale?: string
+/**
+ * Indicates whether the shopper opted in to receive the store's news letter.
+ */
+optinNewsLetter?: (null | boolean)
+}
+response: {
+/**
+ * ID of the orderForm corresponding to a specific cart.
+ */
+orderFormId?: string
+/**
+ * Attribute created by the seller, in their VTEX store configuration.
+ */
+salesChannel?: string
+/**
+ * Indicates whether the user is logged into the store.
+ */
+loggedIn?: boolean
+/**
+ * Indicates whether order is checked in.
+ */
+isCheckedIn?: boolean
+/**
+ * ID of the store.
+ */
+storeId?: (null | string)
+/**
+ * Permission to modify item price manually.
+ */
+allowManualPrice?: boolean
+/**
+ * Data can be edited.
+ */
+canEditData?: boolean
+/**
+ * Unique ID associated with the customer profile.
+ */
+userProfileId?: string
+/**
+ * Profile provider.
+ */
+profileProvider?: string
+/**
+ * Available accounts.
+ */
+availableAccounts?: string[]
+/**
+ * Information on each available address.
+ */
+availableAddresses?: {
+/**
+ * Address type.
+ */
+addressType?: string
+/**
+ * Name of the receiver.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * City of the address.
+ */
+city?: string
+/**
+ * State of the address.
+ */
+state?: string
+/**
+ * Country of the address. ISO three-letter code.
+ */
+country?: string
+/**
+ * Street of the address.
+ */
+street?: string
+/**
+ * Number of the address.
+ */
+number?: string
+/**
+ * Neighborhood of the address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Reference that may help in the location of the address.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * User type.
+ */
+userType?: (null | string)
+/**
+ * Ignore customer profile data.
+ */
+ignoreProfileData?: boolean
+/**
+ * Total value of the order without separating cents. For example, $24.99 is represented as `2499`.
+ */
+value?: number
+/**
+ * Array containing an object for each message generated by our servers while processing the request.
+ */
+messages?: string[]
+/**
+ * Information on each item in the order.
+ */
+items?: {
+/**
+ * Unique ID.
+ */
+uniqueId?: string
+/**
+ * ID of the item.
+ */
+id?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Product Ref ID.
+ */
+productRefId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Modal type.
+ */
+modalType?: (null | string)
+/**
+ * Parent item index.
+ */
+parentItemIndex?: (null | number)
+/**
+ * Parent assembly binding.
+ */
+parentAssemblyBinding?: (null | string)
+/**
+ * Price expiration date and time.
+ */
+priceValidUntil?: string
+/**
+ * Tax value in cents.
+ */
+tax?: number
+/**
+ * A unique identifier code assigned to a tax within the VTEX Admin.
+ */
+taxCode?: string
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Manual price in cents.
+ */
+manualPrice?: (null | number)
+/**
+ * User that applied the manual price, if that is the case.
+ */
+manualPriceAppliedBy?: (null | string)
+/**
+ * Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
+ */
+sellingPrice?: number
+/**
+ * Reward value in cents.
+ */
+rewardValue?: number
+/**
+ * Indicates whether item is a gift.
+ */
+isGift?: boolean
+/**
+ * Additional information.
+ */
+additionalInfo?: {
+/**
+ * Dimension.
+ */
+dimension?: (null | string)
+/**
+ * Brand name.
+ */
+brandName?: string
+/**
+ * Brand ID.
+ */
+brandId?: string
+/**
+ * Offering information.
+ */
+offeringInfo?: (null | string)
+/**
+ * Offering type.
+ */
+offeringType?: (null | string)
+/**
+ * Offering type ID.
+ */
+offeringTypeId?: (null | string)
+}
+/**
+ * Presale date.
+ */
+preSaleDate?: (null | string)
+/**
+ * Product category IDs.
+ */
+productCategoryIds?: string
+/**
+ * Object, where each field is an ID from `productCategoryIds`.
+ */
+productCategories?: {
+/**
+ * Product category corresponding to the ID in the field key.
+ */
+"{ID}"?: string
+}
+/**
+ * Quantity.
+ */
+quantity?: number
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
+ */
+sellerChain?: string[]
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+/**
+ * Information on services sold along with the SKU. Example: a gift package.
+ */
+bundleItems?: {
+/**
+ * Service type.
+ */
+type?: string
+/**
+ * Service identifier.
+ */
+id?: number
+/**
+ * Service name.
+ */
+name?: string
+/**
+ * Service price in cents.
+ */
+price?: number
+}[]
+/**
+ * Array containing information on attachments.
+ */
+attachments?: string[]
+/**
+ * Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.
+ */
+priceTags?: {
+/**
+ * Promotion unique identifier.
+ */
+identifier?: (null | string)
+/**
+ * Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.
+ */
+isPercentual?: boolean
+/**
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
+ * - `calculationId` is a hash that may vary with each price calculation.
+ */
+name?: string
+/**
+ * Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.
+ */
+rawValue?: number
+/**
+ * Price tag value representing either a promotion (value decrease) or a tax (value increase).
+ */
+value?: number
+}[]
+/**
+ * Availability.
+ */
+availability?: string
+/**
+ * Measurement unit.
+ */
+measurementUnit?: string
+/**
+ * Unit multiplier.
+ */
+unitMultiplier?: number
+/**
+ * Manufacturer code.
+ */
+manufacturerCode?: (null | string)
+/**
+ * Price information for all units of a specific item.
+ */
+priceDefinition?: {
+/**
+ * Item's calculated unitary selling price in cents.
+ */
+calculatedSellingPrice?: number
+/**
+ * Total value for all units of the item in cents.
+ */
+total?: number
+/**
+ * Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
+ */
+sellingPrices?: {
+/**
+ * Value in cents for that specific rounding.
+ */
+value?: number
+/**
+ * Rounding quantity, meaning how many items are rounded to this value.
+ */
+quantity?: number
+}[]
+}
+}[]
+/**
+ * Array containing the data of the item selected as a gift.
+ */
+selectableGifts?: string[]
+/**
+ * Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).
+ */
+totalizers?: {
+
+}[]
+/**
+ * Shipping information pertinent to the order.
+ */
+shippingData?: (null | {
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.
+ */
+logisticsInfo?: {
+/**
+ * Index corresponding to the position of the object in the `items` array.
+ */
+itemIndex?: number
+/**
+ * SLA selected by the customer.
+ */
+selectedSla?: (null | string)
+/**
+ * Delivery channel selected by the customer.
+ */
+selectedDeliveryChannel?: (null | string)
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Information on available SLAs.
+ */
+slas?: {
+/**
+ * SLA ID.
+ */
+id?: string
+/**
+ * Delivery channel.
+ */
+deliveryChannel?: string
+/**
+ * SLA name.
+ */
+name?: string
+/**
+ * Information on each delivery ID.
+ */
+deliveryIds?: {
+/**
+ * Courier ID.
+ */
+courierId?: string
+/**
+ * Warehouse ID.
+ */
+warehouseId?: string
+/**
+ * Warehouse ID.
+ */
+dockId?: string
+/**
+ * Courier name.
+ */
+courierName?: string
+/**
+ * Quantity.
+ */
+quantity?: number
+}[]
+/**
+ * List of attachments details.
+ */
+attachmentOfferings?: (null | {
+/**
+ * Name of the attachment.
+ */
+name: (null | string)
+/**
+ * Defines if the attachment is required (`true`) or not (`false`).
+ */
+required: (null | boolean)
+/**
+ * Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).
+ */
+schema: (null | {
+
+})
+}[])
+/**
+ * Shipping estimate. For instance, "three business days" will be represented as `3bd`.
+ */
+shippingEstimate?: string
+/**
+ * When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.
+ */
+shippingEstimateDate?: (null | string)
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+useIndividualShippingEstimates?: boolean
+/**
+ * Estimate date of delivery.
+ */
+lockTTL?: (null | string)
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Tax in cents.
+ */
+tax?: number
+/**
+ * Information on the pickup store.
+ */
+pickupStoreInfo?: {
+/**
+ * Indicates whether it is the pickup store.
+ */
+isPickupStore?: boolean
+/**
+ * Friendly name.
+ */
+friendlyName?: (null | string)
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that repesent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Additional information.
+ */
+additionalInfo?: (null | string)
+/**
+ * Corresponding dock ID.
+ */
+dockId?: (null | string)
+}
+/**
+ * Pickup point ID.
+ */
+pickupPointId?: (null | string)
+/**
+ * Pickup point distance.
+ */
+pickupDistance?: number
+/**
+ * Polygon name.
+ */
+polygonName?: (null | string)
+/**
+ * Transit time. For instance, "three business days" is represented as `3bd`.
+ */
+transitTime?: string
+}[]
+/**
+ * List of countries that the item may be shipped to.
+ */
+shipsTo?: string[]
+/**
+ * Item ID.
+ */
+itemId?: string
+/**
+ * List of available delivery channels.
+ */
+deliveryChannels?: {
+/**
+ * Delivery channel ID.
+ */
+id?: string
+}[]
+}[]
+/**
+ * Array with information on the selected addresses for the order.
+ */
+selectedAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * Array with information on the available addresses for the order.
+ */
+availableAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+})
+/**
+ * Customer's profile information.
+ */
+clientProfileData?: (null | {
+/**
+ * Email address.
+ */
+email?: (null | string)
+/**
+ * First name.
+ */
+firstName?: (null | string)
+/**
+ * Last name.
+ */
+lastName?: string
+/**
+ * Type of the document informed by the customer.
+ */
+documentType?: string
+/**
+ * Document informed by the customer.
+ */
+document?: string
+/**
+ * Phone number.
+ */
+phone?: string
+/**
+ * Company name, if the customer is a legal entity.
+ */
+corporateName?: (null | string)
+/**
+ * Trade name, if the customer is a legal entity.
+ */
+tradeName?: (null | string)
+/**
+ * Corporate document, if the customer is a legal entity.
+ */
+corporateDocument?: (null | string)
+/**
+ * State inscription, if the customer is a legal entity.
+ */
+stateInscription?: (null | string)
+/**
+ * Corporate phone number, if the customer is a legal entity.
+ */
+corporatePhone?: (null | string)
+/**
+ * Indicates whether the customer is a legal entity.
+ */
+isCorporate?: boolean
+/**
+ * Indicates whether profile is complete on loading.
+ */
+profileCompleteOnLoading?: boolean
+/**
+ * Indicates whether profile presents error on loading.
+ */
+profileErrorOnLoading?: (null | boolean)
+/**
+ * Customer class.
+ */
+customerClass?: (null | string)
+})
+/**
+ * Information on the order's payment.
+ */
+paymentData?: {
+/**
+ * Gift card information, if it applies to the order.
+ */
+giftCards?: {
+/**
+ * Gift card redemption code.
+ */
+redemptionCode?: string
+/**
+ * Gift card value in cents.
+ */
+value?: number
+/**
+ * Gift card balance in cents.
+ */
+balance?: number
+/**
+ * Gift card name.
+ */
+name?: string
+/**
+ * Gift card ID.
+ */
+id?: string
+/**
+ * Indicates whether gift card is in use.
+ */
+inUse?: boolean
+/**
+ * Indicates whether gift card is special.
+ */
+isSpecialCard?: boolean
+}[]
+/**
+ * Information on each transaction pertinent to the order.
+ */
+transactions?: (null | {
+/**
+ * Indicates whether transaction is active.
+ */
+isActive?: boolean
+/**
+ * Transaction ID.
+ */
+transactionId?: string
+/**
+ * Merchant name.
+ */
+merchantName?: string
+/**
+ * Information on each payment.
+ */
+payments?: {
+/**
+ * Account ID.
+ */
+accountId?: string
+/**
+ * Bin.
+ */
+bin?: (null | string)
+/**
+ * Number of installments.
+ */
+installments?: number
+/**
+ * Payment system.
+ */
+paymentSystem?: string
+/**
+ * Reference value for calculating interest rates, in case it applies. Displayed in cents.
+ */
+referenceValue?: number
+/**
+ * Value including interest, in case it applies. Displayed in cents.
+ */
+value?: number
+}[]
+/**
+ * Indicates whather transaction is shared.
+ */
+sharedTransaction?: boolean
+})[]
+}
+/**
+ * Object containing promotion data such as coupon tracking information and internal or external UTMs.
+ */
+marketingData?: (null | {
+/**
+ * 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.
+ */
+coupon?: string
+/**
+ * UTM source.
+ */
+utmSource?: string
+/**
+ * UTM medium.
+ */
+utmMedium?: string
+/**
+ * UTM campaign.
+ */
+utmCampaign?: string
+/**
+ * utmi_page (internal utm).
+ */
+utmiPage?: (null | string)
+/**
+ * utmi_part (internal utm).
+ */
+utmiPart?: (null | string)
+/**
+ * utmi_campaign (internal utm).
+ */
+utmiCampaign?: (null | string)
+})
+/**
+ * Information on each seller.
+ */
+sellers?: {
+/**
+ * Seller ID.
+ */
+id?: string
+/**
+ * Seller name.
+ */
+name?: string
+/**
+ * Seller logo.
+ */
+logo?: (null | string)
+}[]
+/**
+ * Object containing preferences from the client who placed the order.
+ */
+clientPreferencesData?: {
+/**
+ * Client's locale. Examples: `pt-BR` and `en-US`.
+ */
+locale?: string
+/**
+ * `true` if the client opted to receive newsletter from the store.
+ */
+optinNewsLetter?: (null | boolean)
+}
+/**
+ * Object containing commercial condition information.
+ */
+commercialConditionData?: (null | {
+
+})
+/**
+ * Object containing data from the store's configuration (stored in VTEX's License Manager).
+ */
+storePreferencesData?: {
+
+}
+/**
+ * Gift registry list information.
+ */
+giftRegistryData?: (null | {
+
+})
+/**
+ * Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).
+ */
+openTextField?: (null | string)
+/**
+ * Invoice data including billing address.
+ */
+invoiceData?: (null | {
+/**
+ * Billing address.
+ */
+address?: {
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City name.
+ */
+city?: string
+/**
+ * State name.
+ */
+state?: string
+/**
+ * Country.
+ */
+country?: string
+/**
+ * Street name.
+ */
+street?: string
+/**
+ * Street number.
+ */
+number?: string
+/**
+ * Neighborhood.
+ */
+neighborhood?: string
+/**
+ * Address complement.
+ */
+complement?: string
+/**
+ * Reference for location.
+ */
+reference?: string
+/**
+ * Geographic coordinates (latitude, longitude).
+ */
+geoCoordinates?: number[]
+}
+})
+/**
+ * Customer additional information.
+ */
+customData?: (null | {
+
+})
+/**
+ * Item metadata.
+ */
+itemMetadata?: {
+/**
+ * List of objects containing metadata on each item in the order.
+ */
+items?: {
+/**
+ * Item ID.
+ */
+id?: string
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+}[]
+}
+/**
+ * Hooks information.
+ */
+hooksData?: (null | {
+
+})
+/**
+ * Information on rates and benefits that apply to the order.
+ */
+ratesAndBenefitsData?: {
+/**
+ * List with rates and benefits identifiers.
+ */
+rateAndBenefitsIdentifiers?: string[]
+/**
+ * List with rates and benefits teasers.
+ */
+teaser?: string[]
+}
+/**
+ * Subscription information.
+ */
+subscriptionData?: (null | {
+
+})
+/**
+ * Object containing information about the ordering of items within the `orderForm`.
+ */
+itemsOrdination?: {
+/**
+ * Criteria adopted to order the items in the list.
+ */
+criteria?: string
+/**
+ * Indicates whether the ordering is ascending.
+ */
+ascending?: boolean
+}
+}
+}
+/**
+ * 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"POST /api/checkout/pub/orderForm/:orderFormId/attachments/marketingData": {
+searchParams: {
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+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"`.
+ */
+coupon?: string
+/**
+ * Marketing tags. Limited to a maximum of 50 items.
+ */
+marketingTags?: string[]
+/**
+ * UTM source.
+ */
+utmSource?: string
+/**
+ * UTM medium.
+ */
+utmMedium?: string
+/**
+ * UTM campaign.
+ */
+utmCampaign?: string
+/**
+ * UTMI page (internal utm).
+ */
+utmiPage?: string
+/**
+ * UTMI part (internal utm).
+ */
+utmiPart?: string
+/**
+ * UTMI campaign (internal utm).
+ */
+utmiCampaign?: string
+}
+response: {
+/**
+ * ID of the orderForm corresponding to a specific cart.
+ */
+orderFormId?: string
+/**
+ * Attribute created by the seller, in their VTEX store configuration.
+ */
+salesChannel?: string
+/**
+ * Indicates whether the user is logged into the store.
+ */
+loggedIn?: boolean
+/**
+ * Indicates whether order is checked in.
+ */
+isCheckedIn?: boolean
+/**
+ * ID of the store.
+ */
+storeId?: (null | string)
+/**
+ * Permission to modify item price manually.
+ */
+allowManualPrice?: boolean
+/**
+ * Data can be edited.
+ */
+canEditData?: boolean
+/**
+ * Unique ID associated with the customer profile.
+ */
+userProfileId?: string
+/**
+ * Profile provider.
+ */
+profileProvider?: string
+/**
+ * Available accounts.
+ */
+availableAccounts?: string[]
+/**
+ * Information on each available address.
+ */
+availableAddresses?: {
+/**
+ * Address type.
+ */
+addressType?: string
+/**
+ * Name of the receiver.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * City of the address.
+ */
+city?: string
+/**
+ * State of the address.
+ */
+state?: string
+/**
+ * Country of the address. ISO three-letter code.
+ */
+country?: string
+/**
+ * Street of the address.
+ */
+street?: string
+/**
+ * Number of the address.
+ */
+number?: string
+/**
+ * Neighborhood of the address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Reference that may help in the location of the address.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * User type.
+ */
+userType?: (null | string)
+/**
+ * Ignore customer profile data.
+ */
+ignoreProfileData?: boolean
+/**
+ * Total value of the order without separating cents. For example, $24.99 is represented as `2499`.
+ */
+value?: number
+/**
+ * Array containing an object for each message generated by our servers while processing the request.
+ */
+messages?: string[]
+/**
+ * Information on each item in the order.
+ */
+items?: {
+/**
+ * Unique ID.
+ */
+uniqueId?: string
+/**
+ * ID of the item.
+ */
+id?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Product Ref ID.
+ */
+productRefId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Modal type.
+ */
+modalType?: (null | string)
+/**
+ * Parent item index.
+ */
+parentItemIndex?: (null | number)
+/**
+ * Parent assembly binding.
+ */
+parentAssemblyBinding?: (null | string)
+/**
+ * Price expiration date and time.
+ */
+priceValidUntil?: string
+/**
+ * Tax value in cents.
+ */
+tax?: number
+/**
+ * A unique identifier code assigned to a tax within the VTEX Admin.
+ */
+taxCode?: string
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Manual price in cents.
+ */
+manualPrice?: (null | number)
+/**
+ * User that applied the manual price, if that is the case.
+ */
+manualPriceAppliedBy?: (null | string)
+/**
+ * Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
+ */
+sellingPrice?: number
+/**
+ * Reward value in cents.
+ */
+rewardValue?: number
+/**
+ * Indicates whether item is a gift.
+ */
+isGift?: boolean
+/**
+ * Additional information.
+ */
+additionalInfo?: {
+/**
+ * Dimension.
+ */
+dimension?: (null | string)
+/**
+ * Brand name.
+ */
+brandName?: string
+/**
+ * Brand ID.
+ */
+brandId?: string
+/**
+ * Offering information.
+ */
+offeringInfo?: (null | string)
+/**
+ * Offering type.
+ */
+offeringType?: (null | string)
+/**
+ * Offering type ID.
+ */
+offeringTypeId?: (null | string)
+}
+/**
+ * Presale date.
+ */
+preSaleDate?: (null | string)
+/**
+ * Product category IDs.
+ */
+productCategoryIds?: string
+/**
+ * Object, where each field is an ID from `productCategoryIds`.
+ */
+productCategories?: {
+/**
+ * Product category corresponding to the ID in the field key.
+ */
+"{ID}"?: string
+}
+/**
+ * Quantity.
+ */
+quantity?: number
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
+ */
+sellerChain?: string[]
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+/**
+ * Information on services sold along with the SKU. Example: a gift package.
+ */
+bundleItems?: {
+/**
+ * Service type.
+ */
+type?: string
+/**
+ * Service identifier.
+ */
+id?: number
+/**
+ * Service name.
+ */
+name?: string
+/**
+ * Service price in cents.
+ */
+price?: number
+}[]
+/**
+ * Array containing information on attachments.
+ */
+attachments?: string[]
+/**
+ * Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.
+ */
+priceTags?: {
+/**
+ * Promotion unique identifier.
+ */
+identifier?: (null | string)
+/**
+ * Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.
+ */
+isPercentual?: boolean
+/**
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
+ * - `calculationId` is a hash that may vary with each price calculation.
+ */
+name?: string
+/**
+ * Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.
+ */
+rawValue?: number
+/**
+ * Price tag value representing either a promotion (value decrease) or a tax (value increase).
+ */
+value?: number
+}[]
+/**
+ * Availability.
+ */
+availability?: string
+/**
+ * Measurement unit.
+ */
+measurementUnit?: string
+/**
+ * Unit multiplier.
+ */
+unitMultiplier?: number
+/**
+ * Manufacturer code.
+ */
+manufacturerCode?: (null | string)
+/**
+ * Price information for all units of a specific item.
+ */
+priceDefinition?: {
+/**
+ * Item's calculated unitary selling price in cents.
+ */
+calculatedSellingPrice?: number
+/**
+ * Total value for all units of the item in cents.
+ */
+total?: number
+/**
+ * Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
+ */
+sellingPrices?: {
+/**
+ * Value in cents for that specific rounding.
+ */
+value?: number
+/**
+ * Rounding quantity, meaning how many items are rounded to this value.
+ */
+quantity?: number
+}[]
+}
+}[]
+/**
+ * Array containing the data of the item selected as a gift.
+ */
+selectableGifts?: string[]
+/**
+ * Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).
+ */
+totalizers?: {
+
+}[]
+/**
+ * Shipping information pertinent to the order.
+ */
+shippingData?: (null | {
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.
+ */
+logisticsInfo?: {
+/**
+ * Index corresponding to the position of the object in the `items` array.
+ */
+itemIndex?: number
+/**
+ * SLA selected by the customer.
+ */
+selectedSla?: (null | string)
+/**
+ * Delivery channel selected by the customer.
+ */
+selectedDeliveryChannel?: (null | string)
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Information on available SLAs.
+ */
+slas?: {
+/**
+ * SLA ID.
+ */
+id?: string
+/**
+ * Delivery channel.
+ */
+deliveryChannel?: string
+/**
+ * SLA name.
+ */
+name?: string
+/**
+ * Information on each delivery ID.
+ */
+deliveryIds?: {
+/**
+ * Courier ID.
+ */
+courierId?: string
+/**
+ * Warehouse ID.
+ */
+warehouseId?: string
+/**
+ * Warehouse ID.
+ */
+dockId?: string
+/**
+ * Courier name.
+ */
+courierName?: string
+/**
+ * Quantity.
+ */
+quantity?: number
+}[]
+/**
+ * List of attachments details.
+ */
+attachmentOfferings?: (null | {
+/**
+ * Name of the attachment.
+ */
+name: (null | string)
+/**
+ * Defines if the attachment is required (`true`) or not (`false`).
+ */
+required: (null | boolean)
+/**
+ * Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).
+ */
+schema: (null | {
+
+})
+}[])
+/**
+ * Shipping estimate. For instance, "three business days" will be represented as `3bd`.
+ */
+shippingEstimate?: string
+/**
+ * When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.
+ */
+shippingEstimateDate?: (null | string)
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+useIndividualShippingEstimates?: boolean
+/**
+ * Estimate date of delivery.
+ */
+lockTTL?: (null | string)
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Tax in cents.
+ */
+tax?: number
+/**
+ * Information on the pickup store.
+ */
+pickupStoreInfo?: {
+/**
+ * Indicates whether it is the pickup store.
+ */
+isPickupStore?: boolean
+/**
+ * Friendly name.
+ */
+friendlyName?: (null | string)
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that repesent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Additional information.
+ */
+additionalInfo?: (null | string)
+/**
+ * Corresponding dock ID.
+ */
+dockId?: (null | string)
+}
+/**
+ * Pickup point ID.
+ */
+pickupPointId?: (null | string)
+/**
+ * Pickup point distance.
+ */
+pickupDistance?: number
+/**
+ * Polygon name.
+ */
+polygonName?: (null | string)
+/**
+ * Transit time. For instance, "three business days" is represented as `3bd`.
+ */
+transitTime?: string
+}[]
+/**
+ * List of countries that the item may be shipped to.
+ */
+shipsTo?: string[]
+/**
+ * Item ID.
+ */
+itemId?: string
+/**
+ * List of available delivery channels.
+ */
+deliveryChannels?: {
+/**
+ * Delivery channel ID.
+ */
+id?: string
+}[]
+}[]
+/**
+ * Array with information on the selected addresses for the order.
+ */
+selectedAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * Array with information on the available addresses for the order.
+ */
+availableAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+})
+/**
+ * Customer's profile information.
+ */
+clientProfileData?: (null | {
+/**
+ * Email address.
+ */
+email?: (null | string)
+/**
+ * First name.
+ */
+firstName?: (null | string)
+/**
+ * Last name.
+ */
+lastName?: string
+/**
+ * Type of the document informed by the customer.
+ */
+documentType?: string
+/**
+ * Document informed by the customer.
+ */
+document?: string
+/**
+ * Phone number.
+ */
+phone?: string
+/**
+ * Company name, if the customer is a legal entity.
+ */
+corporateName?: (null | string)
+/**
+ * Trade name, if the customer is a legal entity.
+ */
+tradeName?: (null | string)
+/**
+ * Corporate document, if the customer is a legal entity.
+ */
+corporateDocument?: (null | string)
+/**
+ * State inscription, if the customer is a legal entity.
+ */
+stateInscription?: (null | string)
+/**
+ * Corporate phone number, if the customer is a legal entity.
+ */
+corporatePhone?: (null | string)
+/**
+ * Indicates whether the customer is a legal entity.
+ */
+isCorporate?: boolean
+/**
+ * Indicates whether profile is complete on loading.
+ */
+profileCompleteOnLoading?: boolean
+/**
+ * Indicates whether profile presents error on loading.
+ */
+profileErrorOnLoading?: (null | boolean)
+/**
+ * Customer class.
+ */
+customerClass?: (null | string)
+})
+/**
+ * Information on the order's payment.
+ */
+paymentData?: {
+/**
+ * Gift card information, if it applies to the order.
+ */
+giftCards?: {
+/**
+ * Gift card redemption code.
+ */
+redemptionCode?: string
+/**
+ * Gift card value in cents.
+ */
+value?: number
+/**
+ * Gift card balance in cents.
+ */
+balance?: number
+/**
+ * Gift card name.
+ */
+name?: string
+/**
+ * Gift card ID.
+ */
+id?: string
+/**
+ * Indicates whether gift card is in use.
+ */
+inUse?: boolean
+/**
+ * Indicates whether gift card is special.
+ */
+isSpecialCard?: boolean
+}[]
+/**
+ * Information on each transaction pertinent to the order.
+ */
+transactions?: (null | {
+/**
+ * Indicates whether transaction is active.
+ */
+isActive?: boolean
+/**
+ * Transaction ID.
+ */
+transactionId?: string
+/**
+ * Merchant name.
+ */
+merchantName?: string
+/**
+ * Information on each payment.
+ */
+payments?: {
+/**
+ * Account ID.
+ */
+accountId?: string
+/**
+ * Bin.
+ */
+bin?: (null | string)
+/**
+ * Number of installments.
+ */
+installments?: number
+/**
+ * Payment system.
+ */
+paymentSystem?: string
+/**
+ * Reference value for calculating interest rates, in case it applies. Displayed in cents.
+ */
+referenceValue?: number
+/**
+ * Value including interest, in case it applies. Displayed in cents.
+ */
+value?: number
+}[]
+/**
+ * Indicates whather transaction is shared.
+ */
+sharedTransaction?: boolean
+})[]
+}
+/**
+ * Object containing promotion data such as coupon tracking information and internal or external UTMs.
+ */
+marketingData?: (null | {
+/**
+ * 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.
+ */
+coupon?: string
+/**
+ * UTM source.
+ */
+utmSource?: string
+/**
+ * UTM medium.
+ */
+utmMedium?: string
+/**
+ * UTM campaign.
+ */
+utmCampaign?: string
+/**
+ * utmi_page (internal utm).
+ */
+utmiPage?: (null | string)
+/**
+ * utmi_part (internal utm).
+ */
+utmiPart?: (null | string)
+/**
+ * utmi_campaign (internal utm).
+ */
+utmiCampaign?: (null | string)
+})
+/**
+ * Information on each seller.
+ */
+sellers?: {
+/**
+ * Seller ID.
+ */
+id?: string
+/**
+ * Seller name.
+ */
+name?: string
+/**
+ * Seller logo.
+ */
+logo?: (null | string)
+}[]
+/**
+ * Object containing preferences from the client who placed the order.
+ */
+clientPreferencesData?: {
+/**
+ * Client's locale. Examples: `pt-BR` and `en-US`.
+ */
+locale?: string
+/**
+ * `true` if the client opted to receive newsletter from the store.
+ */
+optinNewsLetter?: (null | boolean)
+}
+/**
+ * Object containing commercial condition information.
+ */
+commercialConditionData?: (null | {
+
+})
+/**
+ * Object containing data from the store's configuration (stored in VTEX's License Manager).
+ */
+storePreferencesData?: {
+
+}
+/**
+ * Gift registry list information.
+ */
+giftRegistryData?: (null | {
+
+})
+/**
+ * Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).
+ */
+openTextField?: (null | string)
+/**
+ * Invoice data including billing address.
+ */
+invoiceData?: (null | {
+/**
+ * Billing address.
+ */
+address?: {
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City name.
+ */
+city?: string
+/**
+ * State name.
+ */
+state?: string
+/**
+ * Country.
+ */
+country?: string
+/**
+ * Street name.
+ */
+street?: string
+/**
+ * Street number.
+ */
+number?: string
+/**
+ * Neighborhood.
+ */
+neighborhood?: string
+/**
+ * Address complement.
+ */
+complement?: string
+/**
+ * Reference for location.
+ */
+reference?: string
+/**
+ * Geographic coordinates (latitude, longitude).
+ */
+geoCoordinates?: number[]
+}
+})
+/**
+ * Customer additional information.
+ */
+customData?: (null | {
+
+})
+/**
+ * Item metadata.
+ */
+itemMetadata?: {
+/**
+ * List of objects containing metadata on each item in the order.
+ */
+items?: {
+/**
+ * Item ID.
+ */
+id?: string
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+}[]
+}
+/**
+ * Hooks information.
+ */
+hooksData?: (null | {
+
+})
+/**
+ * Information on rates and benefits that apply to the order.
+ */
+ratesAndBenefitsData?: {
+/**
+ * List with rates and benefits identifiers.
+ */
+rateAndBenefitsIdentifiers?: string[]
+/**
+ * List with rates and benefits teasers.
+ */
+teaser?: string[]
+}
+/**
+ * Subscription information.
+ */
+subscriptionData?: (null | {
+
+})
+/**
+ * Object containing information about the ordering of items within the `orderForm`.
+ */
+itemsOrdination?: {
+/**
+ * Criteria adopted to order the items in the list.
+ */
+criteria?: string
+/**
+ * Indicates whether the ordering is ascending.
+ */
+ascending?: boolean
+}
+}
+}
+/**
+ * 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"POST /api/checkout/pub/orderForm/:orderFormId/attachments/paymentData": {
+searchParams: {
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+body: {
+/**
+ * Array with information on each payment chosen by the shopper.
+ */
+payments?: {
+/**
+ * Payment system ID.
+ */
+paymentSystem?: number
+/**
+ * Payment system name.
+ */
+paymentSystemName?: string
+/**
+ * Payment system group.
+ */
+group?: string
+/**
+ * Selected number of installments.
+ */
+installments?: number
+/**
+ * Installments' interest rate.
+ */
+installmentsInterestRate?: number
+/**
+ * Value of the installments.
+ */
+installmentsValue?: number
+/**
+ * Total value assigned to this payment.
+ */
+value?: number
+/**
+ * Reference value used to calculate total order value with interest.
+ */
+referenceValue?: number
+/**
+ * Indicates whether billing address for this payment is the default address.
+ */
+hasDefaultBillingAddress?: boolean
+}[]
+}
+response: {
+/**
+ * ID of the orderForm corresponding to a specific cart.
+ */
+orderFormId?: string
+/**
+ * Attribute created by the seller, in their VTEX store configuration.
+ */
+salesChannel?: string
+/**
+ * Indicates whether the user is logged into the store.
+ */
+loggedIn?: boolean
+/**
+ * Indicates whether order is checked in.
+ */
+isCheckedIn?: boolean
+/**
+ * ID of the store.
+ */
+storeId?: (null | string)
+/**
+ * Permission to modify item price manually.
+ */
+allowManualPrice?: boolean
+/**
+ * Data can be edited.
+ */
+canEditData?: boolean
+/**
+ * Unique ID associated with the customer profile.
+ */
+userProfileId?: string
+/**
+ * Profile provider.
+ */
+profileProvider?: string
+/**
+ * Available accounts.
+ */
+availableAccounts?: string[]
+/**
+ * Information on each available address.
+ */
+availableAddresses?: {
+/**
+ * Address type.
+ */
+addressType?: string
+/**
+ * Name of the receiver.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * City of the address.
+ */
+city?: string
+/**
+ * State of the address.
+ */
+state?: string
+/**
+ * Country of the address. ISO three-letter code.
+ */
+country?: string
+/**
+ * Street of the address.
+ */
+street?: string
+/**
+ * Number of the address.
+ */
+number?: string
+/**
+ * Neighborhood of the address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Reference that may help in the location of the address.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * User type.
+ */
+userType?: (null | string)
+/**
+ * Ignore customer profile data.
+ */
+ignoreProfileData?: boolean
+/**
+ * Total value of the order without separating cents. For example, $24.99 is represented as `2499`.
+ */
+value?: number
+/**
+ * Array containing an object for each message generated by our servers while processing the request.
+ */
+messages?: string[]
+/**
+ * Information on each item in the order.
+ */
+items?: {
+/**
+ * Unique ID.
+ */
+uniqueId?: string
+/**
+ * ID of the item.
+ */
+id?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Product Ref ID.
+ */
+productRefId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Modal type.
+ */
+modalType?: (null | string)
+/**
+ * Parent item index.
+ */
+parentItemIndex?: (null | number)
+/**
+ * Parent assembly binding.
+ */
+parentAssemblyBinding?: (null | string)
+/**
+ * Price expiration date and time.
+ */
+priceValidUntil?: string
+/**
+ * Tax value in cents.
+ */
+tax?: number
+/**
+ * A unique identifier code assigned to a tax within the VTEX Admin.
+ */
+taxCode?: string
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Manual price in cents.
+ */
+manualPrice?: (null | number)
+/**
+ * User that applied the manual price, if that is the case.
+ */
+manualPriceAppliedBy?: (null | string)
+/**
+ * Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
+ */
+sellingPrice?: number
+/**
+ * Reward value in cents.
+ */
+rewardValue?: number
+/**
+ * Indicates whether item is a gift.
+ */
+isGift?: boolean
+/**
+ * Additional information.
+ */
+additionalInfo?: {
+/**
+ * Dimension.
+ */
+dimension?: (null | string)
+/**
+ * Brand name.
+ */
+brandName?: string
+/**
+ * Brand ID.
+ */
+brandId?: string
+/**
+ * Offering information.
+ */
+offeringInfo?: (null | string)
+/**
+ * Offering type.
+ */
+offeringType?: (null | string)
+/**
+ * Offering type ID.
+ */
+offeringTypeId?: (null | string)
+}
+/**
+ * Presale date.
+ */
+preSaleDate?: (null | string)
+/**
+ * Product category IDs.
+ */
+productCategoryIds?: string
+/**
+ * Object, where each field is an ID from `productCategoryIds`.
+ */
+productCategories?: {
+/**
+ * Product category corresponding to the ID in the field key.
+ */
+"{ID}"?: string
+}
+/**
+ * Quantity.
+ */
+quantity?: number
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
+ */
+sellerChain?: string[]
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+/**
+ * Information on services sold along with the SKU. Example: a gift package.
+ */
+bundleItems?: {
+/**
+ * Service type.
+ */
+type?: string
+/**
+ * Service identifier.
+ */
+id?: number
+/**
+ * Service name.
+ */
+name?: string
+/**
+ * Service price in cents.
+ */
+price?: number
+}[]
+/**
+ * Array containing information on attachments.
+ */
+attachments?: string[]
+/**
+ * Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.
+ */
+priceTags?: {
+/**
+ * Promotion unique identifier.
+ */
+identifier?: (null | string)
+/**
+ * Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.
+ */
+isPercentual?: boolean
+/**
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
+ * - `calculationId` is a hash that may vary with each price calculation.
+ */
+name?: string
+/**
+ * Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.
+ */
+rawValue?: number
+/**
+ * Price tag value representing either a promotion (value decrease) or a tax (value increase).
+ */
+value?: number
+}[]
+/**
+ * Availability.
+ */
+availability?: string
+/**
+ * Measurement unit.
+ */
+measurementUnit?: string
+/**
+ * Unit multiplier.
+ */
+unitMultiplier?: number
+/**
+ * Manufacturer code.
+ */
+manufacturerCode?: (null | string)
+/**
+ * Price information for all units of a specific item.
+ */
+priceDefinition?: {
+/**
+ * Item's calculated unitary selling price in cents.
+ */
+calculatedSellingPrice?: number
+/**
+ * Total value for all units of the item in cents.
+ */
+total?: number
+/**
+ * Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
+ */
+sellingPrices?: {
+/**
+ * Value in cents for that specific rounding.
+ */
+value?: number
+/**
+ * Rounding quantity, meaning how many items are rounded to this value.
+ */
+quantity?: number
+}[]
+}
+}[]
+/**
+ * Array containing the data of the item selected as a gift.
+ */
+selectableGifts?: string[]
+/**
+ * Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).
+ */
+totalizers?: {
+
+}[]
+/**
+ * Shipping information pertinent to the order.
+ */
+shippingData?: (null | {
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.
+ */
+logisticsInfo?: {
+/**
+ * Index corresponding to the position of the object in the `items` array.
+ */
+itemIndex?: number
+/**
+ * SLA selected by the customer.
+ */
+selectedSla?: (null | string)
+/**
+ * Delivery channel selected by the customer.
+ */
+selectedDeliveryChannel?: (null | string)
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Information on available SLAs.
+ */
+slas?: {
+/**
+ * SLA ID.
+ */
+id?: string
+/**
+ * Delivery channel.
+ */
+deliveryChannel?: string
+/**
+ * SLA name.
+ */
+name?: string
+/**
+ * Information on each delivery ID.
+ */
+deliveryIds?: {
+/**
+ * Courier ID.
+ */
+courierId?: string
+/**
+ * Warehouse ID.
+ */
+warehouseId?: string
+/**
+ * Warehouse ID.
+ */
+dockId?: string
+/**
+ * Courier name.
+ */
+courierName?: string
+/**
+ * Quantity.
+ */
+quantity?: number
+}[]
+/**
+ * List of attachments details.
+ */
+attachmentOfferings?: (null | {
+/**
+ * Name of the attachment.
+ */
+name: (null | string)
+/**
+ * Defines if the attachment is required (`true`) or not (`false`).
+ */
+required: (null | boolean)
+/**
+ * Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).
+ */
+schema: (null | {
+
+})
+}[])
+/**
+ * Shipping estimate. For instance, "three business days" will be represented as `3bd`.
+ */
+shippingEstimate?: string
+/**
+ * When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.
+ */
+shippingEstimateDate?: (null | string)
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+useIndividualShippingEstimates?: boolean
+/**
+ * Estimate date of delivery.
+ */
+lockTTL?: (null | string)
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Tax in cents.
+ */
+tax?: number
+/**
+ * Information on the pickup store.
+ */
+pickupStoreInfo?: {
+/**
+ * Indicates whether it is the pickup store.
+ */
+isPickupStore?: boolean
+/**
+ * Friendly name.
+ */
+friendlyName?: (null | string)
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that repesent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Additional information.
+ */
+additionalInfo?: (null | string)
+/**
+ * Corresponding dock ID.
+ */
+dockId?: (null | string)
+}
+/**
+ * Pickup point ID.
+ */
+pickupPointId?: (null | string)
+/**
+ * Pickup point distance.
+ */
+pickupDistance?: number
+/**
+ * Polygon name.
+ */
+polygonName?: (null | string)
+/**
+ * Transit time. For instance, "three business days" is represented as `3bd`.
+ */
+transitTime?: string
+}[]
+/**
+ * List of countries that the item may be shipped to.
+ */
+shipsTo?: string[]
+/**
+ * Item ID.
+ */
+itemId?: string
+/**
+ * List of available delivery channels.
+ */
+deliveryChannels?: {
+/**
+ * Delivery channel ID.
+ */
+id?: string
+}[]
+}[]
+/**
+ * Array with information on the selected addresses for the order.
+ */
+selectedAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * Array with information on the available addresses for the order.
+ */
+availableAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+})
+/**
+ * Customer's profile information.
+ */
+clientProfileData?: (null | {
+/**
+ * Email address.
+ */
+email?: (null | string)
+/**
+ * First name.
+ */
+firstName?: (null | string)
+/**
+ * Last name.
+ */
+lastName?: string
+/**
+ * Type of the document informed by the customer.
+ */
+documentType?: string
+/**
+ * Document informed by the customer.
+ */
+document?: string
+/**
+ * Phone number.
+ */
+phone?: string
+/**
+ * Company name, if the customer is a legal entity.
+ */
+corporateName?: (null | string)
+/**
+ * Trade name, if the customer is a legal entity.
+ */
+tradeName?: (null | string)
+/**
+ * Corporate document, if the customer is a legal entity.
+ */
+corporateDocument?: (null | string)
+/**
+ * State inscription, if the customer is a legal entity.
+ */
+stateInscription?: (null | string)
+/**
+ * Corporate phone number, if the customer is a legal entity.
+ */
+corporatePhone?: (null | string)
+/**
+ * Indicates whether the customer is a legal entity.
+ */
+isCorporate?: boolean
+/**
+ * Indicates whether profile is complete on loading.
+ */
+profileCompleteOnLoading?: boolean
+/**
+ * Indicates whether profile presents error on loading.
+ */
+profileErrorOnLoading?: (null | boolean)
+/**
+ * Customer class.
+ */
+customerClass?: (null | string)
+})
+/**
+ * Information on the order's payment.
+ */
+paymentData?: {
+/**
+ * Gift card information, if it applies to the order.
+ */
+giftCards?: {
+/**
+ * Gift card redemption code.
+ */
+redemptionCode?: string
+/**
+ * Gift card value in cents.
+ */
+value?: number
+/**
+ * Gift card balance in cents.
+ */
+balance?: number
+/**
+ * Gift card name.
+ */
+name?: string
+/**
+ * Gift card ID.
+ */
+id?: string
+/**
+ * Indicates whether gift card is in use.
+ */
+inUse?: boolean
+/**
+ * Indicates whether gift card is special.
+ */
+isSpecialCard?: boolean
+}[]
+/**
+ * Information on each transaction pertinent to the order.
+ */
+transactions?: (null | {
+/**
+ * Indicates whether transaction is active.
+ */
+isActive?: boolean
+/**
+ * Transaction ID.
+ */
+transactionId?: string
+/**
+ * Merchant name.
+ */
+merchantName?: string
+/**
+ * Information on each payment.
+ */
+payments?: {
+/**
+ * Account ID.
+ */
+accountId?: string
+/**
+ * Bin.
+ */
+bin?: (null | string)
+/**
+ * Number of installments.
+ */
+installments?: number
+/**
+ * Payment system.
+ */
+paymentSystem?: string
+/**
+ * Reference value for calculating interest rates, in case it applies. Displayed in cents.
+ */
+referenceValue?: number
+/**
+ * Value including interest, in case it applies. Displayed in cents.
+ */
+value?: number
+}[]
+/**
+ * Indicates whather transaction is shared.
+ */
+sharedTransaction?: boolean
+})[]
+}
+/**
+ * Object containing promotion data such as coupon tracking information and internal or external UTMs.
+ */
+marketingData?: (null | {
+/**
+ * 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.
+ */
+coupon?: string
+/**
+ * UTM source.
+ */
+utmSource?: string
+/**
+ * UTM medium.
+ */
+utmMedium?: string
+/**
+ * UTM campaign.
+ */
+utmCampaign?: string
+/**
+ * utmi_page (internal utm).
+ */
+utmiPage?: (null | string)
+/**
+ * utmi_part (internal utm).
+ */
+utmiPart?: (null | string)
+/**
+ * utmi_campaign (internal utm).
+ */
+utmiCampaign?: (null | string)
+})
+/**
+ * Information on each seller.
+ */
+sellers?: {
+/**
+ * Seller ID.
+ */
+id?: string
+/**
+ * Seller name.
+ */
+name?: string
+/**
+ * Seller logo.
+ */
+logo?: (null | string)
+}[]
+/**
+ * Object containing preferences from the client who placed the order.
+ */
+clientPreferencesData?: {
+/**
+ * Client's locale. Examples: `pt-BR` and `en-US`.
+ */
+locale?: string
+/**
+ * `true` if the client opted to receive newsletter from the store.
+ */
+optinNewsLetter?: (null | boolean)
+}
+/**
+ * Object containing commercial condition information.
+ */
+commercialConditionData?: (null | {
+
+})
+/**
+ * Object containing data from the store's configuration (stored in VTEX's License Manager).
+ */
+storePreferencesData?: {
+
+}
+/**
+ * Gift registry list information.
+ */
+giftRegistryData?: (null | {
+
+})
+/**
+ * Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).
+ */
+openTextField?: (null | string)
+/**
+ * Invoice data including billing address.
+ */
+invoiceData?: (null | {
+/**
+ * Billing address.
+ */
+address?: {
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City name.
+ */
+city?: string
+/**
+ * State name.
+ */
+state?: string
+/**
+ * Country.
+ */
+country?: string
+/**
+ * Street name.
+ */
+street?: string
+/**
+ * Street number.
+ */
+number?: string
+/**
+ * Neighborhood.
+ */
+neighborhood?: string
+/**
+ * Address complement.
+ */
+complement?: string
+/**
+ * Reference for location.
+ */
+reference?: string
+/**
+ * Geographic coordinates (latitude, longitude).
+ */
+geoCoordinates?: number[]
+}
+})
+/**
+ * Customer additional information.
+ */
+customData?: (null | {
+
+})
+/**
+ * Item metadata.
+ */
+itemMetadata?: {
+/**
+ * List of objects containing metadata on each item in the order.
+ */
+items?: {
+/**
+ * Item ID.
+ */
+id?: string
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+}[]
+}
+/**
+ * Hooks information.
+ */
+hooksData?: (null | {
+
+})
+/**
+ * Information on rates and benefits that apply to the order.
+ */
+ratesAndBenefitsData?: {
+/**
+ * List with rates and benefits identifiers.
+ */
+rateAndBenefitsIdentifiers?: string[]
+/**
+ * List with rates and benefits teasers.
+ */
+teaser?: string[]
+}
+/**
+ * Subscription information.
+ */
+subscriptionData?: (null | {
+
+})
+/**
+ * Object containing information about the ordering of items within the `orderForm`.
+ */
+itemsOrdination?: {
+/**
+ * Criteria adopted to order the items in the list.
+ */
+criteria?: string
+/**
+ * Indicates whether the ordering is ascending.
+ */
+ascending?: 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.
+ * 
+ * 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"POST /api/checkout/pub/orderForm/:orderFormId/attachments/merchantContextData": {
+searchParams: {
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+body: {
+/**
+ * Sales Associate information.
+ */
+salesAssociateData: {
+/**
+ * Sales Associate (Seller) identification code. All information should be registered by the merchant. Maximum of 100 characters.
+ */
+salesAssociateId?: string
+}
+}
+response: {
+/**
+ * Sales Associate (Seller) identification code.
+ */
+salesAssociateId?: string
+}
+}
+/**
+ * Attaches invoice data to the 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"POST /api/checkout/pub/orderForm/:orderFormId/attachments/invoiceData": {
+body: {
+address: {
+/**
+ *  Type of address, as `residential` or `business`.
+ */
+addressType?: string
+/**
+ * Address city name.
+ */
+city?: string
+/**
+ * Address complement, such as the apartment number.
+ */
+complement?: string
+/**
+ * Address country name.
+ */
+country?: string
+/**
+ * List containing address geocoordinates, first longitude, then latitude.
+ */
+geoCoordinates: number[]
+/**
+ * Address neighborhood name.
+ */
+neighborhood?: string
+/**
+ * Address number.
+ */
+number?: string
+/**
+ * Address postal code.
+ */
+postalCode: string
+/**
+ * Reference that may help in the location of the address, as a landmark.
+ */
+reference?: string
+/**
+ * Address state name.
+ */
+state?: string
+/**
+ * Address street name.
+ */
+street?: string
+}
+}
+response: {
+/**
+ * ID of the orderForm corresponding to a specific cart.
+ */
+orderFormId?: string
+/**
+ * Attribute created by the seller, in their VTEX store configuration.
+ */
+salesChannel?: string
+/**
+ * Indicates whether the user is logged into the store.
+ */
+loggedIn?: boolean
+/**
+ * Indicates whether order is checked in.
+ */
+isCheckedIn?: boolean
+/**
+ * ID of the store.
+ */
+storeId?: (null | string)
+/**
+ * Permission to modify item price manually.
+ */
+allowManualPrice?: boolean
+/**
+ * Data can be edited.
+ */
+canEditData?: boolean
+/**
+ * Unique ID associated with the customer profile.
+ */
+userProfileId?: string
+/**
+ * Profile provider.
+ */
+profileProvider?: string
+/**
+ * Available accounts.
+ */
+availableAccounts?: string[]
+/**
+ * Information on each available address.
+ */
+availableAddresses?: {
+/**
+ * Address type.
+ */
+addressType?: string
+/**
+ * Name of the receiver.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * City of the address.
+ */
+city?: string
+/**
+ * State of the address.
+ */
+state?: string
+/**
+ * Country of the address. ISO three-letter code.
+ */
+country?: string
+/**
+ * Street of the address.
+ */
+street?: string
+/**
+ * Number of the address.
+ */
+number?: string
+/**
+ * Neighborhood of the address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Reference that may help in the location of the address.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * User type.
+ */
+userType?: (null | string)
+/**
+ * Ignore customer profile data.
+ */
+ignoreProfileData?: boolean
+/**
+ * Total value of the order without separating cents. For example, $24.99 is represented as `2499`.
+ */
+value?: number
+/**
+ * Array containing an object for each message generated by our servers while processing the request.
+ */
+messages?: string[]
+/**
+ * Information on each item in the order.
+ */
+items?: {
+/**
+ * Unique ID.
+ */
+uniqueId?: string
+/**
+ * ID of the item.
+ */
+id?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Product Ref ID.
+ */
+productRefId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Modal type.
+ */
+modalType?: (null | string)
+/**
+ * Parent item index.
+ */
+parentItemIndex?: (null | number)
+/**
+ * Parent assembly binding.
+ */
+parentAssemblyBinding?: (null | string)
+/**
+ * Price expiration date and time.
+ */
+priceValidUntil?: string
+/**
+ * Tax value in cents.
+ */
+tax?: number
+/**
+ * A unique identifier code assigned to a tax within the VTEX Admin.
+ */
+taxCode?: string
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Manual price in cents.
+ */
+manualPrice?: (null | number)
+/**
+ * User that applied the manual price, if that is the case.
+ */
+manualPriceAppliedBy?: (null | string)
+/**
+ * Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
+ */
+sellingPrice?: number
+/**
+ * Reward value in cents.
+ */
+rewardValue?: number
+/**
+ * Indicates whether item is a gift.
+ */
+isGift?: boolean
+/**
+ * Additional information.
+ */
+additionalInfo?: {
+/**
+ * Dimension.
+ */
+dimension?: (null | string)
+/**
+ * Brand name.
+ */
+brandName?: string
+/**
+ * Brand ID.
+ */
+brandId?: string
+/**
+ * Offering information.
+ */
+offeringInfo?: (null | string)
+/**
+ * Offering type.
+ */
+offeringType?: (null | string)
+/**
+ * Offering type ID.
+ */
+offeringTypeId?: (null | string)
+}
+/**
+ * Presale date.
+ */
+preSaleDate?: (null | string)
+/**
+ * Product category IDs.
+ */
+productCategoryIds?: string
+/**
+ * Object, where each field is an ID from `productCategoryIds`.
+ */
+productCategories?: {
+/**
+ * Product category corresponding to the ID in the field key.
+ */
+"{ID}"?: string
+}
+/**
+ * Quantity.
+ */
+quantity?: number
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
+ */
+sellerChain?: string[]
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+/**
+ * Information on services sold along with the SKU. Example: a gift package.
+ */
+bundleItems?: {
+/**
+ * Service type.
+ */
+type?: string
+/**
+ * Service identifier.
+ */
+id?: number
+/**
+ * Service name.
+ */
+name?: string
+/**
+ * Service price in cents.
+ */
+price?: number
+}[]
+/**
+ * Array containing information on attachments.
+ */
+attachments?: string[]
+/**
+ * Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.
+ */
+priceTags?: {
+/**
+ * Promotion unique identifier.
+ */
+identifier?: (null | string)
+/**
+ * Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.
+ */
+isPercentual?: boolean
+/**
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
+ * - `calculationId` is a hash that may vary with each price calculation.
+ */
+name?: string
+/**
+ * Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.
+ */
+rawValue?: number
+/**
+ * Price tag value representing either a promotion (value decrease) or a tax (value increase).
+ */
+value?: number
+}[]
+/**
+ * Availability.
+ */
+availability?: string
+/**
+ * Measurement unit.
+ */
+measurementUnit?: string
+/**
+ * Unit multiplier.
+ */
+unitMultiplier?: number
+/**
+ * Manufacturer code.
+ */
+manufacturerCode?: (null | string)
+/**
+ * Price information for all units of a specific item.
+ */
+priceDefinition?: {
+/**
+ * Item's calculated unitary selling price in cents.
+ */
+calculatedSellingPrice?: number
+/**
+ * Total value for all units of the item in cents.
+ */
+total?: number
+/**
+ * Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
+ */
+sellingPrices?: {
+/**
+ * Value in cents for that specific rounding.
+ */
+value?: number
+/**
+ * Rounding quantity, meaning how many items are rounded to this value.
+ */
+quantity?: number
+}[]
+}
+}[]
+/**
+ * Array containing the data of the item selected as a gift.
+ */
+selectableGifts?: string[]
+/**
+ * Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).
+ */
+totalizers?: {
+
+}[]
+/**
+ * Shipping information pertinent to the order.
+ */
+shippingData?: (null | {
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.
+ */
+logisticsInfo?: {
+/**
+ * Index corresponding to the position of the object in the `items` array.
+ */
+itemIndex?: number
+/**
+ * SLA selected by the customer.
+ */
+selectedSla?: (null | string)
+/**
+ * Delivery channel selected by the customer.
+ */
+selectedDeliveryChannel?: (null | string)
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Information on available SLAs.
+ */
+slas?: {
+/**
+ * SLA ID.
+ */
+id?: string
+/**
+ * Delivery channel.
+ */
+deliveryChannel?: string
+/**
+ * SLA name.
+ */
+name?: string
+/**
+ * Information on each delivery ID.
+ */
+deliveryIds?: {
+/**
+ * Courier ID.
+ */
+courierId?: string
+/**
+ * Warehouse ID.
+ */
+warehouseId?: string
+/**
+ * Warehouse ID.
+ */
+dockId?: string
+/**
+ * Courier name.
+ */
+courierName?: string
+/**
+ * Quantity.
+ */
+quantity?: number
+}[]
+/**
+ * List of attachments details.
+ */
+attachmentOfferings?: (null | {
+/**
+ * Name of the attachment.
+ */
+name: (null | string)
+/**
+ * Defines if the attachment is required (`true`) or not (`false`).
+ */
+required: (null | boolean)
+/**
+ * Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).
+ */
+schema: (null | {
+
+})
+}[])
+/**
+ * Shipping estimate. For instance, "three business days" will be represented as `3bd`.
+ */
+shippingEstimate?: string
+/**
+ * When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.
+ */
+shippingEstimateDate?: (null | string)
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+useIndividualShippingEstimates?: boolean
+/**
+ * Estimate date of delivery.
+ */
+lockTTL?: (null | string)
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Tax in cents.
+ */
+tax?: number
+/**
+ * Information on the pickup store.
+ */
+pickupStoreInfo?: {
+/**
+ * Indicates whether it is the pickup store.
+ */
+isPickupStore?: boolean
+/**
+ * Friendly name.
+ */
+friendlyName?: (null | string)
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that repesent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Additional information.
+ */
+additionalInfo?: (null | string)
+/**
+ * Corresponding dock ID.
+ */
+dockId?: (null | string)
+}
+/**
+ * Pickup point ID.
+ */
+pickupPointId?: (null | string)
+/**
+ * Pickup point distance.
+ */
+pickupDistance?: number
+/**
+ * Polygon name.
+ */
+polygonName?: (null | string)
+/**
+ * Transit time. For instance, "three business days" is represented as `3bd`.
+ */
+transitTime?: string
+}[]
+/**
+ * List of countries that the item may be shipped to.
+ */
+shipsTo?: string[]
+/**
+ * Item ID.
+ */
+itemId?: string
+/**
+ * List of available delivery channels.
+ */
+deliveryChannels?: {
+/**
+ * Delivery channel ID.
+ */
+id?: string
+}[]
+}[]
+/**
+ * Array with information on the selected addresses for the order.
+ */
+selectedAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * Array with information on the available addresses for the order.
+ */
+availableAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+})
+/**
+ * Customer's profile information.
+ */
+clientProfileData?: (null | {
+/**
+ * Email address.
+ */
+email?: (null | string)
+/**
+ * First name.
+ */
+firstName?: (null | string)
+/**
+ * Last name.
+ */
+lastName?: string
+/**
+ * Type of the document informed by the customer.
+ */
+documentType?: string
+/**
+ * Document informed by the customer.
+ */
+document?: string
+/**
+ * Phone number.
+ */
+phone?: string
+/**
+ * Company name, if the customer is a legal entity.
+ */
+corporateName?: (null | string)
+/**
+ * Trade name, if the customer is a legal entity.
+ */
+tradeName?: (null | string)
+/**
+ * Corporate document, if the customer is a legal entity.
+ */
+corporateDocument?: (null | string)
+/**
+ * State inscription, if the customer is a legal entity.
+ */
+stateInscription?: (null | string)
+/**
+ * Corporate phone number, if the customer is a legal entity.
+ */
+corporatePhone?: (null | string)
+/**
+ * Indicates whether the customer is a legal entity.
+ */
+isCorporate?: boolean
+/**
+ * Indicates whether profile is complete on loading.
+ */
+profileCompleteOnLoading?: boolean
+/**
+ * Indicates whether profile presents error on loading.
+ */
+profileErrorOnLoading?: (null | boolean)
+/**
+ * Customer class.
+ */
+customerClass?: (null | string)
+})
+/**
+ * Information on the order's payment.
+ */
+paymentData?: {
+/**
+ * Gift card information, if it applies to the order.
+ */
+giftCards?: {
+/**
+ * Gift card redemption code.
+ */
+redemptionCode?: string
+/**
+ * Gift card value in cents.
+ */
+value?: number
+/**
+ * Gift card balance in cents.
+ */
+balance?: number
+/**
+ * Gift card name.
+ */
+name?: string
+/**
+ * Gift card ID.
+ */
+id?: string
+/**
+ * Indicates whether gift card is in use.
+ */
+inUse?: boolean
+/**
+ * Indicates whether gift card is special.
+ */
+isSpecialCard?: boolean
+}[]
+/**
+ * Information on each transaction pertinent to the order.
+ */
+transactions?: (null | {
+/**
+ * Indicates whether transaction is active.
+ */
+isActive?: boolean
+/**
+ * Transaction ID.
+ */
+transactionId?: string
+/**
+ * Merchant name.
+ */
+merchantName?: string
+/**
+ * Information on each payment.
+ */
+payments?: {
+/**
+ * Account ID.
+ */
+accountId?: string
+/**
+ * Bin.
+ */
+bin?: (null | string)
+/**
+ * Number of installments.
+ */
+installments?: number
+/**
+ * Payment system.
+ */
+paymentSystem?: string
+/**
+ * Reference value for calculating interest rates, in case it applies. Displayed in cents.
+ */
+referenceValue?: number
+/**
+ * Value including interest, in case it applies. Displayed in cents.
+ */
+value?: number
+}[]
+/**
+ * Indicates whather transaction is shared.
+ */
+sharedTransaction?: boolean
+})[]
+}
+/**
+ * Object containing promotion data such as coupon tracking information and internal or external UTMs.
+ */
+marketingData?: (null | {
+/**
+ * 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.
+ */
+coupon?: string
+/**
+ * UTM source.
+ */
+utmSource?: string
+/**
+ * UTM medium.
+ */
+utmMedium?: string
+/**
+ * UTM campaign.
+ */
+utmCampaign?: string
+/**
+ * utmi_page (internal utm).
+ */
+utmiPage?: (null | string)
+/**
+ * utmi_part (internal utm).
+ */
+utmiPart?: (null | string)
+/**
+ * utmi_campaign (internal utm).
+ */
+utmiCampaign?: (null | string)
+})
+/**
+ * Information on each seller.
+ */
+sellers?: {
+/**
+ * Seller ID.
+ */
+id?: string
+/**
+ * Seller name.
+ */
+name?: string
+/**
+ * Seller logo.
+ */
+logo?: (null | string)
+}[]
+/**
+ * Object containing preferences from the client who placed the order.
+ */
+clientPreferencesData?: {
+/**
+ * Client's locale. Examples: `pt-BR` and `en-US`.
+ */
+locale?: string
+/**
+ * `true` if the client opted to receive newsletter from the store.
+ */
+optinNewsLetter?: (null | boolean)
+}
+/**
+ * Object containing commercial condition information.
+ */
+commercialConditionData?: (null | {
+
+})
+/**
+ * Object containing data from the store's configuration (stored in VTEX's License Manager).
+ */
+storePreferencesData?: {
+
+}
+/**
+ * Gift registry list information.
+ */
+giftRegistryData?: (null | {
+
+})
+/**
+ * Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).
+ */
+openTextField?: (null | string)
+/**
+ * Invoice data including billing address.
+ */
+invoiceData?: (null | {
+/**
+ * Billing address.
+ */
+address?: {
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City name.
+ */
+city?: string
+/**
+ * State name.
+ */
+state?: string
+/**
+ * Country.
+ */
+country?: string
+/**
+ * Street name.
+ */
+street?: string
+/**
+ * Street number.
+ */
+number?: string
+/**
+ * Neighborhood.
+ */
+neighborhood?: string
+/**
+ * Address complement.
+ */
+complement?: string
+/**
+ * Reference for location.
+ */
+reference?: string
+/**
+ * Geographic coordinates (latitude, longitude).
+ */
+geoCoordinates?: number[]
+}
+})
+/**
+ * Customer additional information.
+ */
+customData?: (null | {
+
+})
+/**
+ * Item metadata.
+ */
+itemMetadata?: {
+/**
+ * List of objects containing metadata on each item in the order.
+ */
+items?: {
+/**
+ * Item ID.
+ */
+id?: string
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+}[]
+}
+/**
+ * Hooks information.
+ */
+hooksData?: (null | {
+
+})
+/**
+ * Information on rates and benefits that apply to the order.
+ */
+ratesAndBenefitsData?: {
+/**
+ * List with rates and benefits identifiers.
+ */
+rateAndBenefitsIdentifiers?: string[]
+/**
+ * List with rates and benefits teasers.
+ */
+teaser?: string[]
+}
+/**
+ * Subscription information.
+ */
+subscriptionData?: (null | {
+
+})
+/**
+ * Object containing information about the ordering of items within the `orderForm`.
+ */
+itemsOrdination?: {
+/**
+ * Criteria adopted to order the items in the list.
+ */
+criteria?: string
+/**
+ * Indicates whether the ordering is ascending.
+ */
+ascending?: boolean
+}
+}
+}
+/**
+ * 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`).
+ * 
+ * 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"PUT /api/checkout/pub/orderForm/:orderFormId/customData/:appId": {
+searchParams: {
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+/**
+ * Here you must add the pairs of Field Name and Field Value.
+ */
+body: {
+[k: string]: any
+}
+response: {
+/**
+ * ID of the orderForm corresponding to a specific cart.
+ */
+orderFormId?: string
+/**
+ * Attribute created by the seller, in their VTEX store configuration.
+ */
+salesChannel?: string
+/**
+ * Indicates whether the user is logged into the store.
+ */
+loggedIn?: boolean
+/**
+ * Indicates whether order is checked in.
+ */
+isCheckedIn?: boolean
+/**
+ * ID of the store.
+ */
+storeId?: (null | string)
+/**
+ * Permission to modify item price manually.
+ */
+allowManualPrice?: boolean
+/**
+ * Data can be edited.
+ */
+canEditData?: boolean
+/**
+ * Unique ID associated with the customer profile.
+ */
+userProfileId?: string
+/**
+ * Profile provider.
+ */
+profileProvider?: string
+/**
+ * Available accounts.
+ */
+availableAccounts?: string[]
+/**
+ * Information on each available address.
+ */
+availableAddresses?: {
+/**
+ * Address type.
+ */
+addressType?: string
+/**
+ * Name of the receiver.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * City of the address.
+ */
+city?: string
+/**
+ * State of the address.
+ */
+state?: string
+/**
+ * Country of the address. ISO three-letter code.
+ */
+country?: string
+/**
+ * Street of the address.
+ */
+street?: string
+/**
+ * Number of the address.
+ */
+number?: string
+/**
+ * Neighborhood of the address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Reference that may help in the location of the address.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * User type.
+ */
+userType?: (null | string)
+/**
+ * Ignore customer profile data.
+ */
+ignoreProfileData?: boolean
+/**
+ * Total value of the order without separating cents. For example, $24.99 is represented as `2499`.
+ */
+value?: number
+/**
+ * Array containing an object for each message generated by our servers while processing the request.
+ */
+messages?: string[]
+/**
+ * Information on each item in the order.
+ */
+items?: {
+/**
+ * Unique ID.
+ */
+uniqueId?: string
+/**
+ * ID of the item.
+ */
+id?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Product Ref ID.
+ */
+productRefId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Modal type.
+ */
+modalType?: (null | string)
+/**
+ * Parent item index.
+ */
+parentItemIndex?: (null | number)
+/**
+ * Parent assembly binding.
+ */
+parentAssemblyBinding?: (null | string)
+/**
+ * Price expiration date and time.
+ */
+priceValidUntil?: string
+/**
+ * Tax value in cents.
+ */
+tax?: number
+/**
+ * A unique identifier code assigned to a tax within the VTEX Admin.
+ */
+taxCode?: string
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Manual price in cents.
+ */
+manualPrice?: (null | number)
+/**
+ * User that applied the manual price, if that is the case.
+ */
+manualPriceAppliedBy?: (null | string)
+/**
+ * Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
+ */
+sellingPrice?: number
+/**
+ * Reward value in cents.
+ */
+rewardValue?: number
+/**
+ * Indicates whether item is a gift.
+ */
+isGift?: boolean
+/**
+ * Additional information.
+ */
+additionalInfo?: {
+/**
+ * Dimension.
+ */
+dimension?: (null | string)
+/**
+ * Brand name.
+ */
+brandName?: string
+/**
+ * Brand ID.
+ */
+brandId?: string
+/**
+ * Offering information.
+ */
+offeringInfo?: (null | string)
+/**
+ * Offering type.
+ */
+offeringType?: (null | string)
+/**
+ * Offering type ID.
+ */
+offeringTypeId?: (null | string)
+}
+/**
+ * Presale date.
+ */
+preSaleDate?: (null | string)
+/**
+ * Product category IDs.
+ */
+productCategoryIds?: string
+/**
+ * Object, where each field is an ID from `productCategoryIds`.
+ */
+productCategories?: {
+/**
+ * Product category corresponding to the ID in the field key.
+ */
+"{ID}"?: string
+}
+/**
+ * Quantity.
+ */
+quantity?: number
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
+ */
+sellerChain?: string[]
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+/**
+ * Information on services sold along with the SKU. Example: a gift package.
+ */
+bundleItems?: {
+/**
+ * Service type.
+ */
+type?: string
+/**
+ * Service identifier.
+ */
+id?: number
+/**
+ * Service name.
+ */
+name?: string
+/**
+ * Service price in cents.
+ */
+price?: number
+}[]
+/**
+ * Array containing information on attachments.
+ */
+attachments?: string[]
+/**
+ * Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.
+ */
+priceTags?: {
+/**
+ * Promotion unique identifier.
+ */
+identifier?: (null | string)
+/**
+ * Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.
+ */
+isPercentual?: boolean
+/**
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
+ * - `calculationId` is a hash that may vary with each price calculation.
+ */
+name?: string
+/**
+ * Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.
+ */
+rawValue?: number
+/**
+ * Price tag value representing either a promotion (value decrease) or a tax (value increase).
+ */
+value?: number
+}[]
+/**
+ * Availability.
+ */
+availability?: string
+/**
+ * Measurement unit.
+ */
+measurementUnit?: string
+/**
+ * Unit multiplier.
+ */
+unitMultiplier?: number
+/**
+ * Manufacturer code.
+ */
+manufacturerCode?: (null | string)
+/**
+ * Price information for all units of a specific item.
+ */
+priceDefinition?: {
+/**
+ * Item's calculated unitary selling price in cents.
+ */
+calculatedSellingPrice?: number
+/**
+ * Total value for all units of the item in cents.
+ */
+total?: number
+/**
+ * Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
+ */
+sellingPrices?: {
+/**
+ * Value in cents for that specific rounding.
+ */
+value?: number
+/**
+ * Rounding quantity, meaning how many items are rounded to this value.
+ */
+quantity?: number
+}[]
+}
+}[]
+/**
+ * Array containing the data of the item selected as a gift.
+ */
+selectableGifts?: string[]
+/**
+ * Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).
+ */
+totalizers?: {
+
+}[]
+/**
+ * Shipping information pertinent to the order.
+ */
+shippingData?: (null | {
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.
+ */
+logisticsInfo?: {
+/**
+ * Index corresponding to the position of the object in the `items` array.
+ */
+itemIndex?: number
+/**
+ * SLA selected by the customer.
+ */
+selectedSla?: (null | string)
+/**
+ * Delivery channel selected by the customer.
+ */
+selectedDeliveryChannel?: (null | string)
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Information on available SLAs.
+ */
+slas?: {
+/**
+ * SLA ID.
+ */
+id?: string
+/**
+ * Delivery channel.
+ */
+deliveryChannel?: string
+/**
+ * SLA name.
+ */
+name?: string
+/**
+ * Information on each delivery ID.
+ */
+deliveryIds?: {
+/**
+ * Courier ID.
+ */
+courierId?: string
+/**
+ * Warehouse ID.
+ */
+warehouseId?: string
+/**
+ * Warehouse ID.
+ */
+dockId?: string
+/**
+ * Courier name.
+ */
+courierName?: string
+/**
+ * Quantity.
+ */
+quantity?: number
+}[]
+/**
+ * List of attachments details.
+ */
+attachmentOfferings?: (null | {
+/**
+ * Name of the attachment.
+ */
+name: (null | string)
+/**
+ * Defines if the attachment is required (`true`) or not (`false`).
+ */
+required: (null | boolean)
+/**
+ * Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).
+ */
+schema: (null | {
+
+})
+}[])
+/**
+ * Shipping estimate. For instance, "three business days" will be represented as `3bd`.
+ */
+shippingEstimate?: string
+/**
+ * When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.
+ */
+shippingEstimateDate?: (null | string)
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+useIndividualShippingEstimates?: boolean
+/**
+ * Estimate date of delivery.
+ */
+lockTTL?: (null | string)
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Tax in cents.
+ */
+tax?: number
+/**
+ * Information on the pickup store.
+ */
+pickupStoreInfo?: {
+/**
+ * Indicates whether it is the pickup store.
+ */
+isPickupStore?: boolean
+/**
+ * Friendly name.
+ */
+friendlyName?: (null | string)
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that repesent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Additional information.
+ */
+additionalInfo?: (null | string)
+/**
+ * Corresponding dock ID.
+ */
+dockId?: (null | string)
+}
+/**
+ * Pickup point ID.
+ */
+pickupPointId?: (null | string)
+/**
+ * Pickup point distance.
+ */
+pickupDistance?: number
+/**
+ * Polygon name.
+ */
+polygonName?: (null | string)
+/**
+ * Transit time. For instance, "three business days" is represented as `3bd`.
+ */
+transitTime?: string
+}[]
+/**
+ * List of countries that the item may be shipped to.
+ */
+shipsTo?: string[]
+/**
+ * Item ID.
+ */
+itemId?: string
+/**
+ * List of available delivery channels.
+ */
+deliveryChannels?: {
+/**
+ * Delivery channel ID.
+ */
+id?: string
+}[]
+}[]
+/**
+ * Array with information on the selected addresses for the order.
+ */
+selectedAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * Array with information on the available addresses for the order.
+ */
+availableAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+})
+/**
+ * Customer's profile information.
+ */
+clientProfileData?: (null | {
+/**
+ * Email address.
+ */
+email?: (null | string)
+/**
+ * First name.
+ */
+firstName?: (null | string)
+/**
+ * Last name.
+ */
+lastName?: string
+/**
+ * Type of the document informed by the customer.
+ */
+documentType?: string
+/**
+ * Document informed by the customer.
+ */
+document?: string
+/**
+ * Phone number.
+ */
+phone?: string
+/**
+ * Company name, if the customer is a legal entity.
+ */
+corporateName?: (null | string)
+/**
+ * Trade name, if the customer is a legal entity.
+ */
+tradeName?: (null | string)
+/**
+ * Corporate document, if the customer is a legal entity.
+ */
+corporateDocument?: (null | string)
+/**
+ * State inscription, if the customer is a legal entity.
+ */
+stateInscription?: (null | string)
+/**
+ * Corporate phone number, if the customer is a legal entity.
+ */
+corporatePhone?: (null | string)
+/**
+ * Indicates whether the customer is a legal entity.
+ */
+isCorporate?: boolean
+/**
+ * Indicates whether profile is complete on loading.
+ */
+profileCompleteOnLoading?: boolean
+/**
+ * Indicates whether profile presents error on loading.
+ */
+profileErrorOnLoading?: (null | boolean)
+/**
+ * Customer class.
+ */
+customerClass?: (null | string)
+})
+/**
+ * Information on the order's payment.
+ */
+paymentData?: {
+/**
+ * Gift card information, if it applies to the order.
+ */
+giftCards?: {
+/**
+ * Gift card redemption code.
+ */
+redemptionCode?: string
+/**
+ * Gift card value in cents.
+ */
+value?: number
+/**
+ * Gift card balance in cents.
+ */
+balance?: number
+/**
+ * Gift card name.
+ */
+name?: string
+/**
+ * Gift card ID.
+ */
+id?: string
+/**
+ * Indicates whether gift card is in use.
+ */
+inUse?: boolean
+/**
+ * Indicates whether gift card is special.
+ */
+isSpecialCard?: boolean
+}[]
+/**
+ * Information on each transaction pertinent to the order.
+ */
+transactions?: (null | {
+/**
+ * Indicates whether transaction is active.
+ */
+isActive?: boolean
+/**
+ * Transaction ID.
+ */
+transactionId?: string
+/**
+ * Merchant name.
+ */
+merchantName?: string
+/**
+ * Information on each payment.
+ */
+payments?: {
+/**
+ * Account ID.
+ */
+accountId?: string
+/**
+ * Bin.
+ */
+bin?: (null | string)
+/**
+ * Number of installments.
+ */
+installments?: number
+/**
+ * Payment system.
+ */
+paymentSystem?: string
+/**
+ * Reference value for calculating interest rates, in case it applies. Displayed in cents.
+ */
+referenceValue?: number
+/**
+ * Value including interest, in case it applies. Displayed in cents.
+ */
+value?: number
+}[]
+/**
+ * Indicates whather transaction is shared.
+ */
+sharedTransaction?: boolean
+})[]
+}
+/**
+ * Object containing promotion data such as coupon tracking information and internal or external UTMs.
+ */
+marketingData?: (null | {
+/**
+ * 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.
+ */
+coupon?: string
+/**
+ * UTM source.
+ */
+utmSource?: string
+/**
+ * UTM medium.
+ */
+utmMedium?: string
+/**
+ * UTM campaign.
+ */
+utmCampaign?: string
+/**
+ * utmi_page (internal utm).
+ */
+utmiPage?: (null | string)
+/**
+ * utmi_part (internal utm).
+ */
+utmiPart?: (null | string)
+/**
+ * utmi_campaign (internal utm).
+ */
+utmiCampaign?: (null | string)
+})
+/**
+ * Information on each seller.
+ */
+sellers?: {
+/**
+ * Seller ID.
+ */
+id?: string
+/**
+ * Seller name.
+ */
+name?: string
+/**
+ * Seller logo.
+ */
+logo?: (null | string)
+}[]
+/**
+ * Object containing preferences from the client who placed the order.
+ */
+clientPreferencesData?: {
+/**
+ * Client's locale. Examples: `pt-BR` and `en-US`.
+ */
+locale?: string
+/**
+ * `true` if the client opted to receive newsletter from the store.
+ */
+optinNewsLetter?: (null | boolean)
+}
+/**
+ * Object containing commercial condition information.
+ */
+commercialConditionData?: (null | {
+
+})
+/**
+ * Object containing data from the store's configuration (stored in VTEX's License Manager).
+ */
+storePreferencesData?: {
+
+}
+/**
+ * Gift registry list information.
+ */
+giftRegistryData?: (null | {
+
+})
+/**
+ * Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).
+ */
+openTextField?: (null | string)
+/**
+ * Invoice data including billing address.
+ */
+invoiceData?: (null | {
+/**
+ * Billing address.
+ */
+address?: {
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City name.
+ */
+city?: string
+/**
+ * State name.
+ */
+state?: string
+/**
+ * Country.
+ */
+country?: string
+/**
+ * Street name.
+ */
+street?: string
+/**
+ * Street number.
+ */
+number?: string
+/**
+ * Neighborhood.
+ */
+neighborhood?: string
+/**
+ * Address complement.
+ */
+complement?: string
+/**
+ * Reference for location.
+ */
+reference?: string
+/**
+ * Geographic coordinates (latitude, longitude).
+ */
+geoCoordinates?: number[]
+}
+})
+/**
+ * Customer additional information.
+ */
+customData?: (null | {
+
+})
+/**
+ * Item metadata.
+ */
+itemMetadata?: {
+/**
+ * List of objects containing metadata on each item in the order.
+ */
+items?: {
+/**
+ * Item ID.
+ */
+id?: string
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+}[]
+}
+/**
+ * Hooks information.
+ */
+hooksData?: (null | {
+
+})
+/**
+ * Information on rates and benefits that apply to the order.
+ */
+ratesAndBenefitsData?: {
+/**
+ * List with rates and benefits identifiers.
+ */
+rateAndBenefitsIdentifiers?: string[]
+/**
+ * List with rates and benefits teasers.
+ */
+teaser?: string[]
+}
+/**
+ * Subscription information.
+ */
+subscriptionData?: (null | {
+
+})
+/**
+ * Object containing information about the ordering of items within the `orderForm`.
+ */
+itemsOrdination?: {
+/**
+ * Criteria adopted to order the items in the list.
+ */
+criteria?: string
+/**
+ * Indicates whether the ordering is ascending.
+ */
+ascending?: boolean
+}
+}
+}
+/**
+ * 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).
+ * 
+ * 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"PUT /api/checkout/pub/orderForm/:orderFormId/customData/:appId/:appFieldName": {
+searchParams: {
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+body: {
+/**
+ * The value you want to set to the specified field.
+ */
+value: string
+}
+response: {
+/**
+ * ID of the orderForm corresponding to a specific cart.
+ */
+orderFormId?: string
+/**
+ * Attribute created by the seller, in their VTEX store configuration.
+ */
+salesChannel?: string
+/**
+ * Indicates whether the user is logged into the store.
+ */
+loggedIn?: boolean
+/**
+ * Indicates whether order is checked in.
+ */
+isCheckedIn?: boolean
+/**
+ * ID of the store.
+ */
+storeId?: (null | string)
+/**
+ * Permission to modify item price manually.
+ */
+allowManualPrice?: boolean
+/**
+ * Data can be edited.
+ */
+canEditData?: boolean
+/**
+ * Unique ID associated with the customer profile.
+ */
+userProfileId?: string
+/**
+ * Profile provider.
+ */
+profileProvider?: string
+/**
+ * Available accounts.
+ */
+availableAccounts?: string[]
+/**
+ * Information on each available address.
+ */
+availableAddresses?: {
+/**
+ * Address type.
+ */
+addressType?: string
+/**
+ * Name of the receiver.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * City of the address.
+ */
+city?: string
+/**
+ * State of the address.
+ */
+state?: string
+/**
+ * Country of the address. ISO three-letter code.
+ */
+country?: string
+/**
+ * Street of the address.
+ */
+street?: string
+/**
+ * Number of the address.
+ */
+number?: string
+/**
+ * Neighborhood of the address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Reference that may help in the location of the address.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * User type.
+ */
+userType?: (null | string)
+/**
+ * Ignore customer profile data.
+ */
+ignoreProfileData?: boolean
+/**
+ * Total value of the order without separating cents. For example, $24.99 is represented as `2499`.
+ */
+value?: number
+/**
+ * Array containing an object for each message generated by our servers while processing the request.
+ */
+messages?: string[]
+/**
+ * Information on each item in the order.
+ */
+items?: {
+/**
+ * Unique ID.
+ */
+uniqueId?: string
+/**
+ * ID of the item.
+ */
+id?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Product Ref ID.
+ */
+productRefId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Modal type.
+ */
+modalType?: (null | string)
+/**
+ * Parent item index.
+ */
+parentItemIndex?: (null | number)
+/**
+ * Parent assembly binding.
+ */
+parentAssemblyBinding?: (null | string)
+/**
+ * Price expiration date and time.
+ */
+priceValidUntil?: string
+/**
+ * Tax value in cents.
+ */
+tax?: number
+/**
+ * A unique identifier code assigned to a tax within the VTEX Admin.
+ */
+taxCode?: string
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Manual price in cents.
+ */
+manualPrice?: (null | number)
+/**
+ * User that applied the manual price, if that is the case.
+ */
+manualPriceAppliedBy?: (null | string)
+/**
+ * Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
+ */
+sellingPrice?: number
+/**
+ * Reward value in cents.
+ */
+rewardValue?: number
+/**
+ * Indicates whether item is a gift.
+ */
+isGift?: boolean
+/**
+ * Additional information.
+ */
+additionalInfo?: {
+/**
+ * Dimension.
+ */
+dimension?: (null | string)
+/**
+ * Brand name.
+ */
+brandName?: string
+/**
+ * Brand ID.
+ */
+brandId?: string
+/**
+ * Offering information.
+ */
+offeringInfo?: (null | string)
+/**
+ * Offering type.
+ */
+offeringType?: (null | string)
+/**
+ * Offering type ID.
+ */
+offeringTypeId?: (null | string)
+}
+/**
+ * Presale date.
+ */
+preSaleDate?: (null | string)
+/**
+ * Product category IDs.
+ */
+productCategoryIds?: string
+/**
+ * Object, where each field is an ID from `productCategoryIds`.
+ */
+productCategories?: {
+/**
+ * Product category corresponding to the ID in the field key.
+ */
+"{ID}"?: string
+}
+/**
+ * Quantity.
+ */
+quantity?: number
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
+ */
+sellerChain?: string[]
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+/**
+ * Information on services sold along with the SKU. Example: a gift package.
+ */
+bundleItems?: {
+/**
+ * Service type.
+ */
+type?: string
+/**
+ * Service identifier.
+ */
+id?: number
+/**
+ * Service name.
+ */
+name?: string
+/**
+ * Service price in cents.
+ */
+price?: number
+}[]
+/**
+ * Array containing information on attachments.
+ */
+attachments?: string[]
+/**
+ * Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.
+ */
+priceTags?: {
+/**
+ * Promotion unique identifier.
+ */
+identifier?: (null | string)
+/**
+ * Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.
+ */
+isPercentual?: boolean
+/**
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
+ * - `calculationId` is a hash that may vary with each price calculation.
+ */
+name?: string
+/**
+ * Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.
+ */
+rawValue?: number
+/**
+ * Price tag value representing either a promotion (value decrease) or a tax (value increase).
+ */
+value?: number
+}[]
+/**
+ * Availability.
+ */
+availability?: string
+/**
+ * Measurement unit.
+ */
+measurementUnit?: string
+/**
+ * Unit multiplier.
+ */
+unitMultiplier?: number
+/**
+ * Manufacturer code.
+ */
+manufacturerCode?: (null | string)
+/**
+ * Price information for all units of a specific item.
+ */
+priceDefinition?: {
+/**
+ * Item's calculated unitary selling price in cents.
+ */
+calculatedSellingPrice?: number
+/**
+ * Total value for all units of the item in cents.
+ */
+total?: number
+/**
+ * Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
+ */
+sellingPrices?: {
+/**
+ * Value in cents for that specific rounding.
+ */
+value?: number
+/**
+ * Rounding quantity, meaning how many items are rounded to this value.
+ */
+quantity?: number
+}[]
+}
+}[]
+/**
+ * Array containing the data of the item selected as a gift.
+ */
+selectableGifts?: string[]
+/**
+ * Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).
+ */
+totalizers?: {
+
+}[]
+/**
+ * Shipping information pertinent to the order.
+ */
+shippingData?: (null | {
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.
+ */
+logisticsInfo?: {
+/**
+ * Index corresponding to the position of the object in the `items` array.
+ */
+itemIndex?: number
+/**
+ * SLA selected by the customer.
+ */
+selectedSla?: (null | string)
+/**
+ * Delivery channel selected by the customer.
+ */
+selectedDeliveryChannel?: (null | string)
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Information on available SLAs.
+ */
+slas?: {
+/**
+ * SLA ID.
+ */
+id?: string
+/**
+ * Delivery channel.
+ */
+deliveryChannel?: string
+/**
+ * SLA name.
+ */
+name?: string
+/**
+ * Information on each delivery ID.
+ */
+deliveryIds?: {
+/**
+ * Courier ID.
+ */
+courierId?: string
+/**
+ * Warehouse ID.
+ */
+warehouseId?: string
+/**
+ * Warehouse ID.
+ */
+dockId?: string
+/**
+ * Courier name.
+ */
+courierName?: string
+/**
+ * Quantity.
+ */
+quantity?: number
+}[]
+/**
+ * List of attachments details.
+ */
+attachmentOfferings?: (null | {
+/**
+ * Name of the attachment.
+ */
+name: (null | string)
+/**
+ * Defines if the attachment is required (`true`) or not (`false`).
+ */
+required: (null | boolean)
+/**
+ * Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).
+ */
+schema: (null | {
+
+})
+}[])
+/**
+ * Shipping estimate. For instance, "three business days" will be represented as `3bd`.
+ */
+shippingEstimate?: string
+/**
+ * When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.
+ */
+shippingEstimateDate?: (null | string)
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+useIndividualShippingEstimates?: boolean
+/**
+ * Estimate date of delivery.
+ */
+lockTTL?: (null | string)
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Tax in cents.
+ */
+tax?: number
+/**
+ * Information on the pickup store.
+ */
+pickupStoreInfo?: {
+/**
+ * Indicates whether it is the pickup store.
+ */
+isPickupStore?: boolean
+/**
+ * Friendly name.
+ */
+friendlyName?: (null | string)
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that repesent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Additional information.
+ */
+additionalInfo?: (null | string)
+/**
+ * Corresponding dock ID.
+ */
+dockId?: (null | string)
+}
+/**
+ * Pickup point ID.
+ */
+pickupPointId?: (null | string)
+/**
+ * Pickup point distance.
+ */
+pickupDistance?: number
+/**
+ * Polygon name.
+ */
+polygonName?: (null | string)
+/**
+ * Transit time. For instance, "three business days" is represented as `3bd`.
+ */
+transitTime?: string
+}[]
+/**
+ * List of countries that the item may be shipped to.
+ */
+shipsTo?: string[]
+/**
+ * Item ID.
+ */
+itemId?: string
+/**
+ * List of available delivery channels.
+ */
+deliveryChannels?: {
+/**
+ * Delivery channel ID.
+ */
+id?: string
+}[]
+}[]
+/**
+ * Array with information on the selected addresses for the order.
+ */
+selectedAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * Array with information on the available addresses for the order.
+ */
+availableAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+})
+/**
+ * Customer's profile information.
+ */
+clientProfileData?: (null | {
+/**
+ * Email address.
+ */
+email?: (null | string)
+/**
+ * First name.
+ */
+firstName?: (null | string)
+/**
+ * Last name.
+ */
+lastName?: string
+/**
+ * Type of the document informed by the customer.
+ */
+documentType?: string
+/**
+ * Document informed by the customer.
+ */
+document?: string
+/**
+ * Phone number.
+ */
+phone?: string
+/**
+ * Company name, if the customer is a legal entity.
+ */
+corporateName?: (null | string)
+/**
+ * Trade name, if the customer is a legal entity.
+ */
+tradeName?: (null | string)
+/**
+ * Corporate document, if the customer is a legal entity.
+ */
+corporateDocument?: (null | string)
+/**
+ * State inscription, if the customer is a legal entity.
+ */
+stateInscription?: (null | string)
+/**
+ * Corporate phone number, if the customer is a legal entity.
+ */
+corporatePhone?: (null | string)
+/**
+ * Indicates whether the customer is a legal entity.
+ */
+isCorporate?: boolean
+/**
+ * Indicates whether profile is complete on loading.
+ */
+profileCompleteOnLoading?: boolean
+/**
+ * Indicates whether profile presents error on loading.
+ */
+profileErrorOnLoading?: (null | boolean)
+/**
+ * Customer class.
+ */
+customerClass?: (null | string)
+})
+/**
+ * Information on the order's payment.
+ */
+paymentData?: {
+/**
+ * Gift card information, if it applies to the order.
+ */
+giftCards?: {
+/**
+ * Gift card redemption code.
+ */
+redemptionCode?: string
+/**
+ * Gift card value in cents.
+ */
+value?: number
+/**
+ * Gift card balance in cents.
+ */
+balance?: number
+/**
+ * Gift card name.
+ */
+name?: string
+/**
+ * Gift card ID.
+ */
+id?: string
+/**
+ * Indicates whether gift card is in use.
+ */
+inUse?: boolean
+/**
+ * Indicates whether gift card is special.
+ */
+isSpecialCard?: boolean
+}[]
+/**
+ * Information on each transaction pertinent to the order.
+ */
+transactions?: (null | {
+/**
+ * Indicates whether transaction is active.
+ */
+isActive?: boolean
+/**
+ * Transaction ID.
+ */
+transactionId?: string
+/**
+ * Merchant name.
+ */
+merchantName?: string
+/**
+ * Information on each payment.
+ */
+payments?: {
+/**
+ * Account ID.
+ */
+accountId?: string
+/**
+ * Bin.
+ */
+bin?: (null | string)
+/**
+ * Number of installments.
+ */
+installments?: number
+/**
+ * Payment system.
+ */
+paymentSystem?: string
+/**
+ * Reference value for calculating interest rates, in case it applies. Displayed in cents.
+ */
+referenceValue?: number
+/**
+ * Value including interest, in case it applies. Displayed in cents.
+ */
+value?: number
+}[]
+/**
+ * Indicates whather transaction is shared.
+ */
+sharedTransaction?: boolean
+})[]
+}
+/**
+ * Object containing promotion data such as coupon tracking information and internal or external UTMs.
+ */
+marketingData?: (null | {
+/**
+ * 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.
+ */
+coupon?: string
+/**
+ * UTM source.
+ */
+utmSource?: string
+/**
+ * UTM medium.
+ */
+utmMedium?: string
+/**
+ * UTM campaign.
+ */
+utmCampaign?: string
+/**
+ * utmi_page (internal utm).
+ */
+utmiPage?: (null | string)
+/**
+ * utmi_part (internal utm).
+ */
+utmiPart?: (null | string)
+/**
+ * utmi_campaign (internal utm).
+ */
+utmiCampaign?: (null | string)
+})
+/**
+ * Information on each seller.
+ */
+sellers?: {
+/**
+ * Seller ID.
+ */
+id?: string
+/**
+ * Seller name.
+ */
+name?: string
+/**
+ * Seller logo.
+ */
+logo?: (null | string)
+}[]
+/**
+ * Object containing preferences from the client who placed the order.
+ */
+clientPreferencesData?: {
+/**
+ * Client's locale. Examples: `pt-BR` and `en-US`.
+ */
+locale?: string
+/**
+ * `true` if the client opted to receive newsletter from the store.
+ */
+optinNewsLetter?: (null | boolean)
+}
+/**
+ * Object containing commercial condition information.
+ */
+commercialConditionData?: (null | {
+
+})
+/**
+ * Object containing data from the store's configuration (stored in VTEX's License Manager).
+ */
+storePreferencesData?: {
+
+}
+/**
+ * Gift registry list information.
+ */
+giftRegistryData?: (null | {
+
+})
+/**
+ * Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).
+ */
+openTextField?: (null | string)
+/**
+ * Invoice data including billing address.
+ */
+invoiceData?: (null | {
+/**
+ * Billing address.
+ */
+address?: {
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City name.
+ */
+city?: string
+/**
+ * State name.
+ */
+state?: string
+/**
+ * Country.
+ */
+country?: string
+/**
+ * Street name.
+ */
+street?: string
+/**
+ * Street number.
+ */
+number?: string
+/**
+ * Neighborhood.
+ */
+neighborhood?: string
+/**
+ * Address complement.
+ */
+complement?: string
+/**
+ * Reference for location.
+ */
+reference?: string
+/**
+ * Geographic coordinates (latitude, longitude).
+ */
+geoCoordinates?: number[]
+}
+})
+/**
+ * Customer additional information.
+ */
+customData?: (null | {
+
+})
+/**
+ * Item metadata.
+ */
+itemMetadata?: {
+/**
+ * List of objects containing metadata on each item in the order.
+ */
+items?: {
+/**
+ * Item ID.
+ */
+id?: string
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+}[]
+}
+/**
+ * Hooks information.
+ */
+hooksData?: (null | {
+
+})
+/**
+ * Information on rates and benefits that apply to the order.
+ */
+ratesAndBenefitsData?: {
+/**
+ * List with rates and benefits identifiers.
+ */
+rateAndBenefitsIdentifiers?: string[]
+/**
+ * List with rates and benefits teasers.
+ */
+teaser?: string[]
+}
+/**
+ * Subscription information.
+ */
+subscriptionData?: (null | {
+
+})
+/**
+ * Object containing information about the ordering of items within the `orderForm`.
+ */
+itemsOrdination?: {
+/**
+ * Criteria adopted to order the items in the list.
+ */
+criteria?: string
+/**
+ * Indicates whether the ordering is ascending.
+ */
+ascending?: boolean
+}
+}
+}
+/**
+ * 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"DELETE /api/checkout/pub/orderForm/:orderFormId/customData/:appId/:appFieldName": {
+searchParams: {
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+response: {
+/**
+ * ID of the orderForm corresponding to a specific cart.
+ */
+orderFormId?: string
+/**
+ * Attribute created by the seller, in their VTEX store configuration.
+ */
+salesChannel?: string
+/**
+ * Indicates whether the user is logged into the store.
+ */
+loggedIn?: boolean
+/**
+ * Indicates whether order is checked in.
+ */
+isCheckedIn?: boolean
+/**
+ * ID of the store.
+ */
+storeId?: (null | string)
+/**
+ * Permission to modify item price manually.
+ */
+allowManualPrice?: boolean
+/**
+ * Data can be edited.
+ */
+canEditData?: boolean
+/**
+ * Unique ID associated with the customer profile.
+ */
+userProfileId?: string
+/**
+ * Profile provider.
+ */
+profileProvider?: string
+/**
+ * Available accounts.
+ */
+availableAccounts?: string[]
+/**
+ * Information on each available address.
+ */
+availableAddresses?: {
+/**
+ * Address type.
+ */
+addressType?: string
+/**
+ * Name of the receiver.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * City of the address.
+ */
+city?: string
+/**
+ * State of the address.
+ */
+state?: string
+/**
+ * Country of the address. ISO three-letter code.
+ */
+country?: string
+/**
+ * Street of the address.
+ */
+street?: string
+/**
+ * Number of the address.
+ */
+number?: string
+/**
+ * Neighborhood of the address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Reference that may help in the location of the address.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * User type.
+ */
+userType?: (null | string)
+/**
+ * Ignore customer profile data.
+ */
+ignoreProfileData?: boolean
+/**
+ * Total value of the order without separating cents. For example, $24.99 is represented as `2499`.
+ */
+value?: number
+/**
+ * Array containing an object for each message generated by our servers while processing the request.
+ */
+messages?: string[]
+/**
+ * Information on each item in the order.
+ */
+items?: {
+/**
+ * Unique ID.
+ */
+uniqueId?: string
+/**
+ * ID of the item.
+ */
+id?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Product Ref ID.
+ */
+productRefId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Modal type.
+ */
+modalType?: (null | string)
+/**
+ * Parent item index.
+ */
+parentItemIndex?: (null | number)
+/**
+ * Parent assembly binding.
+ */
+parentAssemblyBinding?: (null | string)
+/**
+ * Price expiration date and time.
+ */
+priceValidUntil?: string
+/**
+ * Tax value in cents.
+ */
+tax?: number
+/**
+ * A unique identifier code assigned to a tax within the VTEX Admin.
+ */
+taxCode?: string
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Manual price in cents.
+ */
+manualPrice?: (null | number)
+/**
+ * User that applied the manual price, if that is the case.
+ */
+manualPriceAppliedBy?: (null | string)
+/**
+ * Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
+ */
+sellingPrice?: number
+/**
+ * Reward value in cents.
+ */
+rewardValue?: number
+/**
+ * Indicates whether item is a gift.
+ */
+isGift?: boolean
+/**
+ * Additional information.
+ */
+additionalInfo?: {
+/**
+ * Dimension.
+ */
+dimension?: (null | string)
+/**
+ * Brand name.
+ */
+brandName?: string
+/**
+ * Brand ID.
+ */
+brandId?: string
+/**
+ * Offering information.
+ */
+offeringInfo?: (null | string)
+/**
+ * Offering type.
+ */
+offeringType?: (null | string)
+/**
+ * Offering type ID.
+ */
+offeringTypeId?: (null | string)
+}
+/**
+ * Presale date.
+ */
+preSaleDate?: (null | string)
+/**
+ * Product category IDs.
+ */
+productCategoryIds?: string
+/**
+ * Object, where each field is an ID from `productCategoryIds`.
+ */
+productCategories?: {
+/**
+ * Product category corresponding to the ID in the field key.
+ */
+"{ID}"?: string
+}
+/**
+ * Quantity.
+ */
+quantity?: number
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
+ */
+sellerChain?: string[]
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+/**
+ * Information on services sold along with the SKU. Example: a gift package.
+ */
+bundleItems?: {
+/**
+ * Service type.
+ */
+type?: string
+/**
+ * Service identifier.
+ */
+id?: number
+/**
+ * Service name.
+ */
+name?: string
+/**
+ * Service price in cents.
+ */
+price?: number
+}[]
+/**
+ * Array containing information on attachments.
+ */
+attachments?: string[]
+/**
+ * Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.
+ */
+priceTags?: {
+/**
+ * Promotion unique identifier.
+ */
+identifier?: (null | string)
+/**
+ * Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.
+ */
+isPercentual?: boolean
+/**
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
+ * - `calculationId` is a hash that may vary with each price calculation.
+ */
+name?: string
+/**
+ * Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.
+ */
+rawValue?: number
+/**
+ * Price tag value representing either a promotion (value decrease) or a tax (value increase).
+ */
+value?: number
+}[]
+/**
+ * Availability.
+ */
+availability?: string
+/**
+ * Measurement unit.
+ */
+measurementUnit?: string
+/**
+ * Unit multiplier.
+ */
+unitMultiplier?: number
+/**
+ * Manufacturer code.
+ */
+manufacturerCode?: (null | string)
+/**
+ * Price information for all units of a specific item.
+ */
+priceDefinition?: {
+/**
+ * Item's calculated unitary selling price in cents.
+ */
+calculatedSellingPrice?: number
+/**
+ * Total value for all units of the item in cents.
+ */
+total?: number
+/**
+ * Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
+ */
+sellingPrices?: {
+/**
+ * Value in cents for that specific rounding.
+ */
+value?: number
+/**
+ * Rounding quantity, meaning how many items are rounded to this value.
+ */
+quantity?: number
+}[]
+}
+}[]
+/**
+ * Array containing the data of the item selected as a gift.
+ */
+selectableGifts?: string[]
+/**
+ * Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).
+ */
+totalizers?: {
+
+}[]
+/**
+ * Shipping information pertinent to the order.
+ */
+shippingData?: (null | {
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.
+ */
+logisticsInfo?: {
+/**
+ * Index corresponding to the position of the object in the `items` array.
+ */
+itemIndex?: number
+/**
+ * SLA selected by the customer.
+ */
+selectedSla?: (null | string)
+/**
+ * Delivery channel selected by the customer.
+ */
+selectedDeliveryChannel?: (null | string)
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Information on available SLAs.
+ */
+slas?: {
+/**
+ * SLA ID.
+ */
+id?: string
+/**
+ * Delivery channel.
+ */
+deliveryChannel?: string
+/**
+ * SLA name.
+ */
+name?: string
+/**
+ * Information on each delivery ID.
+ */
+deliveryIds?: {
+/**
+ * Courier ID.
+ */
+courierId?: string
+/**
+ * Warehouse ID.
+ */
+warehouseId?: string
+/**
+ * Warehouse ID.
+ */
+dockId?: string
+/**
+ * Courier name.
+ */
+courierName?: string
+/**
+ * Quantity.
+ */
+quantity?: number
+}[]
+/**
+ * List of attachments details.
+ */
+attachmentOfferings?: (null | {
+/**
+ * Name of the attachment.
+ */
+name: (null | string)
+/**
+ * Defines if the attachment is required (`true`) or not (`false`).
+ */
+required: (null | boolean)
+/**
+ * Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).
+ */
+schema: (null | {
+
+})
+}[])
+/**
+ * Shipping estimate. For instance, "three business days" will be represented as `3bd`.
+ */
+shippingEstimate?: string
+/**
+ * When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.
+ */
+shippingEstimateDate?: (null | string)
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+useIndividualShippingEstimates?: boolean
+/**
+ * Estimate date of delivery.
+ */
+lockTTL?: (null | string)
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Tax in cents.
+ */
+tax?: number
+/**
+ * Information on the pickup store.
+ */
+pickupStoreInfo?: {
+/**
+ * Indicates whether it is the pickup store.
+ */
+isPickupStore?: boolean
+/**
+ * Friendly name.
+ */
+friendlyName?: (null | string)
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that repesent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Additional information.
+ */
+additionalInfo?: (null | string)
+/**
+ * Corresponding dock ID.
+ */
+dockId?: (null | string)
+}
+/**
+ * Pickup point ID.
+ */
+pickupPointId?: (null | string)
+/**
+ * Pickup point distance.
+ */
+pickupDistance?: number
+/**
+ * Polygon name.
+ */
+polygonName?: (null | string)
+/**
+ * Transit time. For instance, "three business days" is represented as `3bd`.
+ */
+transitTime?: string
+}[]
+/**
+ * List of countries that the item may be shipped to.
+ */
+shipsTo?: string[]
+/**
+ * Item ID.
+ */
+itemId?: string
+/**
+ * List of available delivery channels.
+ */
+deliveryChannels?: {
+/**
+ * Delivery channel ID.
+ */
+id?: string
+}[]
+}[]
+/**
+ * Array with information on the selected addresses for the order.
+ */
+selectedAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * Array with information on the available addresses for the order.
+ */
+availableAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+})
+/**
+ * Customer's profile information.
+ */
+clientProfileData?: (null | {
+/**
+ * Email address.
+ */
+email?: (null | string)
+/**
+ * First name.
+ */
+firstName?: (null | string)
+/**
+ * Last name.
+ */
+lastName?: string
+/**
+ * Type of the document informed by the customer.
+ */
+documentType?: string
+/**
+ * Document informed by the customer.
+ */
+document?: string
+/**
+ * Phone number.
+ */
+phone?: string
+/**
+ * Company name, if the customer is a legal entity.
+ */
+corporateName?: (null | string)
+/**
+ * Trade name, if the customer is a legal entity.
+ */
+tradeName?: (null | string)
+/**
+ * Corporate document, if the customer is a legal entity.
+ */
+corporateDocument?: (null | string)
+/**
+ * State inscription, if the customer is a legal entity.
+ */
+stateInscription?: (null | string)
+/**
+ * Corporate phone number, if the customer is a legal entity.
+ */
+corporatePhone?: (null | string)
+/**
+ * Indicates whether the customer is a legal entity.
+ */
+isCorporate?: boolean
+/**
+ * Indicates whether profile is complete on loading.
+ */
+profileCompleteOnLoading?: boolean
+/**
+ * Indicates whether profile presents error on loading.
+ */
+profileErrorOnLoading?: (null | boolean)
+/**
+ * Customer class.
+ */
+customerClass?: (null | string)
+})
+/**
+ * Information on the order's payment.
+ */
+paymentData?: {
+/**
+ * Gift card information, if it applies to the order.
+ */
+giftCards?: {
+/**
+ * Gift card redemption code.
+ */
+redemptionCode?: string
+/**
+ * Gift card value in cents.
+ */
+value?: number
+/**
+ * Gift card balance in cents.
+ */
+balance?: number
+/**
+ * Gift card name.
+ */
+name?: string
+/**
+ * Gift card ID.
+ */
+id?: string
+/**
+ * Indicates whether gift card is in use.
+ */
+inUse?: boolean
+/**
+ * Indicates whether gift card is special.
+ */
+isSpecialCard?: boolean
+}[]
+/**
+ * Information on each transaction pertinent to the order.
+ */
+transactions?: (null | {
+/**
+ * Indicates whether transaction is active.
+ */
+isActive?: boolean
+/**
+ * Transaction ID.
+ */
+transactionId?: string
+/**
+ * Merchant name.
+ */
+merchantName?: string
+/**
+ * Information on each payment.
+ */
+payments?: {
+/**
+ * Account ID.
+ */
+accountId?: string
+/**
+ * Bin.
+ */
+bin?: (null | string)
+/**
+ * Number of installments.
+ */
+installments?: number
+/**
+ * Payment system.
+ */
+paymentSystem?: string
+/**
+ * Reference value for calculating interest rates, in case it applies. Displayed in cents.
+ */
+referenceValue?: number
+/**
+ * Value including interest, in case it applies. Displayed in cents.
+ */
+value?: number
+}[]
+/**
+ * Indicates whather transaction is shared.
+ */
+sharedTransaction?: boolean
+})[]
+}
+/**
+ * Object containing promotion data such as coupon tracking information and internal or external UTMs.
+ */
+marketingData?: (null | {
+/**
+ * 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.
+ */
+coupon?: string
+/**
+ * UTM source.
+ */
+utmSource?: string
+/**
+ * UTM medium.
+ */
+utmMedium?: string
+/**
+ * UTM campaign.
+ */
+utmCampaign?: string
+/**
+ * utmi_page (internal utm).
+ */
+utmiPage?: (null | string)
+/**
+ * utmi_part (internal utm).
+ */
+utmiPart?: (null | string)
+/**
+ * utmi_campaign (internal utm).
+ */
+utmiCampaign?: (null | string)
+})
+/**
+ * Information on each seller.
+ */
+sellers?: {
+/**
+ * Seller ID.
+ */
+id?: string
+/**
+ * Seller name.
+ */
+name?: string
+/**
+ * Seller logo.
+ */
+logo?: (null | string)
+}[]
+/**
+ * Object containing preferences from the client who placed the order.
+ */
+clientPreferencesData?: {
+/**
+ * Client's locale. Examples: `pt-BR` and `en-US`.
+ */
+locale?: string
+/**
+ * `true` if the client opted to receive newsletter from the store.
+ */
+optinNewsLetter?: (null | boolean)
+}
+/**
+ * Object containing commercial condition information.
+ */
+commercialConditionData?: (null | {
+
+})
+/**
+ * Object containing data from the store's configuration (stored in VTEX's License Manager).
+ */
+storePreferencesData?: {
+
+}
+/**
+ * Gift registry list information.
+ */
+giftRegistryData?: (null | {
+
+})
+/**
+ * Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).
+ */
+openTextField?: (null | string)
+/**
+ * Invoice data including billing address.
+ */
+invoiceData?: (null | {
+/**
+ * Billing address.
+ */
+address?: {
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City name.
+ */
+city?: string
+/**
+ * State name.
+ */
+state?: string
+/**
+ * Country.
+ */
+country?: string
+/**
+ * Street name.
+ */
+street?: string
+/**
+ * Street number.
+ */
+number?: string
+/**
+ * Neighborhood.
+ */
+neighborhood?: string
+/**
+ * Address complement.
+ */
+complement?: string
+/**
+ * Reference for location.
+ */
+reference?: string
+/**
+ * Geographic coordinates (latitude, longitude).
+ */
+geoCoordinates?: number[]
+}
+})
+/**
+ * Customer additional information.
+ */
+customData?: (null | {
+
+})
+/**
+ * Item metadata.
+ */
+itemMetadata?: {
+/**
+ * List of objects containing metadata on each item in the order.
+ */
+items?: {
+/**
+ * Item ID.
+ */
+id?: string
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+}[]
+}
+/**
+ * Hooks information.
+ */
+hooksData?: (null | {
+
+})
+/**
+ * Information on rates and benefits that apply to the order.
+ */
+ratesAndBenefitsData?: {
+/**
+ * List with rates and benefits identifiers.
+ */
+rateAndBenefitsIdentifiers?: string[]
+/**
+ * List with rates and benefits teasers.
+ */
+teaser?: string[]
+}
+/**
+ * Subscription information.
+ */
+subscriptionData?: (null | {
+
+})
+/**
+ * Object containing information about the ordering of items within the `orderForm`.
+ */
+itemsOrdination?: {
+/**
+ * Criteria adopted to order the items in the list.
+ */
+criteria?: string
+/**
+ * Indicates whether the ordering is ascending.
+ */
+ascending?: boolean
+}
+}
+}
+/**
+ * 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Save OrderForm Configuration** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"GET /api/checkout/pvt/configuration/orderForm": {
+searchParams: {
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+response: {
+/**
+ * Payment configuration information.
+ */
+paymentConfiguration?: {
+/**
+ * Determines whether pre-authorized payments require authentication.
+ */
+requiresAuthenticationForPreAuthorizedPaymentOption?: boolean
+/**
+ * By default (when `false`), on a multi-seller purchase is on the run, a simple intersection with installment options configured by every seller will be available. When indicated as `true`, this option allows a more complex but flexible installment option, since it considers max installments of every seller configuration, even if those do not match. Installment values may not be equal in this case.
+ */
+allowInstallmentsMerge?: boolean
+}
+/**
+ * External tax service configuration information.
+ */
+taxConfiguration?: (null | {
+/**
+ * Endpoint URL.
+ */
+url?: (null | string)
+/**
+ * Authorization header.
+ */
+authorizationHeader?: (null | string)
+/**
+ * Custom data ID sent to the tax system.
+ */
+appId?: string
+/**
+ * Indicates whether the marketplace is responsible for the products taxes.
+ */
+isMarketplaceResponsibleForTaxes?: boolean
+})
+/**
+ * Minimum SKU quantity by cart.
+ */
+minimumQuantityAccumulatedForItems?: number
+/**
+ * Number of price digits.
+ */
+decimalDigitsPrecision?: number
+/**
+ * Minimum cart value.
+ */
+minimumValueAccumulated?: (null | number)
+/**
+ * Array of objects containing Apps configuration information.
+ */
+apps?: (null | {
+/**
+ * App ID.
+ */
+id?: string
+/**
+ * Array of fields available to the app.
+ */
+fields?: string[]
+/**
+ * App major version.
+ */
+major?: number
+}[])
+/**
+ * On the same purchase, allows the selection of items from multiple delivery channels.
+ */
+allowMultipleDeliveries?: (null | boolean)
+/**
+ * Allows the editing of SKU prices right in the cart.
+ */
+allowManualPrice?: (null | boolean)
+/**
+ * Allows users to select whether they want the store to keep their personal and payment data saved.
+ */
+savePersonalDataAsOptIn?: (null | boolean)
+/**
+ * Allows the input of a limit of white label sellers involved on the cart.
+ */
+maxNumberOfWhiteLabelSellers?: (null | number)
+/**
+ * Allows, on a first purchase, masking client's data. It could be useful when a shared cart is used and the client does not want to share its data.
+ */
+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.
+ */
+recaptchaValidation?: string
+}
+}
+/**
+ * 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).
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Save OrderForm Configuration** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"POST /api/checkout/pvt/configuration/orderForm": {
+searchParams: {
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+body: {
+paymentConfiguration: PaymentConfiguration
+/**
+ * External tax service configuration.
+ */
+taxConfiguration: (null | {
+/**
+ * Endpoint URL.
+ */
+url?: (null | string)
+/**
+ * Authorization header.
+ */
+authorizationHeader?: (null | string)
+/**
+ * Custom data ID sent to the tax system.
+ */
+appId?: string
+/**
+ * Indicates whether the marketplace is responsible for the products taxes.
+ */
+isMarketplaceResponsibleForTaxes?: {
+[k: string]: any
+}
+})
+/**
+ * Minimum SKU quantity by cart.
+ */
+minimumQuantityAccumulatedForItems: number
+/**
+ * Number of price digits.
+ */
+decimalDigitsPrecision: number
+/**
+ * Minimum cart value.
+ */
+minimumValueAccumulated: (null | number)
+/**
+ * Array of objects containing Apps configuration information.
+ */
+apps: (null | {
+/**
+ * App ID.
+ */
+id?: string
+/**
+ * Array of fields available to the app.
+ */
+fields?: string[]
+/**
+ * App major version.
+ */
+major?: number
+}[])
+/**
+ * On the same purchase, allows the selection of items from multiple delivery channels.
+ */
+allowMultipleDeliveries: (null | boolean)
+/**
+ * Allows the editing of SKU prices right in the cart.
+ */
+allowManualPrice: (null | boolean)
+/**
+ * Allows the input of a limit of white label sellers involved on the cart.
+ */
+maxNumberOfWhiteLabelSellers?: number
+/**
+ * Allows, on a first purchase, masking client's data. It could be useful when a shared cart is used and the client doesn't want to share its data.
+ */
+maskFirstPurchaseData?: boolean
+/**
+ * If the response body is masked, on a first purchase, this flag causes the state (UF) to be masked. The default behavior is to be masked.
+ */
+maskStateOnAddress?: 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.
+ * - `null`: no purchases are validated with reCAPTCHA. The same as `never`.
+ * - `"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?: (null | string)
+/**
+ * If you want to apply a first installment discount to a particular payment system, set this field to that payment system's ID. Learn more: [Configuring a discount for orders prepaid in full](https://help.vtex.com/en/tutorial/configurar-desconto-de-preco-a-vista--7Lfcj9Wb5dpYfA2gKkACIt).
+ */
+paymentSystemToCheckFirstInstallment?: string
+}
+}
+/**
+ * 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Save OrderForm Configuration** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"GET /api/checkout/pvt/configuration/window-to-change-seller": {
+searchParams: {
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+}
+/**
+ * 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Save OrderForm Configuration** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"POST /api/checkout/pvt/configuration/window-to-change-seller": {
+searchParams: {
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+/**
+ * Object containing the days after order cancelation by a seller.
+ */
+body: {
+/**
+ * Number of days after order cancelation by a seller, during which another seller may be assigned to fulfill the order.
+ */
+waitingTime: number
+}
+}
+/**
+ * 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"POST /api/checkout/pub/orderForm/:orderFormId/messages/clear": {
+searchParams: {
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+/**
+ * This object must be empty.
+ */
+body: {
+
+}
+response: {
+/**
+ * ID of the orderForm corresponding to a specific cart.
+ */
+orderFormId?: string
+/**
+ * Attribute created by the seller, in their VTEX store configuration.
+ */
+salesChannel?: string
+/**
+ * Indicates whether the user is logged into the store.
+ */
+loggedIn?: boolean
+/**
+ * Indicates whether order is checked in.
+ */
+isCheckedIn?: boolean
+/**
+ * ID of the store.
+ */
+storeId?: (null | string)
+/**
+ * Permission to modify item price manually.
+ */
+allowManualPrice?: boolean
+/**
+ * Data can be edited.
+ */
+canEditData?: boolean
+/**
+ * Unique ID associated with the customer profile.
+ */
+userProfileId?: string
+/**
+ * Profile provider.
+ */
+profileProvider?: string
+/**
+ * Available accounts.
+ */
+availableAccounts?: string[]
+/**
+ * Information on each available address.
+ */
+availableAddresses?: {
+/**
+ * Address type.
+ */
+addressType?: string
+/**
+ * Name of the receiver.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * City of the address.
+ */
+city?: string
+/**
+ * State of the address.
+ */
+state?: string
+/**
+ * Country of the address. ISO three-letter code.
+ */
+country?: string
+/**
+ * Street of the address.
+ */
+street?: string
+/**
+ * Number of the address.
+ */
+number?: string
+/**
+ * Neighborhood of the address.
+ */
+neighborhood?: string
+/**
+ * Complement to the address.
+ */
+complement?: (null | string)
+/**
+ * Reference that may help in the location of the address.
+ */
+reference?: (null | string)
+/**
+ * Array containing two floats with geocoordinates, first longitude, then latitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * User type.
+ */
+userType?: (null | string)
+/**
+ * Ignore customer profile data.
+ */
+ignoreProfileData?: boolean
+/**
+ * Total value of the order without separating cents. For example, $24.99 is represented `2499`.
+ */
+value?: number
+/**
+ * Array containing an object for each message generated by our servers while processing the request.
+ */
+messages?: string[]
+/**
+ * Information on each item in the order.
+ */
+items?: {
+/**
+ * Unique ID.
+ */
+uniqueId?: string
+/**
+ * ID of the item.
+ */
+id?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Product Ref ID.
+ */
+productRefId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Modal type.
+ */
+modalType?: (null | string)
+/**
+ * Parent item index.
+ */
+parentItemIndex?: (null | number)
+/**
+ * Parent assembly binding.
+ */
+parentAssemblyBinding?: (null | string)
+/**
+ * Price expiration date and time.
+ */
+priceValidUntil?: string
+/**
+ * Tax value in cents.
+ */
+tax?: number
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Manual price in cents.
+ */
+manualPrice?: (null | number)
+/**
+ * User that applied the manual price, if that is the case.
+ */
+manualPriceAppliedBy?: (null | string)
+/**
+ * Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
+ */
+sellingPrice?: number
+/**
+ * Reward value in cents.
+ */
+rewardValue?: number
+/**
+ * Indicates whether item is a gift.
+ */
+isGift?: boolean
+/**
+ * Additional information.
+ */
+additionalInfo?: {
+/**
+ * Dimension.
+ */
+dimension?: (null | string)
+/**
+ * Brand name.
+ */
+brandName?: string
+/**
+ * Brand ID.
+ */
+brandId?: string
+/**
+ * Offering information.
+ */
+offeringInfo?: (null | string)
+/**
+ * Offering type.
+ */
+offeringType?: (null | string)
+/**
+ * Offering type ID.
+ */
+offeringTypeId?: (null | string)
+}
+/**
+ * Presale date.
+ */
+preSaleDate?: (null | string)
+/**
+ * Product category IDs.
+ */
+productCategoryIds?: string
+/**
+ * Object, where each field is an ID from `productCategoryIds`.
+ */
+productCategories?: {
+/**
+ * Product category corresponding to the ID in the field key.
+ */
+"{ID}"?: string
+}
+/**
+ * Quantity.
+ */
+quantity?: number
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
+ */
+sellerChain?: string[]
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+/**
+ * Information on services sold along with the SKU. Example: a gift package.
+ */
+bundleItems?: {
+/**
+ * Service type.
+ */
+type?: string
+/**
+ * Service identifier.
+ */
+id?: number
+/**
+ * Service name.
+ */
+name?: string
+/**
+ * Service price in cents.
+ */
+price?: number
+}[]
+/**
+ * Array containing information on attachments.
+ */
+attachments?: string[]
+/**
+ * Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.
+ */
+priceTags?: {
+/**
+ * Promotion unique identifier.
+ */
+identifier?: (null | string)
+/**
+ * Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.
+ */
+isPercentual?: boolean
+/**
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
+ * - `calculationId` is a hash that may vary with each price calculation.
+ */
+name?: string
+/**
+ * Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.
+ */
+rawValue?: number
+/**
+ * Price tag value representing either a promotion (value decrease) or a tax (value increase).
+ */
+value?: number
+}[]
+/**
+ * Availability.
+ */
+availability?: string
+/**
+ * Measurement unit.
+ */
+measurementUnit?: string
+/**
+ * Unit multiplier.
+ */
+unitMultiplier?: number
+/**
+ * Manufacturer code.
+ */
+manufacturerCode?: (null | string)
+/**
+ * Price information for all units of a specific item.
+ */
+priceDefinition?: {
+/**
+ * Item's calculated unitary selling price in cents.
+ */
+calculatedSellingPrice?: number
+/**
+ * Total value for all units of the item in cents.
+ */
+total?: number
+/**
+ * Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
+ */
+sellingPrices?: {
+/**
+ * Value in cents for that specific rounding.
+ */
+value?: number
+/**
+ * Rounding quantity, meaning how many items are rounded to this value.
+ */
+quantity?: number
+}[]
+}
+}[]
+/**
+ * Array containing the data of the item selected as a gift.
+ */
+selectableGifts?: string[]
+/**
+ * Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).
+ */
+totalizers?: {
+
+}[]
+/**
+ * Shipping information pertinent to the order.
+ */
+shippingData?: (null | {
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array containing two floats with geocoordinates, first longitude, then latitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.
+ */
+logisticsInfo?: {
+/**
+ * Index corresponding to the position of the object in the `items` array.
+ */
+itemIndex?: number
+/**
+ * SLA selected by the customer.
+ */
+selectedSla?: (null | string)
+/**
+ * Delivery channel selected by the customer.
+ */
+selectedDeliveryChannel?: (null | string)
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Information on available SLAs.
+ */
+slas?: {
+/**
+ * SLA ID.
+ */
+id?: string
+/**
+ * Delivery channel.
+ */
+deliveryChannel?: string
+/**
+ * SLA name.
+ */
+name?: string
+/**
+ * Information on each delivery ID.
+ */
+deliveryIds?: {
+/**
+ * Courier ID.
+ */
+courierId?: string
+/**
+ * Warehouse ID.
+ */
+warehouseId?: string
+/**
+ * Warehouse ID.
+ */
+dockId?: string
+/**
+ * Courier name.
+ */
+courierName?: string
+/**
+ * Quantity.
+ */
+quantity?: number
+}[]
+/**
+ * List of attachments details.
+ */
+attachmentOfferings?: (null | {
+/**
+ * Name of the attachment.
+ */
+name: (null | string)
+/**
+ * Defines if the attachment is required (`true`) or not (`false`).
+ */
+required: (null | boolean)
+/**
+ * Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).
+ */
+schema: (null | {
+
+})
+}[])
+/**
+ * Shipping estimate. For instance, Three business days will be represented `3bd`.
+ */
+shippingEstimate?: string
+/**
+ * When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.
+ */
+shippingEstimateDate?: (null | string)
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+useIndividualShippingEstimates?: boolean
+/**
+ * Estimate date of delivery.
+ */
+lockTTL?: (null | string)
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Tax in cents.
+ */
+tax?: number
+/**
+ * Information on the pickup store.
+ */
+pickupStoreInfo?: {
+/**
+ * Indicates whether it is the pickup store.
+ */
+isPickupStore?: boolean
+/**
+ * Friendly name.
+ */
+friendlyName?: (null | string)
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array containing two floats with geocoordinates, first longitude, then latitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Additional information.
+ */
+additionalInfo?: (null | string)
+/**
+ * Corresponding dock ID.
+ */
+dockId?: (null | string)
+}
+/**
+ * Pickup point ID.
+ */
+pickupPointId?: (null | string)
+/**
+ * Pickup point distance.
+ */
+pickupDistance?: number
+/**
+ * Polygon name.
+ */
+polygonName?: (null | string)
+/**
+ * Transit time. For instance, "three business days" is represented `3bd`.
+ */
+transitTime?: string
+}[]
+/**
+ * List of countries that the item may be shipped to.
+ */
+shipsTo?: string[]
+/**
+ * Item ID.
+ */
+itemId?: string
+/**
+ * List of available delivery channels.
+ */
+deliveryChannels?: {
+/**
+ * Delivery channel ID.
+ */
+id?: string
+}[]
+}[]
+/**
+ * Array with information on the selected addresses for the order.
+ */
+selectedAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array containing two floats with geocoordinates, first longitude, then latitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * Array with information on the available addresses for the order.
+ */
+availableAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array containing two floats with geocoordinates, first longitude, then latitude.
+ */
+geoCoordinates?: number[]
+}[]
+})
+/**
+ * Customer's profile information.
+ */
+clientProfileData?: (null | {
+/**
+ * Email address.
+ */
+email?: (null | string)
+/**
+ * First name.
+ */
+firstName?: (null | string)
+/**
+ * Last name.
+ */
+lastName?: string
+/**
+ * Type of the document informed by the customer.
+ */
+documentType?: string
+/**
+ * Document informed by the customer.
+ */
+document?: string
+/**
+ * Phone number.
+ */
+phone?: string
+/**
+ * Company name, if the customer is a legal entity.
+ */
+corporateName?: (null | string)
+/**
+ * Trade name, if the customer is a legal entity.
+ */
+tradeName?: (null | string)
+/**
+ * Corporate document, if the customer is a legal entity.
+ */
+corporateDocument?: (null | string)
+/**
+ * State inscription, if the customer is a legal entity.
+ */
+stateInscription?: (null | string)
+/**
+ * Corporate phone number, if the customer is a legal entity.
+ */
+corporatePhone?: (null | string)
+/**
+ * Indicates whether the customer is a legal entity.
+ */
+isCorporate?: boolean
+/**
+ * Indicates whether profile is complete on loading.
+ */
+profileCompleteOnLoading?: boolean
+/**
+ * Indicates whether profile presents error on loading.
+ */
+profileErrorOnLoading?: (null | boolean)
+/**
+ * Customer class.
+ */
+customerClass?: (null | string)
+})
+/**
+ * Information on the order's payment.
+ */
+paymentData?: {
+/**
+ * Gift card information, if it applies to the order.
+ */
+giftCards?: {
+/**
+ * Gift card redemption code.
+ */
+redemptionCode?: string
+/**
+ * Gift card value in cents.
+ */
+value?: number
+/**
+ * Gift card balance in cents.
+ */
+balance?: number
+/**
+ * Gift card name.
+ */
+name?: string
+/**
+ * Gift card ID.
+ */
+id?: string
+/**
+ * Indicates whether gift card is in use.
+ */
+inUse?: boolean
+/**
+ * Indicates whether gift card is special.
+ */
+isSpecialCard?: boolean
+}[]
+/**
+ * Information on each transaction pertinent to the order.
+ */
+transactions?: {
+/**
+ * Indicates whether transaction is active.
+ */
+isActive?: boolean
+/**
+ * Transaction ID.
+ */
+transactionId?: string
+/**
+ * Merchant name.
+ */
+merchantName?: string
+/**
+ * Information on each payment.
+ */
+payments?: {
+/**
+ * Account ID.
+ */
+accountId?: (null | string)
+/**
+ * Bin.
+ */
+bin?: (null | string)
+/**
+ * Number of installments.
+ */
+installments?: number
+/**
+ * Payment system.
+ */
+paymentSystem?: number
+/**
+ * Reference value for calculating interest rates, in case it applies. Displayed in cents.
+ */
+referenceValue?: number
+/**
+ * Value including interest, in case it applies. Displayed in cents.
+ */
+value?: number
+}[]
+/**
+ * Indicates whather transaction is shared.
+ */
+sharedTransaction?: boolean
+}[]
+}
+/**
+ * Object containing promotion data such as coupon tracking information and internal or external UTMs.
+ */
+marketingData?: (null | {
+/**
+ * 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.
+ */
+coupon?: string
+/**
+ * UTM source.
+ */
+utmSource?: string
+/**
+ * UTM medium.
+ */
+utmMedium?: string
+/**
+ * UTM campaign.
+ */
+utmCampaign?: string
+/**
+ * utmi_page (internal utm).
+ */
+utmiPage?: (null | string)
+/**
+ * utmi_part (internal utm).
+ */
+utmiPart?: (null | string)
+/**
+ * utmi_campaign (internal utm).
+ */
+utmiCampaign?: (null | string)
+})
+/**
+ * Information on each seller.
+ */
+sellers?: {
+/**
+ * Seller ID.
+ */
+id?: string
+/**
+ * Seller name.
+ */
+name?: string
+/**
+ * Seller logo.
+ */
+logo?: (null | string)
+}[]
+/**
+ * Object containing preferences from the client who placed the order.
+ */
+clientPreferencesData?: {
+/**
+ * Client's locale. Examples: `pt-BR` and `en-US`.
+ */
+locale?: string
+/**
+ * `true` if the client opted to receive newsletter from the store.
+ */
+optinNewsLetter?: (null | boolean)
+}
+/**
+ * Object containing commercial condition information.
+ */
+commercialConditionData?: (null | {
+
+})
+/**
+ * Object containing data from the store's configuration (stored in VTEX's License Manager).
+ */
+storePreferencesData?: {
+
+}
+/**
+ * Gift registry list information.
+ */
+giftRegistryData?: (null | {
+
+})
+/**
+ * Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).
+ */
+openTextField?: (null | string)
+/**
+ * Object containing information pertinent to the order's invoice.
+ */
+invoiceData?: (null | {
+
+})
+/**
+ * Customer additional information.
+ */
+customData?: (null | {
+
+})
+/**
+ * Item metadata.
+ */
+itemMetadata?: {
+/**
+ * List of objects containing metadata on each item in the order.
+ */
+items?: {
+/**
+ * Item ID.
+ */
+id?: string
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+}[]
+}
+/**
+ * Hooks information.
+ */
+hooksData?: (null | {
+
+})
+/**
+ * Information on rates and benefits that apply to the order.
+ */
+ratesAndBenefitsData?: {
+/**
+ * List with rates and benefits identifiers.
+ */
+rateAndBenefitsIdentifiers?: string[]
+/**
+ * List with rates and benefits teasers.
+ */
+teaser?: string[]
+}
+/**
+ * Subscription information.
+ */
+subscriptionData?: (null | {
+
+})
+/**
+ * Object containing information about the ordering of items within the orderForm.
+ */
+itemsOrdination?: {
+/**
+ * Criteria adopted to order the items in the list.
+ */
+criteria?: string
+/**
+ * Indicates whether the ordering is ascending.
+ */
+ascending?: boolean
+}
+}
+}
+/**
+ * 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`.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"GET /api/checkout/pub/orderForm/:orderFormId/installments": {
+searchParams: {
+/**
+ * ID of the payment method to be consulted for installments.
+ */
+paymentSystem: number
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+response: {
+/**
+ * Bin.
+ */
+bin?: (null | string)
+/**
+ * Array of installments.
+ */
+installments?: {
+/**
+ * An explanation about the purpose of this instance.
+ */
+count?: number
+/**
+ * An explanation about the purpose of this instance.
+ */
+hasInterestRate?: boolean
+/**
+ * An explanation about the purpose of this instance.
+ */
+interestRate?: number
+/**
+ * An explanation about the purpose of this instance.
+ */
+value?: number
+/**
+ * An explanation about the purpose of this instance.
+ */
+total?: number
+/**
+ * An explanation about the purpose of this instance.
+ */
+sellerMerchantInstallments?: {
+/**
+ * Installment ID.
+ */
+id?: string
+/**
+ * Count.
+ */
+count?: number
+/**
+ * If the installment has an interest rate.
+ */
+hasInterestRate?: boolean
+/**
+ * Interest rate number.
+ */
+interestRate?: number
+/**
+ * Installment value.
+ */
+value?: number
+/**
+ * Installment total.
+ */
+total?: number
+}[]
+}[]
+/**
+ * Payment system.
+ */
+paymentSystem?: number
+/**
+ * Value including interest, in case it applies. Displayed in cents.
+ */
+value?: number
+/**
+ * Payment name.
+ */
+paymentName?: (null | string)
+/**
+ * Payment group name.
+ */
+paymentGroupName?: (null | string)
+}
+}
+/**
+ * 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"}.
+ * 
+ * For more information on multiple coupons, access the [coupons tutorial](https://help.vtex.com/en/tutorial/creating-a-coupon-beta--7lMk3MmhNp2IEccyGApxU).
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"POST /api/checkout/pub/orderForm/:orderFormId/coupons": {
+searchParams: {
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+body: {
+/**
+ * Sending an existing coupon code in this field will return the corresponding discount in the purchase.
+ */
+text?: string
+}
+response: {
+/**
+ * ID of the orderForm corresponding to a specific cart.
+ */
+orderFormId?: string
+/**
+ * Attribute created by the seller, in their VTEX store configuration.
+ */
+salesChannel?: string
+/**
+ * Indicates whether the user is logged into the store.
+ */
+loggedIn?: boolean
+/**
+ * Indicates whether order is checked in.
+ */
+isCheckedIn?: boolean
+/**
+ * ID of the store.
+ */
+storeId?: (null | string)
+/**
+ * Permission to modify item price manually.
+ */
+allowManualPrice?: boolean
+/**
+ * Data can be edited.
+ */
+canEditData?: boolean
+/**
+ * Unique ID associated with the customer profile.
+ */
+userProfileId?: string
+/**
+ * Profile provider.
+ */
+profileProvider?: string
+/**
+ * Available accounts.
+ */
+availableAccounts?: string[]
+/**
+ * Information on each available address.
+ */
+availableAddresses?: {
+/**
+ * Address type.
+ */
+addressType?: string
+/**
+ * Name of the receiver.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * City of the address.
+ */
+city?: string
+/**
+ * State of the address.
+ */
+state?: string
+/**
+ * Country of the address. ISO three-letter code.
+ */
+country?: string
+/**
+ * Street of the address.
+ */
+street?: string
+/**
+ * Number of the address.
+ */
+number?: string
+/**
+ * Neighborhood of the address.
+ */
+neighborhood?: string
+/**
+ * Complement to the address.
+ */
+complement?: (null | string)
+/**
+ * Reference that may help in the location of the address.
+ */
+reference?: (null | string)
+/**
+ * Array containing two floats with geocoordinates, first longitude, then latitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * User type.
+ */
+userType?: (null | string)
+/**
+ * Ignore customer profile data.
+ */
+ignoreProfileData?: boolean
+/**
+ * Total value of the order without separating cents. For example, $24.99 is represented `2499`.
+ */
+value?: number
+/**
+ * Array containing an object for each message generated by our servers while processing the request.
+ */
+messages?: string[]
+/**
+ * Information on each item in the order.
+ */
+items?: {
+/**
+ * Unique ID.
+ */
+uniqueId?: string
+/**
+ * ID of the item.
+ */
+id?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Product Ref ID.
+ */
+productRefId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Modal type.
+ */
+modalType?: (null | string)
+/**
+ * Parent item index.
+ */
+parentItemIndex?: (null | number)
+/**
+ * Parent assembly binding.
+ */
+parentAssemblyBinding?: (null | string)
+/**
+ * Price expiration date and time.
+ */
+priceValidUntil?: string
+/**
+ * Tax value in cents.
+ */
+tax?: number
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Manual price in cents.
+ */
+manualPrice?: (null | number)
+/**
+ * User that applied the manual price, if that is the case.
+ */
+manualPriceAppliedBy?: (null | string)
+/**
+ * Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
+ */
+sellingPrice?: number
+/**
+ * Reward value in cents.
+ */
+rewardValue?: number
+/**
+ * Indicates whether item is a gift.
+ */
+isGift?: boolean
+/**
+ * Additional information.
+ */
+additionalInfo?: {
+/**
+ * Dimension.
+ */
+dimension?: (null | string)
+/**
+ * Brand name.
+ */
+brandName?: string
+/**
+ * Brand ID.
+ */
+brandId?: string
+/**
+ * Offering information.
+ */
+offeringInfo?: (null | string)
+/**
+ * Offering type.
+ */
+offeringType?: (null | string)
+/**
+ * Offering type ID.
+ */
+offeringTypeId?: (null | string)
+}
+/**
+ * Presale date.
+ */
+preSaleDate?: (null | string)
+/**
+ * Product category IDs.
+ */
+productCategoryIds?: string
+/**
+ * Object, where each field is an ID from `productCategoryIds`.
+ */
+productCategories?: {
+/**
+ * Product category corresponding to the ID in the field key.
+ */
+"{ID}"?: string
+}
+/**
+ * Quantity.
+ */
+quantity?: number
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
+ */
+sellerChain?: string[]
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+/**
+ * Information on services sold along with the SKU. Example: a gift package.
+ */
+bundleItems?: {
+/**
+ * Service type.
+ */
+type?: string
+/**
+ * Service identifier.
+ */
+id?: number
+/**
+ * Service name.
+ */
+name?: string
+/**
+ * Service price in cents.
+ */
+price?: number
+}[]
+/**
+ * Array containing information on attachments.
+ */
+attachments?: string[]
+/**
+ * Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.
+ */
+priceTags?: {
+/**
+ * Promotion unique identifier.
+ */
+identifier?: (null | string)
+/**
+ * Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.
+ */
+isPercentual?: boolean
+/**
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
+ * - `calculationId` is a hash that may vary with each price calculation.
+ */
+name?: string
+/**
+ * Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.
+ */
+rawValue?: number
+/**
+ * Price tag value representing either a promotion (value decrease) or a tax (value increase).
+ */
+value?: number
+}[]
+/**
+ * Availability.
+ */
+availability?: string
+/**
+ * Measurement unit.
+ */
+measurementUnit?: string
+/**
+ * Unit multiplier.
+ */
+unitMultiplier?: number
+/**
+ * Manufacturer code.
+ */
+manufacturerCode?: (null | string)
+/**
+ * Price information for all units of a specific item.
+ */
+priceDefinition?: {
+/**
+ * Item's calculated unitary selling price in cents.
+ */
+calculatedSellingPrice?: number
+/**
+ * Total value for all units of the item in cents.
+ */
+total?: number
+/**
+ * Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
+ */
+sellingPrices?: {
+/**
+ * Value in cents for that specific rounding.
+ */
+value?: number
+/**
+ * Rounding quantity, meaning how many items are rounded to this value.
+ */
+quantity?: number
+}[]
+}
+}[]
+/**
+ * Array containing the data of the item selected as a gift.
+ */
+selectableGifts?: string[]
+/**
+ * Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).
+ */
+totalizers?: {
+
+}[]
+/**
+ * Shipping information pertinent to the order.
+ */
+shippingData?: (null | {
+/**
+ * Address information.
+ */
+address?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array containing two floats with geocoordinates, first longitude, then latitude.
+ */
+geoCoordinates?: number[]
+}
+/**
+ * Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.
+ */
+logisticsInfo?: {
+/**
+ * Index corresponding to the position of the object in the `items` array.
+ */
+itemIndex?: number
+/**
+ * SLA selected by the customer.
+ */
+selectedSla?: (null | string)
+/**
+ * Delivery channel selected by the customer.
+ */
+selectedDeliveryChannel?: (null | string)
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Information on available SLAs.
+ */
+slas?: {
+/**
+ * SLA ID.
+ */
+id?: string
+/**
+ * Delivery channel.
+ */
+deliveryChannel?: string
+/**
+ * SLA name.
+ */
+name?: string
+/**
+ * Information on each delivery ID.
+ */
+deliveryIds?: {
+/**
+ * Courier ID.
+ */
+courierId?: string
+/**
+ * Warehouse ID.
+ */
+warehouseId?: string
+/**
+ * Warehouse ID.
+ */
+dockId?: string
+/**
+ * Courier name.
+ */
+courierName?: string
+/**
+ * Quantity.
+ */
+quantity?: number
+}[]
+/**
+ * Shipping estimate. For instance, Three business days will be represented `3bd`.
+ */
+shippingEstimate?: string
+/**
+ * When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.
+ */
+shippingEstimateDate?: (null | string)
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+useIndividualShippingEstimates?: boolean
+/**
+ * Estimate date of delivery.
+ */
+lockTTL?: (null | string)
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Tax in cents.
+ */
+tax?: number
+/**
+ * Information on the pickup store.
+ */
+pickupStoreInfo?: {
+/**
+ * Indicates whether it is the pickup store.
+ */
+isPickupStore?: boolean
+/**
+ * Friendly name.
+ */
+friendlyName?: (null | string)
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array containing two floats with geocoordinates, first longitude, then latitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Additional information.
+ */
+additionalInfo?: (null | string)
+/**
+ * Corresponding dock ID.
+ */
+dockId?: (null | string)
+}
+/**
+ * Pickup point ID.
+ */
+pickupPointId?: (null | string)
+/**
+ * Pickup point distance.
+ */
+pickupDistance?: number
+/**
+ * Polygon name.
+ */
+polygonName?: (null | string)
+/**
+ * Transit time. For instance, "three business days" is represented `3bd`.
+ */
+transitTime?: string
+}[]
+/**
+ * List of countries that the item may be shipped to.
+ */
+shipsTo?: string[]
+/**
+ * Item ID.
+ */
+itemId?: string
+/**
+ * List of available delivery channels.
+ */
+deliveryChannels?: {
+/**
+ * Delivery channel ID.
+ */
+id?: string
+}[]
+}[]
+/**
+ * Array with information on the selected addresses for the order.
+ */
+selectedAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array containing two floats with geocoordinates, first longitude, then latitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * Array with information on the available addresses for the order.
+ */
+availableAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array containing two floats with geocoordinates, first longitude, then latitude.
+ */
+geoCoordinates?: number[]
+}[]
+})
+/**
+ * Customer's profile information.
+ */
+clientProfileData?: (null | {
+/**
+ * Email address.
+ */
+email?: (null | string)
+/**
+ * First name.
+ */
+firstName?: (null | string)
+/**
+ * Last name.
+ */
+lastName?: string
+/**
+ * Type of the document informed by the customer.
+ */
+documentType?: string
+/**
+ * Document informed by the customer.
+ */
+document?: string
+/**
+ * Phone number.
+ */
+phone?: string
+/**
+ * Company name, if the customer is a legal entity.
+ */
+corporateName?: (null | string)
+/**
+ * Trade name, if the customer is a legal entity.
+ */
+tradeName?: (null | string)
+/**
+ * Corporate document, if the customer is a legal entity.
+ */
+corporateDocument?: (null | string)
+/**
+ * State inscription, if the customer is a legal entity.
+ */
+stateInscription?: (null | string)
+/**
+ * Corporate phone number, if the customer is a legal entity.
+ */
+corporatePhone?: (null | string)
+/**
+ * Indicates whether the customer is a legal entity.
+ */
+isCorporate?: boolean
+/**
+ * Indicates whether profile is complete on loading.
+ */
+profileCompleteOnLoading?: boolean
+/**
+ * Indicates whether profile presents error on loading.
+ */
+profileErrorOnLoading?: (null | boolean)
+/**
+ * Customer class.
+ */
+customerClass?: (null | string)
+})
+/**
+ * Information on the order's payment.
+ */
+paymentData?: {
+/**
+ * Gift card information, if it applies to the order.
+ */
+giftCards?: (null | {
+/**
+ * Gift card redemption code.
+ */
+redemptionCode?: string
+/**
+ * Gift card value in cents.
+ */
+value?: number
+/**
+ * Gift card balance in cents.
+ */
+balance?: number
+/**
+ * Gift card name.
+ */
+name?: string
+/**
+ * Gift card ID.
+ */
+id?: string
+/**
+ * Indicates whether gift card is in use.
+ */
+inUse?: boolean
+/**
+ * Indicates whether gift card is special.
+ */
+isSpecialCard?: boolean
+})[]
+/**
+ * Information on each transaction pertinent to the order.
+ */
+transactions?: (null | {
+/**
+ * Indicates whether transaction is active.
+ */
+isActive?: boolean
+/**
+ * Transaction ID.
+ */
+transactionId?: string
+/**
+ * Merchant name.
+ */
+merchantName?: string
+/**
+ * Information on each payment.
+ */
+payments?: {
+/**
+ * Account ID.
+ */
+accountId?: string
+/**
+ * Bin.
+ */
+bin?: (null | string)
+/**
+ * Number of installments.
+ */
+installments?: number
+/**
+ * Payment system.
+ */
+paymentSystem?: number
+/**
+ * Reference value for calculating interest rates, in case it applies. Displayed in cents.
+ */
+referenceValue?: number
+/**
+ * Value including interest, in case it applies. Displayed in cents.
+ */
+value?: number
+}[]
+/**
+ * Indicates whather transaction is shared.
+ */
+sharedTransaction?: boolean
+})[]
+}
+/**
+ * Object containIng promotion data such as coupon tracking information and internal or external UTMs.
+ */
+marketingData?: (null | {
+/**
+ * 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.
+ */
+coupon?: string
+/**
+ * UTM source.
+ */
+utmSource?: (null | string)
+/**
+ * UTM medium.
+ */
+utmMedium?: (null | string)
+/**
+ * UTM campaign.
+ */
+utmCampaign?: (null | string)
+/**
+ * utmi_page (internal utm).
+ */
+utmiPage?: (null | string)
+/**
+ * utmi_part (internal utm).
+ */
+utmiPart?: (null | string)
+/**
+ * utmi_campaign (internal utm).
+ */
+utmiCampaign?: (null | string)
+})
+/**
+ * Information on each seller.
+ */
+sellers?: (null | {
+/**
+ * Seller ID.
+ */
+id?: string
+/**
+ * Seller name.
+ */
+name?: string
+/**
+ * Seller logo.
+ */
+logo?: (null | string)
+})[]
+/**
+ * Object containing preferences from the client who placed the order.
+ */
+clientPreferencesData?: {
+/**
+ * Client's locale. Examples: `pt-BR` and `en-US`.
+ */
+locale?: string
+/**
+ * `true` if the client opted to receive newsletter from the store.
+ */
+optinNewsLetter?: boolean
+}
+/**
+ * Object containing commercial condition information.
+ */
+commercialConditionData?: (null | {
+
+})
+/**
+ * Object containing data from the store's configuration (stored in VTEX's License Manager).
+ */
+storePreferencesData?: {
+
+}
+/**
+ * Gift registry list information.
+ */
+giftRegistryData?: (null | {
+
+})
+/**
+ * Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON`, even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/docs/guides/customizable-fields-with-checkout-api).
+ */
+openTextField?: (null | string)
+/**
+ * Invoice data including billing address.
+ */
+invoiceData?: {
+/**
+ * Billing address.
+ */
+address?: {
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City name.
+ */
+city?: string
+/**
+ * State name.
+ */
+state?: string
+/**
+ * Country.
+ */
+country?: string
+/**
+ * Street name.
+ */
+street?: string
+/**
+ * Street number.
+ */
+number?: string
+/**
+ * Neighborhood.
+ */
+neighborhood?: string
+/**
+ * Address complement.
+ */
+complement?: string
+/**
+ * Reference for location.
+ */
+reference?: string
+/**
+ * Geographic coordinates (latitude, longitude).
+ */
+geoCoordinates?: number[]
+}
+}
+/**
+ * Customer additional information.
+ */
+customData?: (null | {
+
+})
+/**
+ * Item metadata.
+ */
+itemMetadata?: {
+/**
+ * List of objects containing metadata on each item in the order.
+ */
+items?: (null | {
+/**
+ * Item ID.
+ */
+id?: string
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+})[]
+}
+/**
+ * Hooks information.
+ */
+hooksData?: (null | {
+
+})
+/**
+ * Information on rates and benefits that apply to the order.
+ */
+ratesAndBenefitsData?: {
+/**
+ * List with rates and benefits identifiers.
+ */
+rateAndBenefitsIdentifiers?: string[]
+/**
+ * List with rates and benefits teasers.
+ */
+teaser?: string[]
+}
+/**
+ * Subscription information.
+ */
+subscriptionData?: (null | {
+
+})
+/**
+ * Object containing information about the ordering of items within the orderForm.
+ */
+itemsOrdination?: {
+/**
+ * Criteria adopted to order the items in the list.
+ */
+criteria?: string
+/**
+ * Indicates whether the ordering is ascending.
+ */
+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.
+ * 
+ * ## Permissions
+ * 
+ * This endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).
+ */
+"GET /api/checkout/pub/pickup-points": {
+searchParams: {
+/**
+ * Geocoordinate.
+ */
+geoCoordinates?: string
+/**
+ * Postal code around which to search for pickup points. If you use this type of search, make sure to pass a `countryCode` and do not pass `geoCoordinates`.
+ */
+postalCode?: string
+/**
+ * Three letter country code refering to the `postalCode` field. Pass the country code only if you are searching pickup points by postal code.
+ */
+countryCode?: string
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+response: {
+/**
+ * Paging.
+ */
+paging?: {
+/**
+ * Page number.
+ */
+page?: number
+/**
+ * Page size.
+ */
+pageSize?: number
+/**
+ * Total pages.
+ */
+total?: number
+/**
+ * Pages.
+ */
+pages?: number
+}
+/**
+ * Items.
+ */
+items?: {
+/**
+ * Distance.
+ */
+distance?: number
+/**
+ * Pickup point.
+ */
+pickupPoint?: {
+/**
+ * Friendly name.
+ */
+friendlyName?: string
+/**
+ * Address.
+ */
+address?: {
+/**
+ * Address type.
+ */
+addressType?: string
+/**
+ * Receiver name.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City.
+ */
+city?: string
+/**
+ * State.
+ */
+state?: string
+/**
+ * Country.
+ */
+country?: string
+/**
+ * Street.
+ */
+street?: string
+/**
+ * Number.
+ */
+number?: string
+/**
+ * Neighborhood.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Racao.
+ */
+reference?: string
+/**
+ * Geo coordinates.
+ */
+geoCoordinates?: number[]
+}
+/**
+ * Additional info.
+ */
+additionalInfo?: string
+/**
+ * ID.
+ */
+id?: string
+/**
+ * Array with business hours.
+ */
+businessHours?: {
+/**
+ * Day of week.
+ */
+DayOfWeek?: number
+/**
+ * Opening time.
+ */
+OpeningTime?: string
+/**
+ * Closing time.
+ */
+ClosingTime?: string
+}[]
+}
+}[]
+}
+}
+/**
+ * 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.
+ * 
+ * ## Permissions
+ * 
+ * This endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).
+ */
+"GET /api/checkout/pub/postal-code/:countryCode/:postalCode": {
+searchParams: {
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+/**
+ * Address.
+ */
+response: {
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City.
+ */
+city?: string
+/**
+ * State.
+ */
+state?: string
+/**
+ * Country.
+ */
+country?: string
+/**
+ * Street.
+ */
+street?: string
+/**
+ * Number.
+ */
+number?: string
+/**
+ * Neighborhood.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Reference.
+ */
+reference?: string
+/**
+ * Geo coordinates.
+ */
+geoCoordinates?: number[]
+}
+}
+/**
+ * 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"POST /api/checkout/pub/orderForm/:orderFormId/transaction": {
+searchParams: {
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+body: {
+referenceId: ReferenceId
+savePersonalData?: SavePersonalData
+optinNewsLetter?: OptinNewsLetter
+/**
+ * Total value of the order without separating cents. For example, $24.99 is represented `2499`.
+ */
+value: number
+/**
+ * Reference value of the order for calculating interest if that is the case. Can be equal to the total value and does not separate cents. For example, $24.99 is represented `2499`.
+ */
+referenceValue: number
+/**
+ * Interest rate to be used in case it applies.
+ */
+interestValue: number
+}
+response: {
+/**
+ * ID of the orderForm corresponding to a specific cart.
+ */
+orderFormId?: string
+/**
+ * Attribute created by the seller, in their VTEX store configuration.
+ */
+salesChannel?: string
+/**
+ * Indicates whether the user is logged into the store.
+ */
+loggedIn?: boolean
+/**
+ * Indicates whether order is checked in.
+ */
+isCheckedIn?: boolean
+/**
+ * ID of the store.
+ */
+storeId?: (null | string)
+/**
+ * Permission to modify item price manually.
+ */
+allowManualPrice?: boolean
+/**
+ * Data can be edited.
+ */
+canEditData?: boolean
+/**
+ * Unique ID associated with the customer profile.
+ */
+userProfileId?: string
+/**
+ * Profile provider.
+ */
+profileProvider?: string
+/**
+ * Available accounts.
+ */
+availableAccounts?: string[]
+/**
+ * Information on each available address.
+ */
+availableAddresses?: {
+/**
+ * Address type.
+ */
+addressType?: string
+/**
+ * Name of the receiver.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * City of the address.
+ */
+city?: string
+/**
+ * State of the address.
+ */
+state?: string
+/**
+ * Country of the address. ISO three-letter code.
+ */
+country?: string
+/**
+ * Street of the address.
+ */
+street?: string
+/**
+ * Number of the address.
+ */
+number?: string
+/**
+ * Neighborhood of the address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Reference that may help in the location of the address.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * User type.
+ */
+userType?: (null | string)
+/**
+ * Ignore customer profile data.
+ */
+ignoreProfileData?: boolean
+/**
+ * Total value of the order without separating cents. For example, $24.99 is represented as `2499`.
+ */
+value?: number
+/**
+ * Array containing an object for each message generated by our servers while processing the request.
+ */
+messages?: string[]
+/**
+ * Information on each item in the order.
+ */
+items?: {
+/**
+ * Unique ID.
+ */
+uniqueId?: string
+/**
+ * ID of the item.
+ */
+id?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Product Ref ID.
+ */
+productRefId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Modal type.
+ */
+modalType?: (null | string)
+/**
+ * Parent item index.
+ */
+parentItemIndex?: (null | number)
+/**
+ * Parent assembly binding.
+ */
+parentAssemblyBinding?: (null | string)
+/**
+ * Price expiration date and time.
+ */
+priceValidUntil?: string
+/**
+ * Tax value in cents.
+ */
+tax?: number
+/**
+ * A unique identifier code assigned to a tax within the VTEX Admin.
+ */
+taxCode?: string
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Manual price in cents.
+ */
+manualPrice?: (null | number)
+/**
+ * User that applied the manual price, if that is the case.
+ */
+manualPriceAppliedBy?: (null | string)
+/**
+ * Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
+ */
+sellingPrice?: number
+/**
+ * Reward value in cents.
+ */
+rewardValue?: number
+/**
+ * Indicates whether item is a gift.
+ */
+isGift?: boolean
+/**
+ * Additional information.
+ */
+additionalInfo?: {
+/**
+ * Dimension.
+ */
+dimension?: (null | string)
+/**
+ * Brand name.
+ */
+brandName?: string
+/**
+ * Brand ID.
+ */
+brandId?: string
+/**
+ * Offering information.
+ */
+offeringInfo?: (null | string)
+/**
+ * Offering type.
+ */
+offeringType?: (null | string)
+/**
+ * Offering type ID.
+ */
+offeringTypeId?: (null | string)
+}
+/**
+ * Presale date.
+ */
+preSaleDate?: (null | string)
+/**
+ * Product category IDs.
+ */
+productCategoryIds?: string
+/**
+ * Object, where each field is an ID from `productCategoryIds`.
+ */
+productCategories?: {
+/**
+ * Product category corresponding to the ID in the field key.
+ */
+"{ID}"?: string
+}
+/**
+ * Quantity.
+ */
+quantity?: number
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
+ */
+sellerChain?: string[]
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+/**
+ * Information on services sold along with the SKU. Example: a gift package.
+ */
+bundleItems?: {
+/**
+ * Service type.
+ */
+type?: string
+/**
+ * Service identifier.
+ */
+id?: number
+/**
+ * Service name.
+ */
+name?: string
+/**
+ * Service price in cents.
+ */
+price?: number
+}[]
+/**
+ * Array containing information on attachments.
+ */
+attachments?: string[]
+/**
+ * Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.
+ */
+priceTags?: {
+/**
+ * Promotion unique identifier.
+ */
+identifier?: (null | string)
+/**
+ * Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.
+ */
+isPercentual?: boolean
+/**
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
+ * - `calculationId` is a hash that may vary with each price calculation.
+ */
+name?: string
+/**
+ * Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.
+ */
+rawValue?: number
+/**
+ * Price tag value representing either a promotion (value decrease) or a tax (value increase).
+ */
+value?: number
+}[]
+/**
+ * Availability.
+ */
+availability?: string
+/**
+ * Measurement unit.
+ */
+measurementUnit?: string
+/**
+ * Unit multiplier.
+ */
+unitMultiplier?: number
+/**
+ * Manufacturer code.
+ */
+manufacturerCode?: (null | string)
+/**
+ * Price information for all units of a specific item.
+ */
+priceDefinition?: {
+/**
+ * Item's calculated unitary selling price in cents.
+ */
+calculatedSellingPrice?: number
+/**
+ * Total value for all units of the item in cents.
+ */
+total?: number
+/**
+ * Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
+ */
+sellingPrices?: {
+/**
+ * Value in cents for that specific rounding.
+ */
+value?: number
+/**
+ * Rounding quantity, meaning how many items are rounded to this value.
+ */
+quantity?: number
+}[]
+}
+}[]
+/**
+ * Array containing the data of the item selected as a gift.
+ */
+selectableGifts?: string[]
+/**
+ * Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).
+ */
+totalizers?: {
+
+}[]
+/**
+ * Shipping information pertinent to the order.
+ */
+shippingData?: (null | {
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.
+ */
+logisticsInfo?: {
+/**
+ * Index corresponding to the position of the object in the `items` array.
+ */
+itemIndex?: number
+/**
+ * SLA selected by the customer.
+ */
+selectedSla?: (null | string)
+/**
+ * Delivery channel selected by the customer.
+ */
+selectedDeliveryChannel?: (null | string)
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Information on available SLAs.
+ */
+slas?: {
+/**
+ * SLA ID.
+ */
+id?: string
+/**
+ * Delivery channel.
+ */
+deliveryChannel?: string
+/**
+ * SLA name.
+ */
+name?: string
+/**
+ * Information on each delivery ID.
+ */
+deliveryIds?: {
+/**
+ * Courier ID.
+ */
+courierId?: string
+/**
+ * Warehouse ID.
+ */
+warehouseId?: string
+/**
+ * Warehouse ID.
+ */
+dockId?: string
+/**
+ * Courier name.
+ */
+courierName?: string
+/**
+ * Quantity.
+ */
+quantity?: number
+}[]
+/**
+ * List of attachments details.
+ */
+attachmentOfferings?: (null | {
+/**
+ * Name of the attachment.
+ */
+name: (null | string)
+/**
+ * Defines if the attachment is required (`true`) or not (`false`).
+ */
+required: (null | boolean)
+/**
+ * Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).
+ */
+schema: (null | {
+
+})
+}[])
+/**
+ * Shipping estimate. For instance, "three business days" will be represented as `3bd`.
+ */
+shippingEstimate?: string
+/**
+ * When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.
+ */
+shippingEstimateDate?: (null | string)
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+useIndividualShippingEstimates?: boolean
+/**
+ * Estimate date of delivery.
+ */
+lockTTL?: (null | string)
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Tax in cents.
+ */
+tax?: number
+/**
+ * Information on the pickup store.
+ */
+pickupStoreInfo?: {
+/**
+ * Indicates whether it is the pickup store.
+ */
+isPickupStore?: boolean
+/**
+ * Friendly name.
+ */
+friendlyName?: (null | string)
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that repesent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Additional information.
+ */
+additionalInfo?: (null | string)
+/**
+ * Corresponding dock ID.
+ */
+dockId?: (null | string)
+}
+/**
+ * Pickup point ID.
+ */
+pickupPointId?: (null | string)
+/**
+ * Pickup point distance.
+ */
+pickupDistance?: number
+/**
+ * Polygon name.
+ */
+polygonName?: (null | string)
+/**
+ * Transit time. For instance, "three business days" is represented as `3bd`.
+ */
+transitTime?: string
+}[]
+/**
+ * List of countries that the item may be shipped to.
+ */
+shipsTo?: string[]
+/**
+ * Item ID.
+ */
+itemId?: string
+/**
+ * List of available delivery channels.
+ */
+deliveryChannels?: {
+/**
+ * Delivery channel ID.
+ */
+id?: string
+}[]
+}[]
+/**
+ * Array with information on the selected addresses for the order.
+ */
+selectedAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * Array with information on the available addresses for the order.
+ */
+availableAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array with two strings that represent geocoordinates: first latitude, then longitude.
+ */
+geoCoordinates?: number[]
+}[]
+})
+/**
+ * Customer's profile information.
+ */
+clientProfileData?: (null | {
+/**
+ * Email address.
+ */
+email?: (null | string)
+/**
+ * First name.
+ */
+firstName?: (null | string)
+/**
+ * Last name.
+ */
+lastName?: string
+/**
+ * Type of the document informed by the customer.
+ */
+documentType?: string
+/**
+ * Document informed by the customer.
+ */
+document?: string
+/**
+ * Phone number.
+ */
+phone?: string
+/**
+ * Company name, if the customer is a legal entity.
+ */
+corporateName?: (null | string)
+/**
+ * Trade name, if the customer is a legal entity.
+ */
+tradeName?: (null | string)
+/**
+ * Corporate document, if the customer is a legal entity.
+ */
+corporateDocument?: (null | string)
+/**
+ * State inscription, if the customer is a legal entity.
+ */
+stateInscription?: (null | string)
+/**
+ * Corporate phone number, if the customer is a legal entity.
+ */
+corporatePhone?: (null | string)
+/**
+ * Indicates whether the customer is a legal entity.
+ */
+isCorporate?: boolean
+/**
+ * Indicates whether profile is complete on loading.
+ */
+profileCompleteOnLoading?: boolean
+/**
+ * Indicates whether profile presents error on loading.
+ */
+profileErrorOnLoading?: (null | boolean)
+/**
+ * Customer class.
+ */
+customerClass?: (null | string)
+})
+/**
+ * Information on the order's payment.
+ */
+paymentData?: {
+/**
+ * Gift card information, if it applies to the order.
+ */
+giftCards?: {
+/**
+ * Gift card redemption code.
+ */
+redemptionCode?: string
+/**
+ * Gift card value in cents.
+ */
+value?: number
+/**
+ * Gift card balance in cents.
+ */
+balance?: number
+/**
+ * Gift card name.
+ */
+name?: string
+/**
+ * Gift card ID.
+ */
+id?: string
+/**
+ * Indicates whether gift card is in use.
+ */
+inUse?: boolean
+/**
+ * Indicates whether gift card is special.
+ */
+isSpecialCard?: boolean
+}[]
+/**
+ * Information on each transaction pertinent to the order.
+ */
+transactions?: (null | {
+/**
+ * Indicates whether transaction is active.
+ */
+isActive?: boolean
+/**
+ * Transaction ID.
+ */
+transactionId?: string
+/**
+ * Merchant name.
+ */
+merchantName?: string
+/**
+ * Information on each payment.
+ */
+payments?: {
+/**
+ * Account ID.
+ */
+accountId?: string
+/**
+ * Bin.
+ */
+bin?: (null | string)
+/**
+ * Number of installments.
+ */
+installments?: number
+/**
+ * Payment system.
+ */
+paymentSystem?: string
+/**
+ * Reference value for calculating interest rates, in case it applies. Displayed in cents.
+ */
+referenceValue?: number
+/**
+ * Value including interest, in case it applies. Displayed in cents.
+ */
+value?: number
+}[]
+/**
+ * Indicates whather transaction is shared.
+ */
+sharedTransaction?: boolean
+})[]
+}
+/**
+ * Object containing promotion data such as coupon tracking information and internal or external UTMs.
+ */
+marketingData?: (null | {
+/**
+ * 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.
+ */
+coupon?: string
+/**
+ * UTM source.
+ */
+utmSource?: string
+/**
+ * UTM medium.
+ */
+utmMedium?: string
+/**
+ * UTM campaign.
+ */
+utmCampaign?: string
+/**
+ * utmi_page (internal utm).
+ */
+utmiPage?: (null | string)
+/**
+ * utmi_part (internal utm).
+ */
+utmiPart?: (null | string)
+/**
+ * utmi_campaign (internal utm).
+ */
+utmiCampaign?: (null | string)
+})
+/**
+ * Information on each seller.
+ */
+sellers?: {
+/**
+ * Seller ID.
+ */
+id?: string
+/**
+ * Seller name.
+ */
+name?: string
+/**
+ * Seller logo.
+ */
+logo?: (null | string)
+}[]
+/**
+ * Object containing preferences from the client who placed the order.
+ */
+clientPreferencesData?: {
+/**
+ * Client's locale. Examples: `pt-BR` and `en-US`.
+ */
+locale?: string
+/**
+ * `true` if the client opted to receive newsletter from the store.
+ */
+optinNewsLetter?: (null | boolean)
+}
+/**
+ * Object containing commercial condition information.
+ */
+commercialConditionData?: (null | {
+
+})
+/**
+ * Object containing data from the store's configuration (stored in VTEX's License Manager).
+ */
+storePreferencesData?: {
+
+}
+/**
+ * Gift registry list information.
+ */
+giftRegistryData?: (null | {
+
+})
+/**
+ * Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).
+ */
+openTextField?: (null | string)
+/**
+ * Invoice data including billing address.
+ */
+invoiceData?: (null | {
+/**
+ * Billing address.
+ */
+address?: {
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City name.
+ */
+city?: string
+/**
+ * State name.
+ */
+state?: string
+/**
+ * Country.
+ */
+country?: string
+/**
+ * Street name.
+ */
+street?: string
+/**
+ * Street number.
+ */
+number?: string
+/**
+ * Neighborhood.
+ */
+neighborhood?: string
+/**
+ * Address complement.
+ */
+complement?: string
+/**
+ * Reference for location.
+ */
+reference?: string
+/**
+ * Geographic coordinates (latitude, longitude).
+ */
+geoCoordinates?: number[]
+}
+})
+/**
+ * Customer additional information.
+ */
+customData?: (null | {
+
+})
+/**
+ * Item metadata.
+ */
+itemMetadata?: {
+/**
+ * List of objects containing metadata on each item in the order.
+ */
+items?: {
+/**
+ * Item ID.
+ */
+id?: string
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+}[]
+}
+/**
+ * Hooks information.
+ */
+hooksData?: (null | {
+
+})
+/**
+ * Information on rates and benefits that apply to the order.
+ */
+ratesAndBenefitsData?: {
+/**
+ * List with rates and benefits identifiers.
+ */
+rateAndBenefitsIdentifiers?: string[]
+/**
+ * List with rates and benefits teasers.
+ */
+teaser?: string[]
+}
+/**
+ * Subscription information.
+ */
+subscriptionData?: (null | {
+
+})
+/**
+ * Object containing information about the ordering of items within the `orderForm`.
+ */
+itemsOrdination?: {
+/**
+ * Criteria adopted to order the items in the list.
+ */
+criteria?: string
+/**
+ * Indicates whether the ordering is ascending.
+ */
+ascending?: boolean
+}
+}
+}
+/**
+ * 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).
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Orders Full Access** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"PUT /api/checkout/pub/orders": {
+searchParams: {
+/**
+ * Trade Policy (Sales Channel) identification. This query can be used to create an order for a specific sales channel.
+ */
+sc?: number
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+body: {
+/**
+ * Array of objects containing information on each of the order's items.
+ */
+items: {
+/**
+ * The SKU ID.
+ */
+id: string
+/**
+ * The quantity of items of this specific SKU in the cart to be simulated.
+ */
+quantity: number
+/**
+ * The ID of the seller responsible for this SKU. This ID can be found in your VTEX Admin.
+ */
+seller: string
+/**
+ * Comission.
+ */
+commission?: number
+/**
+ * Freight comission.
+ */
+freightCommission?: number
+/**
+ * Item price within the context of the order without separating cents. For example, $24.99 is represented `2499`.
+ */
+price?: number
+/**
+ * Information on services sold along with the SKU. Example: a gift package.
+ */
+bundleItems?: {
+/**
+ * Service type.
+ */
+type?: string
+/**
+ * Service identifier.
+ */
+id?: string
+/**
+ * Service name.
+ */
+name?: string
+/**
+ * Service price. The last two digits are the cents.
+ */
+price?: number
+}[]
+/**
+ * Item attachment.
+ */
+itemAttachment?: {
+/**
+ * Attachment name.
+ */
+name?: string
+/**
+ * Content referring to the customization requested by the customer.
+ */
+content?: string
+}
+/**
+ * Array containing information on attachments.
+ */
+attachments?: string[]
+/**
+ * Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.
+ */
+priceTags?: {
+/**
+ * Promotion unique identifier.
+ */
+identifier?: (null | string)
+/**
+ * Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.
+ */
+isPercentual?: boolean
+/**
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
+ * - `calculationId` is a hash that may vary with each price calculation.
+ */
+name?: string
+/**
+ * Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.
+ */
+rawValue?: number
+/**
+ * Price tag value representing either a promotion (value decrease) or a tax (value increase).
+ */
+value?: number
+}[]
+/**
+ * SKU measurement unit.
+ */
+measurementUnit?: string
+/**
+ * SKU unit multiplier.
+ */
+unitMultiplier?: number
+/**
+ * Indicates whether the order is a gift.
+ */
+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.
+ */
+clientProfileData: (null | {
+/**
+ * Customer's email address.
+ */
+email: (null | string)
+/**
+ * Customer's first name.
+ */
+firstName?: (null | string)
+/**
+ * Customer's last name.
+ */
+lastName?: string
+/**
+ * Type of the document informed by the customer.
+ */
+documentType?: string
+/**
+ * Document number informed by the customer.
+ */
+document?: string
+/**
+ * Customer's phone number.
+ */
+phone?: string
+/**
+ * Company name, if the customer is a legal entity.
+ */
+corporateName?: string
+/**
+ * Trade name, if the customer is a legal entity.
+ */
+tradeName?: string
+/**
+ * Corporate document, if the customer is a legal entity.
+ */
+corporateDocument?: string
+/**
+ * State inscription, if the customer is a legal entity.
+ */
+stateInscription?: string
+/**
+ * Corporate phone number, if the customer is a legal entity.
+ */
+corporatePhone?: string
+/**
+ * `true` if the customer is a legal entity.
+ */
+isCorporate?: boolean
+})
+/**
+ * Shipping information.
+ */
+shippingData: (null | {
+/**
+ * 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.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`, among others.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Postal Code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: string
+/**
+ * Array containing two floats with geocoordinates, first longitude, then latitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Array of objects containing logistics information of each item.
+ */
+logisticsInfo?: {
+/**
+ * Index of the item in the `items` array, starting from 0.
+ */
+itemIndex: number
+/**
+ * Selected shipping option.
+ */
+selectedSla: (null | string)
+/**
+ * String with the selected delivery channel. This field supports the following values:  
+ * 
+ * - `delivery`,  
+ * 
+ * - `pickup-in-point`.
+ */
+selectedDeliveryChannel?: (null | string)
+/**
+ * Logistics reservation waiting time.
+ */
+lockTTL?: (null | string)
+/**
+ * Estimated time until delivery for the item.
+ */
+shippingEstimate?: string
+/**
+ * Shipping price for the item. Does not account for the whole order's shipping price.
+ */
+price: number
+/**
+ * In case of scheduled delivery, this object will contain information on the delivery window selected by the shopper.
+ */
+deliveryWindow?: {
+/**
+ * Delivery window starting day and time in UTC.
+ */
+startDateUtc?: string
+/**
+ * Delivery window ending day and time in UTC.
+ */
+endDateUtc?: string
+/**
+ * Delivery window price.
+ */
+price?: number
+/**
+ * Delivery window list price.
+ */
+lisPrice?: number
+/**
+ * Delivery window tax.
+ */
+tax?: number
+}
+}[]
+/**
+ * Indicate whether this object's information is up to date according to the order's items. An order can not be placed if `"outdated"`.
+ */
+updateStatus?: string
+})
+/**
+ * Payment infomation.
+ */
+paymentData: {
+/**
+ * Gift card information, if it applies to the order.
+ */
+giftCards?: {
+/**
+ * Gift card redemption code.
+ */
+redemptionCode: string
+/**
+ * Gift card value.
+ */
+value: number
+/**
+ * Gift card balance.
+ */
+balance?: number
+/**
+ * Gift card name.
+ */
+name?: string
+/**
+ * Gift card ID.
+ */
+id?: string
+/**
+ * Indicates whether gift card is in use.
+ */
+inUse?: boolean
+/**
+ * Indicates whether gift card is special.
+ */
+isSpecialCard?: boolean
+}[]
+/**
+ * Array of gift card messages.
+ */
+giftCardMessages?: string[]
+/**
+ * Information on payment systems.
+ */
+paymentSystems?: {
+/**
+ * Payment system ID.
+ */
+id?: number
+/**
+ * Payment system name.
+ */
+name?: string
+/**
+ * Payment group name.
+ */
+groupName?: string
+/**
+ * Payment system validator.
+ */
+validator?: {
+/**
+ * Payment system validator.
+ */
+regex?: string
+/**
+ * Validator mask.
+ */
+mask?: string
+/**
+ * Card code regular expression.
+ */
+cardCodeRegex?: string
+/**
+ * Card code mask.
+ */
+cardCodeMask?: string
+/**
+ * Weights.
+ */
+weights?: number[]
+}
+/**
+ * String ID.
+ */
+stringId?: string
+/**
+ * Template.
+ */
+template?: string
+/**
+ * Indicates whether a document is required.
+ */
+requiresDocument?: boolean
+/**
+ * Indicates whether this payment system has been selected.
+ */
+selected?: boolean
+/**
+ * Indicates whether it is custom.
+ */
+isCustom?: boolean
+/**
+ * Description.
+ */
+description?: string
+}[]
+/**
+ * Payment information.
+ */
+payments: {
+/**
+ * Account ID.
+ */
+accountId?: string
+/**
+ * Payment bin.
+ */
+bin?: (null | string)
+/**
+ * Number of installments.
+ */
+installments: number
+/**
+ * Payment system.
+ */
+paymentSystem: number
+/**
+ * Reference value for calculating interest rates, in case it applies.
+ */
+referenceValue: number
+/**
+ * Value including interest, in case it applies.
+ */
+value: number
+}[]
+/**
+ * Indicates whether this object's information is up to date according to the order's items. An order can not be placed if `"outdated"`.
+ */
+updateStatus?: string
+}
+/**
+ * Coupon information.
+ */
+marketingData?: (null | {
+/**
+ * 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.
+ */
+coupon?: string
+/**
+ * UTM source.
+ */
+utmSource?: string
+/**
+ * UTM medium.
+ */
+utmMedium?: string
+/**
+ * UTM campaign.
+ */
+utmCampaign?: string
+/**
+ * utmi_page (internal utm).
+ */
+utmiPage?: string
+/**
+ * utmi_part (internal utm).
+ */
+utmiPart?: string
+/**
+ * utmi_campaign (internal utm).
+ */
+utmiCampaign?: string
+})
+/**
+ * Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/docs/guides/customizable-fields-with-checkout-api).
+ */
+openTextField?: string
+/**
+ * Sales Associate information.
+ */
+salesAssociateData?: {
+/**
+ * Sales Associate (Seller) identification code. All information should be registered by the merchant. Maximum of 100 characters.
+ */
+salesAssociateId?: string
+}
+minItems?: 0
+}
+response: {
+/**
+ * This is `null` since this request does not depend on any previously existing orderForm information in the platform.
+ */
+orderForm?: (null | string)
+/**
+ * Information on each transaction pertinent to the order placed.
+ */
+transactionData?: {
+/**
+ * Information on each merchant transaction.
+ */
+merchantTransactions?: {
+/**
+ * ID of the seller.
+ */
+id?: string
+/**
+ * ID of the transaction in the platform.
+ */
+transactionId?: string
+/**
+ * Name of the merchant responsible for the sale.
+ */
+merchantName?: string
+/**
+ * Information on each payment pertinent to the transaction.
+ */
+payments?: {
+/**
+ * Payment system.
+ */
+paymentSystem?: number
+/**
+ * Payment bin.
+ */
+bin?: (null | string)
+/**
+ * Account ID.
+ */
+accountId?: (null | string)
+/**
+ * Token ID.
+ */
+tokenId?: (null | string)
+/**
+ * Total value to be paid in this payment.
+ */
+value?: number
+/**
+ * Reference value over which interests may be applied.
+ */
+referenceValue?: number
+/**
+ * Gift card redemption code.
+ */
+giftCardRedemptionCode?: (null | string)
+/**
+ * Gift card provider.
+ */
+giftCardProvider?: (null | string)
+/**
+ * Gift card ID.
+ */
+giftCardId?: (null | string)
+}[]
+}[]
+/**
+ * Receiver URI.
+ */
+receiverUri?: string
+/**
+ * Template of the gateway callback path, which may later be used to send information about the transaction.
+ */
+gatewayCallbackTemplatePath?: string
+}
+/**
+ * Information on each of the orders created.
+ */
+orders?: {
+/**
+ * ID of the order in the Order Management System (OMS).
+ */
+orderId?: string
+/**
+ * Order group. Orders that involve different sellers are split into different orders of a same order group.
+ */
+orderGroup?: string
+/**
+ * State.
+ */
+state?: (null | string)
+/**
+ * Indicates whether order is checked in.
+ */
+isCheckedIn?: boolean
+/**
+ * ID of the order in the seller.
+ */
+sellerOrderId?: (null | string)
+/**
+ * Store ID.
+ */
+storeId?: (null | string)
+/**
+ * Checked in pickup point.
+ */
+checkedInPickupPointId?: (null | string)
+/**
+ * Value of the order.
+ */
+value?: number
+/**
+ * Information on each item in the order.
+ */
+items?: {
+/**
+ * Unique ID.
+ */
+uniqueId?: string
+/**
+ * ID of the item.
+ */
+id?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Product Ref ID.
+ */
+productRefId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Modal type.
+ */
+modalType?: (null | string)
+/**
+ * Parent item index.
+ */
+parentItemIndex?: (null | number)
+/**
+ * Parent assembly binding.
+ */
+parentAssemblyBinding?: (null | string)
+/**
+ * Price expiration date and time.
+ */
+priceValidUntil?: string
+/**
+ * Tax value in cents.
+ */
+tax?: number
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Manual price in cents.
+ */
+manualPrice?: (null | number)
+/**
+ * User that applied the manual price, if that is the case.
+ */
+manualPriceAppliedBy?: (null | string)
+/**
+ * Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
+ */
+sellingPrice?: number
+/**
+ * Reward value in cents.
+ */
+rewardValue?: number
+/**
+ * Indicates whether item is a gift.
+ */
+isGift?: boolean
+/**
+ * Additional information.
+ */
+additionalInfo?: {
+/**
+ * Dimension.
+ */
+dimension?: (null | string)
+/**
+ * Brand name.
+ */
+brandName?: string
+/**
+ * Brand ID.
+ */
+brandId?: string
+/**
+ * Offering information.
+ */
+offeringInfo?: (null | string)
+/**
+ * Offering type.
+ */
+offeringType?: (null | string)
+/**
+ * Offering type ID.
+ */
+offeringTypeId?: (null | string)
+}
+/**
+ * Presale date.
+ */
+preSaleDate?: (null | string)
+/**
+ * Product category IDs.
+ */
+productCategoryIds?: string
+/**
+ * Object, where each field is an ID from `productCategoryIds`.
+ */
+productCategories?: {
+/**
+ * Product category corresponding to the ID in the field key.
+ */
+"{ID}"?: string
+}
+/**
+ * Quantity.
+ */
+quantity?: number
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/pt/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
+ */
+sellerChain?: string[]
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+/**
+ * Information on services sold along with the SKU. Example: a gift package.
+ */
+bundleItems?: {
+/**
+ * Service type.
+ */
+type?: string
+/**
+ * Service identifier.
+ */
+id?: number
+/**
+ * Service name.
+ */
+name?: string
+/**
+ * Service price in cents.
+ */
+price?: number
+}[]
+/**
+ * Array containing information on attachments.
+ */
+attachments?: string[]
+/**
+ * Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.
+ */
+priceTags?: {
+/**
+ * Promotion unique identifier.
+ */
+identifier?: (null | string)
+/**
+ * Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.
+ */
+isPercentual?: boolean
+/**
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
+ * - `calculationId` is a hash that may vary with each price calculation.
+ */
+name?: string
+/**
+ * Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.
+ */
+rawValue?: number
+/**
+ * Price tag value representing either a promotion (value decrease) or a tax (value increase).
+ */
+value?: number
+}[]
+/**
+ * Availability.
+ */
+availability?: string
+/**
+ * Measurement unit.
+ */
+measurementUnit?: string
+/**
+ * Unit multiplier.
+ */
+unitMultiplier?: number
+/**
+ * Manufacturer code.
+ */
+manufacturerCode?: (null | string)
+/**
+ * Price information for all units of a specific item.
+ */
+priceDefinition?: {
+/**
+ * Item's calculated unitary selling price in cents.
+ */
+calculatedSellingPrice?: number
+/**
+ * Total value for all units of the item in cents.
+ */
+total?: number
+/**
+ * Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
+ */
+sellingPrices?: {
+/**
+ * Value in cents for that specific rounding.
+ */
+value?: number
+/**
+ * Rounding quantity, meaning how many items are rounded to this value.
+ */
+quantity?: number
+}[]
+}
+}[]
+/**
+ * Information on each seller.
+ */
+sellers?: {
+/**
+ * Seller ID.
+ */
+id?: string
+/**
+ * Seller name.
+ */
+name?: string
+/**
+ * Seller logo.
+ */
+logo?: (null | string)
+}[]
+/**
+ * Information on order totals.
+ */
+totals?: {
+/**
+ * Total ID.
+ */
+id?: string
+/**
+ * Total name.
+ */
+name?: string
+/**
+ * Total value.
+ */
+value?: number
+}[]
+/**
+ * Customer's profile information.
+ */
+clientProfileData?: (null | {
+/**
+ * Email address.
+ */
+email?: (null | string)
+/**
+ * First name.
+ */
+firstName?: (null | string)
+/**
+ * Last name.
+ */
+lastName?: string
+/**
+ * Type of the document informed by the customer.
+ */
+documentType?: string
+/**
+ * Document informed by the customer.
+ */
+document?: string
+/**
+ * Phone number.
+ */
+phone?: string
+/**
+ * Company name, if the customer is a legal entity.
+ */
+corporateName?: (null | string)
+/**
+ * Trade name, if the customer is a legal entity.
+ */
+tradeName?: (null | string)
+/**
+ * Corporate document, if the customer is a legal entity.
+ */
+corporateDocument?: (null | string)
+/**
+ * State inscription, if the customer is a legal entity.
+ */
+stateInscription?: (null | string)
+/**
+ * Corporate phone number, if the customer is a legal entity.
+ */
+corporatePhone?: (null | string)
+/**
+ * Indicates whether the customer is a legal entity.
+ */
+isCorporate?: boolean
+/**
+ * Indicates whether profile is complete on loading.
+ */
+profileCompleteOnLoading?: boolean
+/**
+ * Indicates whether profile presents error on loading.
+ */
+profileErrorOnLoading?: (null | boolean)
+/**
+ * Customer class.
+ */
+customerClass?: (null | string)
+})
+/**
+ * Information on rates and benefits that apply to the order.
+ */
+ratesAndBenefitsData?: {
+/**
+ * List with rates and benefits identifiers.
+ */
+rateAndBenefitsIdentifiers?: string[]
+/**
+ * List with rates and benefits teasers.
+ */
+teaser?: string[]
+}
+/**
+ * Shipping information pertinent to the order.
+ */
+shippingData?: {
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array containing two floats with geocoordinates, first longitude, then latitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.
+ */
+logisticsInfo?: {
+/**
+ * Index corresponding to the position of the object in the `items` array.
+ */
+itemIndex?: number
+/**
+ * SLA selected by the customer.
+ */
+selectedSla?: (null | string)
+/**
+ * Delivery channel selected by the customer. For example, `"delivery"` or `"pickup-in-point"`.
+ */
+selectedDeliveryChannel?: (null | string)
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Information on available SLAs.
+ */
+slas?: {
+/**
+ * SLA ID.
+ */
+id?: string
+/**
+ * Delivery channel.
+ */
+deliveryChannel?: string
+/**
+ * SLA name.
+ */
+name?: string
+/**
+ * Information on each delivery ID.
+ */
+deliveryIds?: {
+/**
+ * Courier ID.
+ */
+courierId?: string
+/**
+ * Warehouse ID.
+ */
+warehouseId?: string
+/**
+ * Warehouse ID.
+ */
+dockId?: string
+/**
+ * Courier name.
+ */
+courierName?: string
+/**
+ * Quantity.
+ */
+quantity?: number
+}[]
+/**
+ * Shipping estimate. For instance, Three business days will be represented `3bd`.
+ */
+shippingEstimate?: string
+/**
+ * When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.
+ */
+shippingEstimateDate?: (null | string)
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+useIndividualShippingEstimates?: boolean
+/**
+ * Estimate date of delivery.
+ */
+lockTTL?: (null | string)
+/**
+ * Price in cents.
+ */
+price?: number
+/**
+ * List price in cents.
+ */
+listPrice?: number
+/**
+ * Tax in cents.
+ */
+tax?: number
+/**
+ * Information on the pickup store.
+ */
+pickupStoreInfo?: {
+/**
+ * Indicates whether it is the pickup store.
+ */
+isPickupStore?: boolean
+/**
+ * Friendly name.
+ */
+friendlyName?: (null | string)
+/**
+ * Address information.
+ */
+address?: (null | {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array containing two floats with geocoordinates, first longitude, then latitude.
+ */
+geoCoordinates?: number[]
+})
+/**
+ * Additional information.
+ */
+additionalInfo?: (null | string)
+/**
+ * Corresponding dock ID.
+ */
+dockId?: (null | string)
+}
+/**
+ * Pickup point ID.
+ */
+pickupPointId?: (null | string)
+/**
+ * Pickup point distance.
+ */
+pickupDistance?: number
+/**
+ * Polygon name.
+ */
+polygonName?: (null | string)
+/**
+ * Transit time. For instance, "three business days" is represented `3bd`.
+ */
+transitTime?: string
+}[]
+/**
+ * List of countries that the item may be shipped to.
+ */
+shipsTo?: string[]
+/**
+ * Item ID.
+ */
+itemId?: string
+/**
+ * List of available delivery channels.
+ */
+deliveryChannels?: {
+/**
+ * Delivery channel ID.
+ */
+id?: string
+}[]
+}[]
+/**
+ * Array with information on the selected addresses for the order.
+ */
+selectedAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array containing two floats with geocoordinates, first longitude, then latitude.
+ */
+geoCoordinates?: number[]
+}[]
+/**
+ * Array with information on the available addresses for the order.
+ */
+availableAddresses?: {
+/**
+ * Type of address. For example, `Residential` or `Pickup`.
+ */
+addressType?: string
+/**
+ * Name of the person who is going to receive the order.
+ */
+receiverName?: string
+/**
+ * Address ID.
+ */
+addressId?: (null | string)
+/**
+ * Indicates whether address is disposable.
+ */
+isDisposable?: boolean
+/**
+ * Postal code.
+ */
+postalCode?: string
+/**
+ * City of the shipping address.
+ */
+city?: string
+/**
+ * State of the shipping address.
+ */
+state?: string
+/**
+ * Three letter ISO code of the country of the shipping address.
+ */
+country?: string
+/**
+ * Street of the shipping address.
+ */
+street?: string
+/**
+ * Number of the building, house or apartment in the shipping address.
+ */
+number?: string
+/**
+ * Neighborhood of the shipping address.
+ */
+neighborhood?: string
+/**
+ * Complement to the shipping address, in case it applies.
+ */
+complement?: (null | string)
+/**
+ * Complement that might help locate the shipping address more precisely in case of delivery.
+ */
+reference?: (null | string)
+/**
+ * Array containing two floats with geocoordinates, first longitude, then latitude.
+ */
+geoCoordinates?: number[]
+}[]
+}
+/**
+ * Information on the order's payment.
+ */
+paymentData?: {
+/**
+ * Gift card information, if it applies to the order.
+ */
+giftCards?: {
+/**
+ * Gift card redemption code.
+ */
+redemptionCode?: string
+/**
+ * Gift card value in cents.
+ */
+value?: number
+/**
+ * Gift card balance in cents.
+ */
+balance?: number
+/**
+ * Gift card name.
+ */
+name?: string
+/**
+ * Gift card ID.
+ */
+id?: string
+/**
+ * Indicates whether gift card is in use.
+ */
+inUse?: boolean
+/**
+ * Indicates whether gift card is special.
+ */
+isSpecialCard?: boolean
+}[]
+/**
+ * Information on each transaction pertinent to the order.
+ */
+transactions?: {
+/**
+ * Indicates whether transaction is active.
+ */
+isActive?: boolean
+/**
+ * Transaction ID.
+ */
+transactionId?: string
+/**
+ * Merchant name.
+ */
+merchantName?: string
+/**
+ * Information on each payment.
+ */
+payments?: {
+/**
+ * Account ID.
+ */
+accountId?: string
+/**
+ * Bin.
+ */
+bin?: (null | string)
+/**
+ * Number of installments.
+ */
+installments?: number
+/**
+ * Payment system.
+ */
+paymentSystem?: number
+/**
+ * Reference value for calculating interest rates, in case it applies. Displayed in cents.
+ */
+referenceValue?: number
+/**
+ * Value including interest, in case it applies. Displayed in cents.
+ */
+value?: number
+}[]
+/**
+ * Indicates whather transaction is shared.
+ */
+sharedTransaction?: boolean
+}[]
+}
+/**
+ * Item metadata.
+ */
+itemMetadata?: {
+/**
+ * List of objects containing metadata on each item in the order.
+ */
+items?: {
+/**
+ * Item ID.
+ */
+id?: string
+/**
+ * Seller.
+ */
+seller?: string
+/**
+ * Product name.
+ */
+name?: string
+/**
+ * SKU name.
+ */
+skuName?: string
+/**
+ * Product ID.
+ */
+productId?: string
+/**
+ * Ref ID.
+ */
+refId?: string
+/**
+ * European Article Number.
+ */
+ean?: (null | string)
+/**
+ * Image URL.
+ */
+imageUrl?: string
+/**
+ * Detail URL.
+ */
+detailUrl?: string
+}[]
+}
+/**
+ * Sales channel.
+ */
+salesChannel?: string
+/**
+ * Follow up email address.
+ */
+followUpEmail?: string
+/**
+ * Creation date.
+ */
+creationDate?: string
+/**
+ * Last change.
+ */
+lastChange?: string
+/**
+ * Time zone creation date.
+ */
+timeZoneCreationDate?: string
+/**
+ * Time zone last change.
+ */
+timeZoneLastChange?: string
+/**
+ * Indicates whether order is completed.
+ */
+isCompleted?: boolean
+/**
+ * Host name.
+ */
+hostName?: string
+/**
+ * Merchant name.
+ */
+merchantName?: (null | string)
+/**
+ * User type.
+ */
+userType?: string
+/**
+ * Rounding error.
+ */
+roundingError?: number
+/**
+ * Indicates whether edition is allowed.
+ */
+allowEdition?: boolean
+/**
+ * Indicates whether cancelation is allowed.
+ */
+allowCancelation?: boolean
+/**
+ * Indicates whether seller changing is allowed.
+ */
+allowChangeSeller?: boolean
+/**
+ * Indicates whether user data is visible.
+ */
+isUserDataVisible?: boolean
+/**
+ * `orderForm` creation date.
+ */
+orderFormCreationDate?: string
+/**
+ * Sales Associate (Seller) identification code.
+ */
+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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Save Order Configuration** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"POST /api/checkout/pub/gatewayCallback/:orderGroup": {
+searchParams: {
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+}
+/**
+ * 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Shopping Cart Full Access** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
+ * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
+ */
+"GET /api/checkout/pub/regions/:regionId": {
+searchParams: {
+/**
+ * Three letter country code refering to the `postalCode` field.
+ */
+country: string
+/**
+ * Postal code corresponding to the shopper's location.
+ */
+postalCode?: string
+/**
+ * Geocoordinates (first longitude, semicolon, then latitude) corresponding to the shopper's location.
+ */
+geoCoordinates?: number[]
+/**
+ * Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
+ */
+individualShippingEstimates?: boolean
+}
+response: {
+/**
+ * Region ID.
+ */
+id?: string
+/**
+ * Array with information on each seller retrieved for the given region.
+ */
+sellers?: {
+/**
+ * Seller ID.
+ */
+id?: string
+/**
+ * Seller name.
+ */
+name?: string
+/**
+ * Seller logo.
+ */
+logo?: (null | string)
+}[]
+}
+}
+}
+/**
+ * Payment Configuration object.
+ */
+export interface PaymentConfiguration {
+/**
+ * Determines whether pre-authorized payments require authentication.
+ */
+requiresAuthenticationForPreAuthorizedPaymentOption: boolean
+/**
+ * By default (when `false`), on a multi-seller purchase is on the run, a simple intersection with installments options configured by every seller will be available. When `true`, this option allows a more complex but flexible installment option, since it considers max installments of every seller configuration, even if those don't match. Installment values ​​may not be equal in this case.
+ */
+allowInstallmentsMerge?: boolean
+/**
+ * Indicates whether shoppers can add credit cards in your store's `My Account` section.
+ */
+blockPaymentSession?: boolean
+}
diff --git a/vtex/utils/openapi/checkout.openapi.json b/vtex/utils/openapi/checkout.openapi.json
new file mode 100644
index 000000000..b5ff71400
--- /dev/null
+++ b/vtex/utils/openapi/checkout.openapi.json
@@ -0,0 +1,43725 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "Checkout API",
+    "description": ">ℹ️ Check the new [Checkout onboarding guide](https://developers.vtex.com/vtex-rest-api/docs/checkout-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about the Checkout and is organized by focusing on the developer's journey.\r\n\r\nThe Checkout API allows you to obtain and configure information about the shopping cart and its attachments, personalization of custom fields, orderForm structure, fulfillment data, order management, and identification of the sellers delivery region.\r\n\r\n>ℹ️ Data modification operations (`POST`, `PATCH`, `PUT` or `DELETE` endpoints) shall not be performed in parallel in the Checkout APIs. They need to be enqueued by the client/requester. Otherwise, old values ​​can be overwritten incorrectly or competition errors may occur.\r\n\r\n>⚠️ All endpoints that consult or edit the orderForm can change the authentication depending on the customer context. If you are handling information from a customer with a complete profile on the store, authentication will be required. You can only access or modify the customer data for these profiles with an authenticated request.\r\n\r\n## Shopping cart\r\n\r\nAllows merchants to simulate, configure and customize shopping cart information.\r\n\r\n- [POST - Cart Simulation](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pub/orderForms/simulation): simulate a cart in VTEX Checkout.\r\n- [GET - Get current or create a new cart](https://developers.vtex.com/docs/api-reference/checkout-api#get-/api/checkout/pub/orderForm): get your current shopping cart information or to create a new cart.\r\n- [GET - Get cart information by ID](https://developers.vtex.com/docs/api-reference/checkout-api#get-/api/checkout/pub/orderForm/-orderFormId-): get all information associated to a given shopping cart.\r\n- [POST - Add cart items](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pub/orderForm/-orderFormId-/items): add a new item to the shopping cart.\r\n- [POST - Update cart items](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pub/orderForm/-orderFormId-/items/update): change the quantity of one or more items in a specific cart or remove an item from the cart.\r\n- [PATCH - Handle cart items](https://developers.vtex.com/docs/api-reference/checkout-api#patch-/api/checkout/pub/orderForm/-orderFormId-/items): change the quantity or price of one or more items to the shopping cart or add a new item to the shopping cart.\r\n- [POST - Remove all items](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pub/orderForm/-orderFormId-/items/removeAll): removes all items from a given cart, leaving it empty.\r\n- [PUT - Change price](https://developers.vtex.com/docs/api-reference/checkout-api#put-/api/checkout/pub/orderForm/-orderFormId-/items/-itemIndex-/price): changes the price of an SKU in a cart.\r\n- [GET - Cart installments](https://developers.vtex.com/docs/api-reference/checkout-api#get-/api/checkout/pub/orderForm/-orderFormId-/installments): retrieves possible amount of installments and respective values for a given cart with a given payment method.\r\n\r\n## Cart attachments\r\n\r\nAllows merchants to obtain client profiles and add information to a given shopping cart.\r\n\r\n- [GET - Get client profile by email](https://developers.vtex.com/docs/api-reference/checkout-api#get-/api/checkout/pub/profiles): retrieve a client's profile information by providing an email address.\r\n- [POST - Add client profile](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pub/orderForm/-orderFormId-/attachments/clientProfileData): include client profile information to a given shopping cart.\r\n- [Patch - Ignore profile data](https://developers.vtex.com/docs/api-reference/checkout-api#patch-/api/checkout/pub/orderForm/-orderFormId-/profile): disable the automatic inclusion of profile information in a shopping cart when a shopper provides an email address at checkout.\r\n- [GET - Remove all personal data](https://developers.vtex.com/docs/api-reference/checkout-api#get-/checkout/changeToAnonymousUser/-orderFormId-): removes all user information, making a cart anonymous while leaving the items.\r\n- [POST - Add client preferences](https://developers.vtex.com/docs/api-reference/checkout-api#patch-/api/checkout/pub/orderForm/-orderFormId-/items): include client preferences information to a given shopping cart.\r\n- [POST - Add shipping address and select delivery option](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pub/orderForm/-orderFormId-/attachments/shippingData): include shipping information and/or selected delivery option to a given shopping cart.\r\n- [POST - Add marketing data](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pub/orderForm/-orderFormId-/attachments/marketingData): include marketing information to a given shopping cart.\r\n- [POST - Add payment data](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pub/orderForm/-orderFormId-/attachments/paymentData): include payment information to a given shopping cart.\r\n- [POST - Add merchant context data](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pub/orderForm/-orderFormId-/attachments/merchantContextData): add to the cart any relevant information that is related to the context of a specific order.\r\n- [POST - Add coupons to the cart](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pub/orderForm/-orderFormId-/coupons): add coupons to a given shopping cart.\r\n\r\n## Custom data\r\n\r\nAllows merchants to manage custom fields that were created by an app in their account.\r\n\r\n- [PUT - Set multiple custom field values](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pub/orderForm/-orderFormId-/coupons): allows you to update the values of custom fields created in your account's apps.\r\n- [PUT - Set single custom field value](https://developers.vtex.com/docs/api-reference/checkout-api#put-/api/checkout/pub/orderForm/-orderFormId-/customData/-appId-/-appFieldName-): allows you to update the value of a specific custom field created in your account's apps.\r\n- [DELETE - Remove single custom field value](https://developers.vtex.com/docs/api-reference/checkout-api#delete-/api/checkout/pub/orderForm/-orderFormId-/customData/-appId-/-appFieldName-): allows you to remove the value of a specific custom field created in your account's apps.\r\n\r\n## Configuration\r\n\r\nAllows merchants to configure orderForm in the account and seller exchange on a given order.\r\n\r\n- [GET - Get orderForm configuration](https://developers.vtex.com/docs/api-reference/checkout-api#get-/api/checkout/pvt/configuration/orderForm): retrieves the settings that are currently applied to every [`orderForm`](https://developers.vtex.com/docs/guides/orderform-fields) in the account.\r\n- [POST - Update orderForm configuration](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pvt/configuration/orderForm): determines settings that will apply to every [`orderForm`](https://developers.vtex.com/docs/guides/orderform-fields) in the account.\r\n- [GET - Get window to change seller](https://developers.vtex.com/docs/api-reference/checkout-api#get-/api/checkout/pvt/configuration/window-to-change-seller): retrieves a marketplace’s window to change seller.\r\n- [POST - Update window to change seller](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pvt/configuration/window-to-change-seller): updates a marketplace’s window to change seller.\r\n- [POST - Clear orderForm messages](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pub/orderForm/-orderFormId-/messages/clear): removes all messages from the `messages` field of the [`orderForm`](https://developers.vtex.com/docs/guides/orderform-fields).\r\n\r\n## Fulfillment\r\n\r\nAllows merchants to obtain pickup points and address information.\r\n\r\n- [GET - List pickup points by location](https://developers.vtex.com/docs/api-reference/checkout-api#get-/api/checkout/pub/pickup-points): retrieves information on pickup points close to a given location determined by geocoordinates or postal code.\r\n- [GET - Get address by postal code](https://developers.vtex.com/docs/api-reference/checkout-api#get-/api/checkout/pub/postal-code/-countryCode-/-postalCode-): retrieves address information for a given postal code and country.\r\n\r\n## Order placement\r\n\r\nAllows merchants to place and process orders by creating a new cart or using an existing cart.\r\n\r\n- [POST - Place order from an existing cart](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pub/orderForm/-orderFormId-/transaction): places an order from an existing [`orderForm`](https://developers.vtex.com/docs/guides/orderform-fields) object, meaning an existing cart.\r\n- [PUT - Place order](https://developers.vtex.com/docs/api-reference/checkout-api#put-/api/checkout/pub/orders): places order without having any prior cart information.\r\n- [POST - Process order](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pub/gatewayCallback/-orderGroup-): order processing callback request, which is made after an order's payment is approved.\r\n\r\n## Region\r\n\r\nAllows merchants to obtain a list of sellers serving a specific delivery region.\r\n\r\n- [GET - Get sellers by region or address](https://developers.vtex.com/docs/api-reference/checkout-api#get-/api/checkout/pub/regions/-regionId-)\": retrieves a list of sellers that cater to a specific region or address.\r\n\r\n## Common parameters in the documentation\r\n\r\n| Parameter name            | Description                                                                             |\r\n|---------------------------|-----------------------------------------------------------------------------------------|\r\n| `{{accountName}}`         | Store account name                                                                      |\r\n| `{{environment}}`         | The environment that will be called. Change for vtexcommercestable or vtexcommmercebeta |\r\n| `{{X-VTEX-API-AppKey}}`   | Located in the headers of the requests, user authentication key                         |\r\n| `{{X-VTEX-API-AppToken}}` | Located in the headers of the requests, authentication password                         |\r\n",
+    "contact": {},
+    "version": "1.0"
+  },
+  "servers": [
+    {
+      "url": "https://{accountName}.{environment}.com.br",
+      "description": "VTEX server URL.",
+      "variables": {
+        "accountName": {
+          "description": "Name of the VTEX account. Used as part of the URL",
+          "default": "apiexamples"
+        },
+        "environment": {
+          "description": "Environment to use. Used as part of the URL.",
+          "enum": [
+            "vtexcommercestable"
+          ],
+          "default": "vtexcommercestable"
+        }
+      }
+    }
+  ],
+  "paths": {
+    "/api/checkout/pub/orderForms/simulation": {
+      "post": {
+        "tags": [
+          "Shopping cart"
+        ],
+        "summary": "Cart simulation",
+        "description": "This endpoint is used to simulate a cart in VTEX Checkout.\r\n\r\nIt receives an SKU ID, the quantity of items in the cart and the seller ID.\r\n\r\nIt returns all information about the cart, such as the selling price of each item, pricing and promotion data, payment and logistics info.\r\n\r\nThis request 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.\r\n\r\n>⚠️ 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.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [authentication](https://developers.vtex.com/docs/guides/authentication) or [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).",
+        "operationId": "CartSimulation",
+        "security": [],
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "RnbBehavior",
+            "in": "query",
+            "description": "This parameter defines which promotions apply to the simulation. Use `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.\n\r\n\rNote that if this not sent, the parameter is `1`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "integer",
+              "example": 0
+            }
+          },
+          {
+            "name": "sc",
+            "in": "query",
+            "description": "Trade Policy (Sales Channel) identification.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "integer",
+              "example": 1
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "required": [
+                  "id",
+                  "quantity",
+                  "seller"
+                ],
+                "properties": {
+                  "items": {
+                    "type": "array",
+                    "description": "Array containing information about the SKUs inside the cart to be simulated.",
+                    "items": {
+                      "type": "object",
+                      "description": "SKU information.",
+                      "properties": {
+                        "id": {
+                          "type": "string",
+                          "description": "The SKU ID.",
+                          "example": "1"
+                        },
+                        "quantity": {
+                          "type": "integer",
+                          "format": "int32",
+                          "description": "The quantity of items of this specific SKU in the cart to be simulated.",
+                          "example": 1
+                        },
+                        "seller": {
+                          "type": "string",
+                          "description": "The ID of the seller responsible for this SKU. This ID can be found in your VTEX Admin.",
+                          "example": "1"
+                        }
+                      }
+                    }
+                  },
+                  "country": {
+                    "type": "string",
+                    "description": "Three letter ISO code of the country of the shipping address. This value must be sent along with the `postalCode` or `geoCoordinates` values.",
+                    "example": "BRA"
+                  },
+                  "postalCode": {
+                    "type": "string",
+                    "description": "Postal code.",
+                    "example": "12345-000"
+                  },
+                  "geoCoordinates": {
+                    "type": "array",
+                    "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
+                    "example": [
+                      -47.924747467041016,
+                      -15.832582473754883
+                    ],
+                    "items": {
+                      "description": "Geocoordinates.",
+                      "type": "number",
+                      "example": -47.924747467041016
+                    }
+                  }
+                }
+              },
+              "example": {
+                "items": [
+                  {
+                    "id": "12345",
+                    "quantity": 2,
+                    "seller": "1"
+                  },
+                  {
+                    "id": "67890",
+                    "quantity": 1,
+                    "seller": "2"
+                  }
+                ],
+                "country": "BRA",
+                "postalCode": "12345-000",
+                "geoCoordinates": [
+                  -47.924747,
+                  -15.832582
+                ]
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "items": {
+                      "type": "array",
+                      "description": "Information on each item in the cart.",
+                      "items": {
+                        "type": "object",
+                        "description": "Object containing information of the item.",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "ID of the item."
+                          },
+                          "requestIndex": {
+                            "type": "integer",
+                            "description": "Request index information."
+                          },
+                          "quantity": {
+                            "type": "integer",
+                            "description": "The quantity of the item the cart."
+                          },
+                          "seller": {
+                            "type": "string",
+                            "description": "The seller responsible for the SKU."
+                          },
+                          "sellerChain": {
+                            "type": "array",
+                            "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
+                            "items": {
+                              "type": "string",
+                              "description": "Seller."
+                            }
+                          },
+                          "tax": {
+                            "type": "integer",
+                            "description": "Tax value in cents."
+                          },
+                          "taxCode": {
+                            "type": "string",
+                            "description": "A unique identifier code assigned to a tax within the VTEX Admin."
+                          },
+                          "priceValidUntil": {
+                            "type": "string",
+                            "description": "Price expiration date and time."
+                          },
+                          "price": {
+                            "type": "integer",
+                            "description": "Price in cents."
+                          },
+                          "listPrice": {
+                            "type": "integer",
+                            "description": "List price in cents."
+                          },
+                          "rewardValue": {
+                            "type": "integer",
+                            "description": "Reward value in cents."
+                          },
+                          "sellingPrice": {
+                            "type": "integer",
+                            "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
+                          },
+                          "offerings": {
+                            "type": "array",
+                            "description": "Array containing offering information of SKU service. A service is an item that may come with a product, optionally and with cost. It is used to assign a value of an additional service itself to an SKU.",
+                            "items": {
+                              "type": "object",
+                              "description": "Service general information.",
+                              "properties": {
+                                "type": {
+                                  "type": "string",
+                                  "description": "Service type."
+                                },
+                                "id": {
+                                  "type": "string",
+                                  "description": "Service type ID."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Name of the service type."
+                                },
+                                "allowGiftMessage": {
+                                  "type": "boolean",
+                                  "description": "Option to display the service type on the gift card."
+                                },
+                                "attachmentOfferings": {
+                                  "type": "array",
+                                  "description": "List of attachments details.",
+                                  "nullable": true,
+                                  "items": {
+                                    "description": "Attachment details.",
+                                    "type": "object",
+                                    "required": [
+                                      "name",
+                                      "required",
+                                      "schema"
+                                    ],
+                                    "properties": {
+                                      "name": {
+                                        "type": "string",
+                                        "description": "Name of the attachment.",
+                                        "nullable": true
+                                      },
+                                      "required": {
+                                        "type": "boolean",
+                                        "description": "Defines if the attachment is required (`true`) or not (`false`).",
+                                        "nullable": true
+                                      },
+                                      "schema": {
+                                        "type": "object",
+                                        "description": "Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).",
+                                        "nullable": true
+                                      }
+                                    }
+                                  }
+                                },
+                                "price": {
+                                  "type": "integer",
+                                  "description": "Service type price."
+                                }
+                              }
+                            }
+                          },
+                          "priceTags": {
+                            "type": "array",
+                            "description": "Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.",
+                            "items": {
+                              "description": "Price tag information.",
+                              "type": "object",
+                              "properties": {
+                                "identifier": {
+                                  "type": "string",
+                                  "description": "Promotion unique identifier.",
+                                  "nullable": true
+                                },
+                                "isPercentual": {
+                                  "type": "boolean",
+                                  "description": "Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\r\n- `type` indicates whether the tag refers to a discount or tax.\r\n- `where` specifies the context, either price or shipping.\r\n- `identifier` is the promotion ID.\r\n- `calculationId` is a hash that may vary with each price calculation."
+                                },
+                                "rawValue": {
+                                  "type": "number",
+                                  "description": "Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations."
+                                },
+                                "value": {
+                                  "type": "integer",
+                                  "description": "Price tag value representing either a promotion (value decrease) or a tax (value increase)."
+                                }
+                              }
+                            }
+                          },
+                          "measurementUnit": {
+                            "type": "string",
+                            "description": "Measurement unit."
+                          },
+                          "unitMultiplier": {
+                            "type": "integer",
+                            "description": "Unit multiplier."
+                          },
+                          "parentItemIndex": {
+                            "type": "integer",
+                            "description": "Parent item index.",
+                            "nullable": true
+                          },
+                          "parentAssemblyBinding": {
+                            "type": "string",
+                            "description": "Parent assembly binding.",
+                            "nullable": true
+                          },
+                          "availability": {
+                            "type": "string",
+                            "description": "Availability."
+                          },
+                          "priceDefinition": {
+                            "type": "object",
+                            "description": "Price information for all units of a specific item.",
+                            "properties": {
+                              "calculatedSellingPrice": {
+                                "type": "integer",
+                                "description": "Item's calculated unitary selling price in cents."
+                              },
+                              "total": {
+                                "type": "integer",
+                                "description": "Total value for all units of the item in cents."
+                              },
+                              "sellingPrices": {
+                                "type": "array",
+                                "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
+                                "items": {
+                                  "type": "object",
+                                  "description": "Item value and rounding quantity.",
+                                  "properties": {
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value in cents for that specific rounding."
+                                    },
+                                    "quantity": {
+                                      "type": "integer",
+                                      "description": "Rounding quantity, meaning how many items are rounded to this value."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "ratesAndBenefitsData": {
+                      "type": "object",
+                      "description": "Information on pricing and promotions that apply to the order.",
+                      "properties": {
+                        "rateAndBenefitsIdentifiers": {
+                          "type": "array",
+                          "description": "List with pricing and promotions identifiers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Promotion identifier."
+                          }
+                        },
+                        "teaser": {
+                          "type": "array",
+                          "description": "List with pricing and promotions teaser.",
+                          "items": {
+                            "type": "string",
+                            "description": "Promotion teaser."
+                          }
+                        }
+                      }
+                    },
+                    "paymentData": {
+                      "type": "object",
+                      "description": "Payment data information.",
+                      "properties": {
+                        "installmentOptions": {
+                          "type": "array",
+                          "description": "List of Installment options.",
+                          "items": {
+                            "type": "object",
+                            "description": "Information about the installment option.",
+                            "properties": {
+                              "paymentSystem": {
+                                "type": "integer",
+                                "description": "Payment system identification."
+                              },
+                              "bin": {
+                                "type": "string",
+                                "description": "Card bin.",
+                                "nullable": true
+                              },
+                              "paymentName": {
+                                "type": "string",
+                                "description": "Payment name.",
+                                "nullable": true
+                              },
+                              "paymentGroupName": {
+                                "type": "string",
+                                "description": "Payment group name.",
+                                "nullable": true
+                              },
+                              "value": {
+                                "type": "integer",
+                                "description": "Total value assigned to this payment."
+                              },
+                              "installments": {
+                                "type": "array",
+                                "description": "Installment information.",
+                                "items": {
+                                  "type": "object",
+                                  "description": "Installment information.",
+                                  "properties": {
+                                    "count": {
+                                      "type": "integer",
+                                      "description": "Count information."
+                                    },
+                                    "hasInterestRate": {
+                                      "type": "boolean",
+                                      "description": "Indicates whether the payment has interest."
+                                    },
+                                    "interestRate": {
+                                      "type": "integer",
+                                      "description": "Interest rate value."
+                                    },
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value of the order without the interest rate. The value is shown without separating cents."
+                                    },
+                                    "total": {
+                                      "type": "integer",
+                                      "description": "Total value of the order without separating cents. For example, $24.99 is represented `2499`."
+                                    },
+                                    "sellerMerchantInstallments": {
+                                      "type": "array",
+                                      "description": "Seller merchant installments information.",
+                                      "items": {
+                                        "type": "object",
+                                        "description": "Installment information."
+                                      }
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "paymentSystems": {
+                          "type": "array",
+                          "description": "Information on payment systems.",
+                          "items": {
+                            "type": "object",
+                            "description": "Payment system information.",
+                            "properties": {
+                              "id": {
+                                "type": "integer",
+                                "description": "Payment system ID."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Payment system name."
+                              },
+                              "groupName": {
+                                "type": "string",
+                                "description": "Payment group name."
+                              },
+                              "validator": {
+                                "type": "object",
+                                "description": "Payment system validator.",
+                                "nullable": true
+                              },
+                              "stringId": {
+                                "type": "string",
+                                "description": "String ID."
+                              },
+                              "template": {
+                                "type": "string",
+                                "description": "Template."
+                              },
+                              "requiresDocument": {
+                                "type": "boolean",
+                                "description": "Indicates whether a document is required."
+                              },
+                              "displayDocument": {
+                                "type": "boolean",
+                                "description": "Indicates whether a document is shown."
+                              },
+                              "isCustom": {
+                                "type": "boolean",
+                                "description": "Indicates whether it is custom."
+                              },
+                              "description": {
+                                "type": "string",
+                                "description": "Description."
+                              },
+                              "requiresAuthentication": {
+                                "type": "boolean",
+                                "description": "Indicates whether a authentication is required."
+                              },
+                              "dueDate": {
+                                "type": "string",
+                                "description": "Payment due date."
+                              },
+                              "availablePayments": {
+                                "type": "string",
+                                "description": "Availability of payment.",
+                                "nullable": true
+                              }
+                            }
+                          }
+                        },
+                        "payments": {
+                          "type": "array",
+                          "description": "Array with information on each payment chosen by the shopper.",
+                          "items": {
+                            "type": "object",
+                            "description": "Payment information.",
+                            "properties": {
+                              "paymentSystem": {
+                                "type": "integer",
+                                "description": "Payment system ID."
+                              },
+                              "paymentSystemName": {
+                                "type": "string",
+                                "description": "Payment system name."
+                              },
+                              "group": {
+                                "type": "string",
+                                "description": "Payment system group."
+                              },
+                              "installments": {
+                                "type": "integer",
+                                "description": "Selected number of installments."
+                              },
+                              "installmentsInterestRate": {
+                                "type": "number",
+                                "description": "Installments' interest rate."
+                              },
+                              "installmentsValue": {
+                                "type": "integer",
+                                "description": "Value of the installments."
+                              },
+                              "value": {
+                                "type": "integer",
+                                "description": "Total value assigned to this payment."
+                              },
+                              "referenceValue": {
+                                "type": "integer",
+                                "description": "Reference value used to calculate total order value with interest."
+                              },
+                              "hasDefaultBillingAddress": {
+                                "type": "boolean",
+                                "description": "Indicates whether billing address for this payment is the default address."
+                              }
+                            }
+                          }
+                        },
+                        "giftCards": {
+                          "type": "array",
+                          "description": "Gift card information, if it applies to the order.",
+                          "items": {
+                            "type": "string",
+                            "description": "Gift card."
+                          }
+                        },
+                        "giftCardMessages": {
+                          "type": "array",
+                          "description": "Array of gift card messages.",
+                          "items": {
+                            "type": "string",
+                            "description": "Gift card message."
+                          }
+                        },
+                        "availableAccounts": {
+                          "type": "array",
+                          "description": "Available accounts.",
+                          "items": {
+                            "type": "string",
+                            "description": "Available account."
+                          }
+                        },
+                        "availableTokens": {
+                          "type": "array",
+                          "description": "Available tokens.",
+                          "items": {
+                            "type": "string",
+                            "description": "Available token."
+                          }
+                        },
+                        "availableAssociations": {
+                          "type": "object",
+                          "description": "Available associations."
+                        }
+                      }
+                    },
+                    "selectableGifts": {
+                      "type": "array",
+                      "description": "Array containing the data of the items selected as a gift.",
+                      "items": {
+                        "type": "string",
+                        "description": "Selected gift item."
+                      }
+                    },
+                    "marketingData": {
+                      "type": "object",
+                      "description": "Object containing promotion data such as coupon tracking information and internal or external UTMs.",
+                      "nullable": true
+                    },
+                    "postalCode": {
+                      "type": "string",
+                      "description": "Postal code.",
+                      "nullable": true
+                    },
+                    "country": {
+                      "type": "string",
+                      "description": "Three letter ISO code of the country of the shipping address."
+                    },
+                    "logisticsInfo": {
+                      "type": "array",
+                      "description": "Array with logistics information on each item of the `items` array in the `orderForm`.",
+                      "items": {
+                        "description": "Logistics information of a item.",
+                        "type": "object",
+                        "properties": {
+                          "itemIndex": {
+                            "type": "integer",
+                            "description": "Index of item in items array."
+                          },
+                          "addressId": {
+                            "type": "string",
+                            "description": "Address ID.",
+                            "nullable": true
+                          },
+                          "selectedSla": {
+                            "type": "string",
+                            "description": "Selected SLA. For example, `\"normal\"` or `\"express\"`.",
+                            "nullable": true
+                          },
+                          "selectedDeliveryChannel": {
+                            "type": "string",
+                            "description": "Delivery channel selected by the customer. For example, `\"delivery\"` or `\"pickup-in-point\"`.",
+                            "nullable": true
+                          },
+                          "quantity": {
+                            "type": "integer",
+                            "description": "Quantity."
+                          },
+                          "shipsTo": {
+                            "type": "array",
+                            "description": "List of countries that the item may be shipped to.",
+                            "items": {
+                              "type": "string",
+                              "description": "Country that the item may be shipped to."
+                            }
+                          },
+                          "slas": {
+                            "type": "array",
+                            "description": "Information on available SLAs.",
+                            "items": {
+                              "description": "SLA information.",
+                              "type": "object",
+                              "properties": {
+                                "id": {
+                                  "type": "string",
+                                  "description": "SLA ID."
+                                },
+                                "deliveryChannel": {
+                                  "type": "string",
+                                  "description": "Delivery channel."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "SLA name."
+                                },
+                                "deliveryIds": {
+                                  "type": "array",
+                                  "description": "Information on each delivery ID.",
+                                  "items": {
+                                    "type": "object",
+                                    "description": "Object with delivery infomation.",
+                                    "properties": {
+                                      "courierId": {
+                                        "type": "string",
+                                        "description": "Courier ID."
+                                      },
+                                      "warehouseId": {
+                                        "type": "string",
+                                        "description": "Warehouse ID."
+                                      },
+                                      "dockId": {
+                                        "type": "string",
+                                        "description": "Warehouse ID."
+                                      },
+                                      "courierName": {
+                                        "type": "string",
+                                        "description": "Courier name."
+                                      },
+                                      "quantity": {
+                                        "type": "integer",
+                                        "description": "Quantity."
+                                      }
+                                    }
+                                  }
+                                },
+                                "attachmentOfferings": {
+                                  "type": "array",
+                                  "description": "List of attachments details.",
+                                  "nullable": true,
+                                  "items": {
+                                    "description": "Attachment details.",
+                                    "type": "object",
+                                    "required": [
+                                      "name",
+                                      "required",
+                                      "schema"
+                                    ],
+                                    "properties": {
+                                      "name": {
+                                        "type": "string",
+                                        "description": "Name of the attachment.",
+                                        "nullable": true
+                                      },
+                                      "required": {
+                                        "type": "boolean",
+                                        "description": "Defines if the attachment is required (`true`) or not (`false`).",
+                                        "nullable": true
+                                      },
+                                      "schema": {
+                                        "type": "object",
+                                        "description": "Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).",
+                                        "nullable": true
+                                      }
+                                    }
+                                  }
+                                },
+                                "shippingEstimate": {
+                                  "type": "string",
+                                  "description": "Shipping estimate. For instance, \"three business days\" will be represented as `3bd`."
+                                },
+                                "shippingEstimateDate": {
+                                  "type": "string",
+                                  "description": "When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.",
+                                  "nullable": true
+                                },
+                                "useIndividualShippingEstimates": {
+                                  "type": "boolean",
+                                  "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`."
+                                },
+                                "lockTTL": {
+                                  "type": "string",
+                                  "description": "Estimate date of delivery.",
+                                  "nullable": true
+                                },
+                                "availableDeliveryWindows": {
+                                  "type": "object",
+                                  "description": "This object contains information about the delivery window available to the shopper.",
+                                  "properties": {
+                                    "startDateUtc": {
+                                      "type": "string",
+                                      "description": "Delivery window starting day and time in UTC."
+                                    },
+                                    "endDateUtc": {
+                                      "type": "string",
+                                      "description": "Delivery window ending day and time in UTC."
+                                    },
+                                    "price": {
+                                      "type": "integer",
+                                      "description": "Delivery window price."
+                                    },
+                                    "lisPrice": {
+                                      "type": "integer",
+                                      "description": "Delivery window list price."
+                                    },
+                                    "tax": {
+                                      "type": "integer",
+                                      "description": "Delivery window tax."
+                                    }
+                                  }
+                                },
+                                "deliveryWindow": {
+                                  "type": "object",
+                                  "description": "In case of scheduled delivery, this object will contain information on the delivery window selected by the shopper.",
+                                  "properties": {
+                                    "startDateUtc": {
+                                      "type": "string",
+                                      "description": "Delivery window starting day and time in UTC."
+                                    },
+                                    "endDateUtc": {
+                                      "type": "string",
+                                      "description": "Delivery window ending day and time in UTC."
+                                    },
+                                    "price": {
+                                      "type": "integer",
+                                      "description": "Delivery window price."
+                                    },
+                                    "lisPrice": {
+                                      "type": "integer",
+                                      "description": "Delivery window list price."
+                                    },
+                                    "tax": {
+                                      "type": "integer",
+                                      "description": "Delivery window tax."
+                                    }
+                                  }
+                                },
+                                "price": {
+                                  "type": "integer",
+                                  "description": "Price in cents."
+                                },
+                                "listPrice": {
+                                  "type": "integer",
+                                  "description": "List price in cents."
+                                },
+                                "tax": {
+                                  "type": "integer",
+                                  "description": "Tax in cents."
+                                },
+                                "pickupStoreInfo": {
+                                  "type": "object",
+                                  "description": "Information on the pickup store.",
+                                  "properties": {
+                                    "isPickupStore": {
+                                      "type": "boolean",
+                                      "description": "Indicates whether it is the pickup store."
+                                    },
+                                    "friendlyName": {
+                                      "type": "string",
+                                      "description": "Friendly name.",
+                                      "nullable": true
+                                    },
+                                    "address": {
+                                      "type": "object",
+                                      "description": "Address information.",
+                                      "nullable": true
+                                    },
+                                    "additionalInfo": {
+                                      "type": "string",
+                                      "description": "Additional information.",
+                                      "nullable": true
+                                    },
+                                    "dockId": {
+                                      "type": "string",
+                                      "description": "Corresponding dock ID.",
+                                      "nullable": true
+                                    }
+                                  }
+                                },
+                                "pickupPointId": {
+                                  "type": "string",
+                                  "description": "Pickup point ID.",
+                                  "nullable": true
+                                },
+                                "pickupDistance": {
+                                  "type": "integer",
+                                  "description": "Pickup point distance."
+                                },
+                                "polygonName": {
+                                  "type": "string",
+                                  "description": "Polygon name.",
+                                  "nullable": true
+                                },
+                                "transitTime": {
+                                  "type": "string",
+                                  "description": "Transit time. For instance, \"three business days\" is represented as `3bd`."
+                                }
+                              }
+                            }
+                          },
+                          "deliveryChannels": {
+                            "type": "array",
+                            "description": "List of available delivery channels.",
+                            "items": {
+                              "type": "object",
+                              "description": "Object containing delivery channel ID.",
+                              "properties": {
+                                "id": {
+                                  "type": "string",
+                                  "description": "Delivery channel ID."
+                                }
+                              }
+                            }
+                          },
+                          "messages": {
+                            "type": "array",
+                            "description": "Array containing an object for each message generated by our servers while processing the request.",
+                            "items": {
+                              "type": "string",
+                              "description": "Message."
+                            }
+                          },
+                          "purchaseConditions": {
+                            "type": "object",
+                            "description": "Purchase conditions information.",
+                            "properties": {
+                              "itemPurchaseConditions": {
+                                "type": "array",
+                                "description": "List of objects containing purchase condition information on each item in the order.",
+                                "items": {
+                                  "type": "object",
+                                  "description": "Purchase condition information.",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "Item ID."
+                                    },
+                                    "seller": {
+                                      "type": "string",
+                                      "description": "Seller."
+                                    },
+                                    "sellerChain": {
+                                      "type": "array",
+                                      "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
+                                      "items": {
+                                        "type": "string",
+                                        "description": "Seller ID."
+                                      }
+                                    },
+                                    "slas": {
+                                      "type": "array",
+                                      "description": "Information on available SLAs.",
+                                      "items": {
+                                        "type": "object",
+                                        "description": "SLA information.",
+                                        "properties": {
+                                          "id": {
+                                            "type": "string",
+                                            "description": "SLA ID."
+                                          },
+                                          "deliveryChannel": {
+                                            "type": "string",
+                                            "description": "Delivery channel."
+                                          },
+                                          "name": {
+                                            "type": "string",
+                                            "description": "SLA name."
+                                          },
+                                          "deliveryIds": {
+                                            "type": "array",
+                                            "description": "Information on each delivery ID.",
+                                            "items": {
+                                              "type": "object",
+                                              "description": "Object with delivery inforamtion.",
+                                              "properties": {
+                                                "courierId": {
+                                                  "type": "string",
+                                                  "description": "Courier ID."
+                                                },
+                                                "warehouseId": {
+                                                  "type": "string",
+                                                  "description": "Warehouse ID."
+                                                },
+                                                "dockId": {
+                                                  "type": "string",
+                                                  "description": "Warehouse ID."
+                                                },
+                                                "courierName": {
+                                                  "type": "string",
+                                                  "description": "Courier name."
+                                                },
+                                                "quantity": {
+                                                  "type": "integer",
+                                                  "description": "Quantity."
+                                                }
+                                              }
+                                            }
+                                          },
+                                          "attachmentOfferings": {
+                                            "type": "array",
+                                            "description": "List of attachments details.",
+                                            "nullable": true,
+                                            "items": {
+                                              "description": "Attachment details.",
+                                              "type": "object",
+                                              "required": [
+                                                "name",
+                                                "required",
+                                                "schema"
+                                              ],
+                                              "properties": {
+                                                "name": {
+                                                  "type": "string",
+                                                  "description": "Name of the attachment. Ex. `vtex.subscription.weekly`.",
+                                                  "nullable": true
+                                                },
+                                                "required": {
+                                                  "type": "boolean",
+                                                  "description": "Defines if the attachment is required (`true`) or not (`false`).",
+                                                  "nullable": true
+                                                },
+                                                "schema": {
+                                                  "type": "object",
+                                                  "description": "Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).",
+                                                  "nullable": true
+                                                }
+                                              }
+                                            }
+                                          },
+                                          "shippingEstimate": {
+                                            "type": "string",
+                                            "description": "Shipping estimate. For instance, \"three business days\" will be represented as `3bd`."
+                                          },
+                                          "shippingEstimateDate": {
+                                            "type": "string",
+                                            "description": "When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.",
+                                            "nullable": true
+                                          },
+                                          "useIndividualShippingEstimates": {
+                                            "type": "boolean",
+                                            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`."
+                                          },
+                                          "lockTTL": {
+                                            "type": "string",
+                                            "description": "Estimate date of delivery.",
+                                            "nullable": true
+                                          },
+                                          "availableDeliveryWindows": {
+                                            "type": "object",
+                                            "description": "This object contains information about the delivery window available to the shopper.",
+                                            "properties": {
+                                              "startDateUtc": {
+                                                "type": "string",
+                                                "description": "Delivery window starting day and time in UTC."
+                                              },
+                                              "endDateUtc": {
+                                                "type": "string",
+                                                "description": "Delivery window ending day and time in UTC."
+                                              },
+                                              "price": {
+                                                "type": "integer",
+                                                "description": "Delivery window price."
+                                              },
+                                              "lisPrice": {
+                                                "type": "integer",
+                                                "description": "Delivery window list price."
+                                              },
+                                              "tax": {
+                                                "type": "integer",
+                                                "description": "Delivery window tax."
+                                              }
+                                            }
+                                          },
+                                          "deliveryWindow": {
+                                            "type": "object",
+                                            "description": "In case of scheduled delivery, this object will contain information on the delivery window selected by the shopper.",
+                                            "properties": {
+                                              "startDateUtc": {
+                                                "type": "string",
+                                                "description": "Delivery window starting day and time in UTC."
+                                              },
+                                              "endDateUtc": {
+                                                "type": "string",
+                                                "description": "Delivery window ending day and time in UTC."
+                                              },
+                                              "price": {
+                                                "type": "integer",
+                                                "description": "Delivery window price."
+                                              },
+                                              "lisPrice": {
+                                                "type": "integer",
+                                                "description": "Delivery window list price."
+                                              },
+                                              "tax": {
+                                                "type": "integer",
+                                                "description": "Delivery window tax."
+                                              }
+                                            }
+                                          },
+                                          "price": {
+                                            "type": "integer",
+                                            "description": "Price in cents."
+                                          },
+                                          "listPrice": {
+                                            "type": "integer",
+                                            "description": "List price in cents."
+                                          },
+                                          "tax": {
+                                            "type": "integer",
+                                            "description": "Tax in cents."
+                                          },
+                                          "pickupStoreInfo": {
+                                            "type": "object",
+                                            "description": "Information on the pickup store.",
+                                            "properties": {
+                                              "isPickupStore": {
+                                                "type": "boolean",
+                                                "description": "Indicates whether it is the pickup store."
+                                              },
+                                              "friendlyName": {
+                                                "type": "string",
+                                                "description": "Friendly name.",
+                                                "nullable": true
+                                              },
+                                              "address": {
+                                                "type": "object",
+                                                "description": "Address information.",
+                                                "nullable": true
+                                              },
+                                              "additionalInfo": {
+                                                "type": "string",
+                                                "description": "Additional information.",
+                                                "nullable": true
+                                              },
+                                              "dockId": {
+                                                "type": "string",
+                                                "description": "Corresponding dock ID.",
+                                                "nullable": true
+                                              }
+                                            }
+                                          },
+                                          "pickupPointId": {
+                                            "type": "string",
+                                            "description": "Pickup point ID.",
+                                            "nullable": true
+                                          },
+                                          "pickupDistance": {
+                                            "type": "integer",
+                                            "description": "Pickup point distance."
+                                          },
+                                          "polygonName": {
+                                            "type": "string",
+                                            "description": "Polygon name.",
+                                            "nullable": true
+                                          },
+                                          "transitTime": {
+                                            "type": "string",
+                                            "description": "Transit time. For instance, \"three business days\" is represented as `3bd`."
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "price": {
+                                      "type": "integer",
+                                      "description": "Price in cents."
+                                    },
+                                    "listPrice": {
+                                      "type": "integer",
+                                      "description": "List price in cents."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          },
+                          "pickupPoints": {
+                            "type": "array",
+                            "description": "Array containing pickup points information.",
+                            "items": {
+                              "type": "string",
+                              "description": "Pickup points."
+                            }
+                          },
+                          "subscriptionData": {
+                            "type": "object",
+                            "description": "Subscription information.",
+                            "nullable": true
+                          },
+                          "totals": {
+                            "type": "array",
+                            "description": "Information on order totals.",
+                            "items": {
+                              "type": "object",
+                              "description": "Order information.",
+                              "properties": {
+                                "id": {
+                                  "type": "string",
+                                  "description": "Total ID."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Total name."
+                                },
+                                "value": {
+                                  "type": "integer",
+                                  "description": "Total value."
+                                }
+                              }
+                            }
+                          },
+                          "itemMetadata": {
+                            "type": "object",
+                            "description": "Item metadata.",
+                            "properties": {
+                              "items": {
+                                "type": "array",
+                                "description": "List of objects containing metadata on each item in the order.",
+                                "items": {
+                                  "type": "object",
+                                  "description": "Object containing item metadata.",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "Item ID."
+                                    },
+                                    "seller": {
+                                      "type": "string",
+                                      "description": "Seller."
+                                    },
+                                    "assemblyOptions": {
+                                      "type": "array",
+                                      "description": "Assembly options information.",
+                                      "items": {
+                                        "type": "string",
+                                        "description": "Assembly option.",
+                                        "properties": {
+                                          "id": {
+                                            "type": "string",
+                                            "description": "Item ID."
+                                          },
+                                          "name": {
+                                            "type": "string",
+                                            "description": "Item name."
+                                          },
+                                          "required": {
+                                            "type": "boolean",
+                                            "description": "Indicates whether the item is required."
+                                          },
+                                          "inputValues": {
+                                            "type": "object",
+                                            "description": "Input values information."
+                                          },
+                                          "composition": {
+                                            "type": "string",
+                                            "description": "Composition information.",
+                                            "nullable": true
+                                          }
+                                        }
+                                      }
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    }
+                  }
+                },
+                "example": {
+                  "items": [
+                    {
+                      "id": "1",
+                      "requestIndex": 0,
+                      "quantity": 1,
+                      "seller": "1",
+                      "sellerChain": [
+                        "1"
+                      ],
+                      "tax": 0,
+                      "taxCode": "54WC8ZN6K8",
+                      "priceValidUntil": "2023-07-12T11:49:01Z",
+                      "price": 9999,
+                      "listPrice": 9999,
+                      "rewardValue": 0,
+                      "sellingPrice": 2999700,
+                      "offerings": [
+                        {
+                          "type": "removal of additional old appliance",
+                          "id": "1",
+                          "name": "removal of additional old appliance",
+                          "allowGiftMessage": false,
+                          "attachmentOfferings": [
+                            {
+                              "name": "vtex.subscription.weekly",
+                              "required": false,
+                              "schema": {
+                                "vtex.subscription.key.frequency": {
+                                  "MaximumNumberOfCharacters": 7,
+                                  "Domain": [
+                                    "1 week",
+                                    "2 week",
+                                    "3 week",
+                                    "4 week"
+                                  ]
+                                }
+                              }
+                            },
+                            {
+                              "name": "vtex.subscription.daily",
+                              "required": false,
+                              "schema": {
+                                "vtex.subscription.key.frequency": {
+                                  "MaximumNumberOfCharacters": 5,
+                                  "Domain": [
+                                    "1 day"
+                                  ]
+                                }
+                              }
+                            }
+                          ],
+                          "price": 2999
+                        }
+                      ],
+                      "priceTags": [
+                        {
+                          "name": "DISCOUNT@MANUALPRICE",
+                          "value": -5000,
+                          "rawValue": -50,
+                          "isPercentual": false,
+                          "identifier": "1234abc-5678b-1234c"
+                        }
+                      ],
+                      "measurementUnit": "un",
+                      "unitMultiplier": 300,
+                      "parentItemIndex": null,
+                      "parentAssemblyBinding": null,
+                      "availability": "available",
+                      "priceDefinition": {
+                        "calculatedSellingPrice": 2999700,
+                        "total": 2999700,
+                        "sellingPrices": [
+                          {
+                            "value": 2999700,
+                            "quantity": 1
+                          }
+                        ]
+                      }
+                    }
+                  ],
+                  "ratesAndBenefitsData": {
+                    "rateAndBenefitsIdentifiers": [],
+                    "teaser": []
+                  },
+                  "paymentData": {
+                    "installmentOptions": [
+                      {
+                        "paymentSystem": 2,
+                        "bin": null,
+                        "paymentName": "Visa",
+                        "paymentGroupName": "creditCardPaymentGroup",
+                        "value": 2999700,
+                        "installments": [
+                          {
+                            "count": 1,
+                            "hasInterestRate": false,
+                            "interestRate": 0,
+                            "value": 2999700,
+                            "total": 2999700,
+                            "sellerMerchantInstallments": [
+                              {
+                                "id": "LOJADOBRENO",
+                                "count": 1,
+                                "hasInterestRate": false,
+                                "interestRate": 0,
+                                "value": 2999700,
+                                "total": 2999700
+                              }
+                            ]
+                          }
+                        ]
+                      },
+                      {
+                        "paymentSystem": 6,
+                        "bin": null,
+                        "paymentName": "Boleto Bancário",
+                        "paymentGroupName": "bankInvoicePaymentGroup",
+                        "value": 2999700,
+                        "installments": [
+                          {
+                            "count": 1,
+                            "hasInterestRate": false,
+                            "interestRate": 0,
+                            "value": 2999700,
+                            "total": 2999700,
+                            "sellerMerchantInstallments": [
+                              {
+                                "id": "LOJADOBRENO",
+                                "count": 1,
+                                "hasInterestRate": false,
+                                "interestRate": 0,
+                                "value": 2999700,
+                                "total": 2999700
+                              }
+                            ]
+                          }
+                        ]
+                      },
+                      {
+                        "paymentSystem": 127,
+                        "bin": null,
+                        "paymentName": "MercadoPagoPro",
+                        "paymentGroupName": "MercadoPagoProPaymentGroup",
+                        "value": 2999700,
+                        "installments": [
+                          {
+                            "count": 1,
+                            "hasInterestRate": false,
+                            "interestRate": 0,
+                            "value": 2999700,
+                            "total": 2999700,
+                            "sellerMerchantInstallments": [
+                              {
+                                "id": "LOJADOBRENO",
+                                "count": 1,
+                                "hasInterestRate": false,
+                                "interestRate": 0,
+                                "value": 2999700,
+                                "total": 2999700
+                              }
+                            ]
+                          }
+                        ]
+                      },
+                      {
+                        "paymentSystem": 202,
+                        "bin": null,
+                        "paymentName": "Dinheiro",
+                        "paymentGroupName": "custom202PaymentGroupPaymentGroup",
+                        "value": 2999700,
+                        "installments": [
+                          {
+                            "count": 1,
+                            "hasInterestRate": false,
+                            "interestRate": 0,
+                            "value": 2999700,
+                            "total": 2999700,
+                            "sellerMerchantInstallments": [
+                              {
+                                "id": "LOJADOBRENO",
+                                "count": 1,
+                                "hasInterestRate": false,
+                                "interestRate": 0,
+                                "value": 2999700,
+                                "total": 2999700
+                              }
+                            ]
+                          }
+                        ]
+                      }
+                    ],
+                    "paymentSystems": [
+                      {
+                        "id": 202,
+                        "name": "Dinheiro",
+                        "groupName": "custom202PaymentGroupPaymentGroup",
+                        "validator": {
+                          "regex": "^4[0-9]{15}$",
+                          "mask": "9999 9999 9999 9999",
+                          "cardCodeRegex": "^[0-9]{3}$",
+                          "cardCodeMask": "999",
+                          "weights": [
+                            2,
+                            1,
+                            2,
+                            1,
+                            2
+                          ],
+                          "useCvv": true,
+                          "useExpirationDate": true,
+                          "useCardHolderName": true,
+                          "useBillingAddress": true
+                        },
+                        "stringId": "202",
+                        "template": "custom202PaymentGroupPaymentGroup-template",
+                        "requiresDocument": false,
+                        "displayDocument": false,
+                        "isCustom": true,
+                        "description": "Payment description",
+                        "requiresAuthentication": false,
+                        "dueDate": "2022-07-22T11:39:36.37197Z",
+                        "availablePayments": null
+                      },
+                      {
+                        "id": 6,
+                        "name": "Boleto Bancário",
+                        "groupName": "bankInvoicePaymentGroup",
+                        "validator": {
+                          "regex": "^4[0-9]{15}$",
+                          "mask": "9999 9999 9999 9999",
+                          "cardCodeRegex": "^[0-9]{3}$",
+                          "cardCodeMask": "999",
+                          "weights": [
+                            2,
+                            1,
+                            2,
+                            1,
+                            2
+                          ],
+                          "useCvv": true,
+                          "useExpirationDate": true,
+                          "useCardHolderName": true,
+                          "useBillingAddress": true
+                        },
+                        "stringId": "6",
+                        "template": "bankInvoicePaymentGroup-template",
+                        "requiresDocument": false,
+                        "displayDocument": false,
+                        "isCustom": false,
+                        "description": "Payment description",
+                        "requiresAuthentication": false,
+                        "dueDate": "2022-07-19T11:39:36.37197Z",
+                        "availablePayments": null
+                      },
+                      {
+                        "id": 2,
+                        "name": "Visa",
+                        "groupName": "creditCardPaymentGroup",
+                        "validator": {
+                          "regex": "^4[0-9]{15}$",
+                          "mask": "9999 9999 9999 9999",
+                          "cardCodeRegex": "^[0-9]{3}$",
+                          "cardCodeMask": "999",
+                          "weights": [
+                            2,
+                            1,
+                            2,
+                            1,
+                            2
+                          ],
+                          "useCvv": true,
+                          "useExpirationDate": true,
+                          "useCardHolderName": true,
+                          "useBillingAddress": true
+                        },
+                        "stringId": "2",
+                        "template": "creditCardPaymentGroup-template",
+                        "requiresDocument": false,
+                        "displayDocument": false,
+                        "isCustom": false,
+                        "description": "Payment description",
+                        "requiresAuthentication": false,
+                        "dueDate": "2022-07-19T11:39:36.37197Z",
+                        "availablePayments": null
+                      },
+                      {
+                        "id": 127,
+                        "name": "MercadoPagoPro",
+                        "groupName": "MercadoPagoProPaymentGroup",
+                        "validator": {
+                          "regex": "^4[0-9]{15}$",
+                          "mask": "9999 9999 9999 9999",
+                          "cardCodeRegex": "^[0-9]{3}$",
+                          "cardCodeMask": "999",
+                          "weights": [
+                            2,
+                            1,
+                            2,
+                            1,
+                            2
+                          ],
+                          "useCvv": true,
+                          "useExpirationDate": true,
+                          "useCardHolderName": true,
+                          "useBillingAddress": true
+                        },
+                        "stringId": "127",
+                        "template": "MercadoPagoProPaymentGroup-template",
+                        "requiresDocument": false,
+                        "displayDocument": false,
+                        "isCustom": false,
+                        "description": "Payment description",
+                        "requiresAuthentication": false,
+                        "dueDate": "2022-07-19T11:39:36.37197Z",
+                        "availablePayments": null
+                      }
+                    ],
+                    "payments": [
+                      {
+                        "paymentSystem": 6,
+                        "bin": null,
+                        "accountId": "12",
+                        "tokenId": null,
+                        "value": 34390,
+                        "referenceValue": 34390,
+                        "giftCardRedemptionCode": null,
+                        "giftCardProvider": null,
+                        "giftCardId": null
+                      }
+                    ],
+                    "giftCards": [],
+                    "giftCardMessages": [],
+                    "availableAccounts": [],
+                    "availableTokens": [],
+                    "availableAssociations": {}
+                  },
+                  "selectableGifts": [],
+                  "marketingData": {
+                    "utmSource": "app",
+                    "utmMedium": "CPC",
+                    "utmCampaign": "Black friday",
+                    "utmipage": "true",
+                    "utmiPart": "true",
+                    "utmiCampaign": "true",
+                    "coupon": "blackfriday",
+                    "marketingTags": [
+                      "tag1",
+                      "tag2"
+                    ]
+                  },
+                  "country": "BRA",
+                  "postalCode": "12345-000",
+                  "geoCoordinates": [
+                    -47.924747467041016,
+                    -15.832582473754883
+                  ],
+                  "logisticsInfo": [
+                    {
+                      "itemIndex": 0,
+                      "addressId": "666c2e830bd9474ab6f6cc53fb6dd2d2",
+                      "selectedSla": "Normal",
+                      "selectedDeliveryChannel": "delivery",
+                      "quantity": 1,
+                      "shipsTo": [
+                        "BRA"
+                      ],
+                      "slas": [
+                        {
+                          "id": "Normal",
+                          "deliveryChannel": "delivery",
+                          "name": "Normal",
+                          "deliveryIds": [
+                            {
+                              "courierId": "1",
+                              "warehouseId": "1_1",
+                              "dockId": "1",
+                              "courierName": "Transportadora",
+                              "quantity": 1,
+                              "kitItemDetails": []
+                            }
+                          ],
+                          "shippingEstimate": "3bd",
+                          "shippingEstimateDate": null,
+                          "lockTTL": "10d",
+                          "availableDeliveryWindows": {
+                            "startDateUtc": "2024-03-27T00:00:00+00:00",
+                            "endDateUtc": "2024-03-27T00:00:00+00:00",
+                            "price": 0,
+                            "lisPrice": 0,
+                            "tax": 0
+                          },
+                          "deliveryWindow": {
+                            "startDateUtc": "2014-04-21T09:00:00+00:00",
+                            "endDateUtc": "2014-04-21T12:00:00+00:00",
+                            "price": 0,
+                            "listprice": 1000,
+                            "tax": 0
+                          },
+                          "price": 1500,
+                          "listPrice": 1500,
+                          "tax": 0,
+                          "pickupStoreInfo": {
+                            "isPickupStore": false,
+                            "friendlyName": null,
+                            "address": null,
+                            "additionalInfo": null,
+                            "dockId": null
+                          },
+                          "pickupPointId": null,
+                          "pickupDistance": 0,
+                          "polygonName": null,
+                          "transitTime": "3bd"
+                        }
+                      ],
+                      "deliveryChannels": [
+                        {
+                          "id": "pickup-in-point"
+                        },
+                        {
+                          "id": "delivery"
+                        }
+                      ]
+                    }
+                  ],
+                  "messages": [],
+                  "purchaseConditions": {
+                    "itemPurchaseConditions": [
+                      {
+                        "id": "1",
+                        "seller": "1",
+                        "sellerChain": [
+                          "1"
+                        ],
+                        "slas": [
+                          {
+                            "id": "Normal",
+                            "deliveryChannel": "delivery",
+                            "name": "Normal",
+                            "deliveryIds": [
+                              {
+                                "courierId": "1",
+                                "warehouseId": "1_1",
+                                "dockId": "1",
+                                "courierName": "Transportadora",
+                                "quantity": 1,
+                                "kitItemDetails": []
+                              }
+                            ],
+                            "shippingEstimate": "3bd",
+                            "shippingEstimateDate": null,
+                            "lockTTL": "10d",
+                            "availableDeliveryWindows": {
+                              "startDateUtc": "2024-03-27T00:00:00+00:00",
+                              "endDateUtc": "2024-03-27T00:00:00+00:00",
+                              "price": 0,
+                              "lisPrice": 0,
+                              "tax": 0
+                            },
+                            "deliveryWindow": {
+                              "startDateUtc": "2014-04-21T09:00:00+00:00",
+                              "endDateUtc": "2014-04-21T12:00:00+00:00",
+                              "price": 0,
+                              "listprice": 1000,
+                              "tax": 0
+                            },
+                            "price": 1500,
+                            "listPrice": 1500,
+                            "tax": 0,
+                            "pickupStoreInfo": {
+                              "isPickupStore": false,
+                              "friendlyName": null,
+                              "address": null,
+                              "additionalInfo": null,
+                              "dockId": null
+                            },
+                            "pickupPointId": null,
+                            "pickupDistance": 0,
+                            "polygonName": null,
+                            "transitTime": "3bd"
+                          }
+                        ],
+                        "price": 9999,
+                        "listPrice": 9999
+                      }
+                    ]
+                  },
+                  "pickupPoints": [],
+                  "subscriptionData": null,
+                  "totals": [
+                    {
+                      "id": "Items",
+                      "name": "Total dos Itens",
+                      "value": 2999700
+                    }
+                  ],
+                  "itemMetadata": {
+                    "items": [
+                      {
+                        "id": "1",
+                        "seller": "1",
+                        "assemblyOptions": [
+                          {
+                            "id": "T-Shirt Customization",
+                            "name": "T-Shirt Customization",
+                            "required": false,
+                            "inputValues": {
+                              "T-Shirt Name": {
+                                "maximumNumberOfCharacters": 2,
+                                "domain": [
+                                  "[]"
+                                ]
+                              }
+                            },
+                            "composition": null
+                          }
+                        ]
+                      }
+                    ]
+                  }
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/api/checkout/pub/orderForm": {
+      "get": {
+        "tags": [
+          "Shopping cart"
+        ],
+        "summary": "Get current or create a new cart",
+        "description": "You can use this request to get your current shopping cart information (`orderFormId`) or to create a new cart.\r\n\r\n**Important**: To create a new empty shopping cart you need to send this request with the query param `forceNewCart=true`.\r\n\r\nThe [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.\n\r\n\r> This request has a time out of 45 seconds.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "CreateANewCart",
+        "security": [],
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "forceNewCart",
+            "in": "query",
+            "description": "Use this query parameter to create a new empty shopping cart.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "example": {
+                  "orderFormId": "9ceee0fde6db489fbc682a0e2ab13a86",
+                  "salesChannel": "1",
+                  "loggedIn": false,
+                  "isCheckedIn": false,
+                  "storeId": "1",
+                  "checkedInPickupPointId": "21",
+                  "allowManualPrice": false,
+                  "canEditData": true,
+                  "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
+                  "userType": "User type",
+                  "ignoreProfileData": false,
+                  "value": 0,
+                  "messages": [],
+                  "items": [],
+                  "selectableGifts": [],
+                  "totalizers": [],
+                  "shippingData": null,
+                  "clientProfileData": {
+                    "email": "clark.kent@examplemail.com",
+                    "firstName": "Clark",
+                    "lastName": "Kent",
+                    "document": "12345678900",
+                    "documentType": "cpf",
+                    "phone": "+5500123456789",
+                    "corporateName": "company-name",
+                    "tradeName": "trade-name",
+                    "corporateDocument": "12345678000100",
+                    "stateInscription": "12345678",
+                    "corporatePhone": "551100988887777",
+                    "isCorporate": false,
+                    "profileCompleteOnLoading": false,
+                    "profileErrorOnLoading": false,
+                    "customerClass": null
+                  },
+                  "paymentData": {
+                    "installmentOptions": [],
+                    "paymentSystems": [],
+                    "payments": [
+                      {
+                        "paymentSystem": 6,
+                        "bin": null,
+                        "accountId": "12",
+                        "tokenId": null,
+                        "value": 34390,
+                        "referenceValue": 34390,
+                        "giftCardRedemptionCode": null,
+                        "giftCardProvider": null,
+                        "giftCardId": null
+                      }
+                    ],
+                    "giftCards": [],
+                    "giftCardMessages": [],
+                    "availableAccounts": [],
+                    "availableTokens": []
+                  },
+                  "marketingData": null,
+                  "sellers": [],
+                  "clientPreferencesData": {
+                    "locale": "pt-BR",
+                    "optinNewsLetter": null
+                  },
+                  "commercialConditionData": null,
+                  "storePreferencesData": {
+                    "countryCode": "BRA",
+                    "saveUserData": true,
+                    "timeZone": "E. South America Standard Time",
+                    "currencyCode": "BRL",
+                    "currencyLocale": 1046,
+                    "currencySymbol": "R$",
+                    "currencyFormatInfo": {
+                      "currencyDecimalDigits": 2,
+                      "currencyDecimalSeparator": ",",
+                      "currencyGroupSeparator": ".",
+                      "currencyGroupSize": 3,
+                      "startsWithCurrencySymbol": true
+                    }
+                  },
+                  "giftRegistryData": null,
+                  "openTextField": null,
+                  "invoiceData": null,
+                  "customData": null,
+                  "itemMetadata": {
+                    "items": [
+                      {
+                        "id": "1",
+                        "seller": "1",
+                        "name": "Ração Royal Canin Feline Urinary 500g",
+                        "skuName": "Ração Royal Canin Feline Urinary 500g",
+                        "productId": "1",
+                        "refId": "0001",
+                        "ean": "123456789",
+                        "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
+                        "detailUrl": "/racao-royal-canin-feline-urinary/p",
+                        "assemblyOptions": []
+                      }
+                    ]
+                  },
+                  "hooksData": null,
+                  "ratesAndBenefitsData": {
+                    "rateAndBenefitsIdentifiers": [],
+                    "teaser": []
+                  },
+                  "subscriptionData": null,
+                  "itemsOrdination": {
+                    "criteria": "NAME",
+                    "ascending": true
+                  }
+                },
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "orderFormId": {
+                      "type": "string",
+                      "description": "ID of the orderForm corresponding to a specific cart."
+                    },
+                    "salesChannel": {
+                      "type": "string",
+                      "description": "Attribute created by the seller, in their VTEX store configuration."
+                    },
+                    "loggedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether the user is logged into the store."
+                    },
+                    "isCheckedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether order is checked in."
+                    },
+                    "storeId": {
+                      "type": "string",
+                      "description": "ID of the store.",
+                      "nullable": true
+                    },
+                    "allowManualPrice": {
+                      "type": "boolean",
+                      "description": "Permission to modify item price manually."
+                    },
+                    "canEditData": {
+                      "type": "boolean",
+                      "description": "Data can be edited."
+                    },
+                    "userProfileId": {
+                      "type": "string",
+                      "description": "Unique ID associated with the customer profile."
+                    },
+                    "profileProvider": {
+                      "type": "string",
+                      "description": "Profile provider."
+                    },
+                    "availableAccounts": {
+                      "type": "array",
+                      "description": "Available accounts.",
+                      "items": {
+                        "type": "string",
+                        "description": "Account."
+                      }
+                    },
+                    "availableAddresses": {
+                      "type": "array",
+                      "description": "Information on each available address.",
+                      "items": {
+                        "description": "Address information.",
+                        "type": "object",
+                        "properties": {
+                          "addressType": {
+                            "type": "string",
+                            "description": "Address type."
+                          },
+                          "receiverName": {
+                            "type": "string",
+                            "description": "Name of the receiver."
+                          },
+                          "addressId": {
+                            "type": "string",
+                            "description": "Address ID.",
+                            "nullable": true
+                          },
+                          "isDisposable": {
+                            "type": "boolean",
+                            "description": "Indicates whether address is disposable."
+                          },
+                          "city": {
+                            "type": "string",
+                            "description": "City of the address."
+                          },
+                          "state": {
+                            "type": "string",
+                            "description": "State of the address."
+                          },
+                          "country": {
+                            "type": "string",
+                            "description": "Country of the address. ISO three-letter code."
+                          },
+                          "street": {
+                            "type": "string",
+                            "description": "Street of the address."
+                          },
+                          "number": {
+                            "type": "string",
+                            "description": "Number of the address."
+                          },
+                          "neighborhood": {
+                            "type": "string",
+                            "description": "Neighborhood of the address."
+                          },
+                          "complement": {
+                            "description": "Complement to the shipping address, in case it applies.",
+                            "type": "string",
+                            "nullable": true
+                          },
+                          "reference": {
+                            "type": "string",
+                            "description": "Reference that may help in the location of the address.",
+                            "nullable": true
+                          },
+                          "geoCoordinates": {
+                            "type": "array",
+                            "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                            "items": {
+                              "type": "number",
+                              "description": "Geocoordinates."
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "userType": {
+                      "type": "string",
+                      "description": "User type.",
+                      "nullable": true
+                    },
+                    "ignoreProfileData": {
+                      "type": "boolean",
+                      "description": "Ignore customer profile data."
+                    },
+                    "value": {
+                      "type": "integer",
+                      "description": "Total value of the order without separating cents. For example, $24.99 is represented as `2499`."
+                    },
+                    "messages": {
+                      "type": "array",
+                      "description": "Array containing an object for each message generated by our servers while processing the request.",
+                      "items": {
+                        "type": "string",
+                        "description": "Message."
+                      }
+                    },
+                    "items": {
+                      "type": "array",
+                      "description": "Information on each item in the order.",
+                      "items": {
+                        "description": "Item information.",
+                        "type": "object",
+                        "properties": {
+                          "uniqueId": {
+                            "type": "string",
+                            "description": "Unique ID."
+                          },
+                          "id": {
+                            "type": "string",
+                            "description": "ID of the item."
+                          },
+                          "productId": {
+                            "type": "string",
+                            "description": "Product ID."
+                          },
+                          "productRefId": {
+                            "type": "string",
+                            "description": "Product Ref ID."
+                          },
+                          "refId": {
+                            "type": "string",
+                            "description": "Ref ID."
+                          },
+                          "ean": {
+                            "type": "string",
+                            "description": "European Article Number.",
+                            "nullable": true
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Product name."
+                          },
+                          "skuName": {
+                            "type": "string",
+                            "description": "SKU name."
+                          },
+                          "modalType": {
+                            "type": "string",
+                            "description": "Modal type.",
+                            "nullable": true
+                          },
+                          "parentItemIndex": {
+                            "type": "integer",
+                            "description": "Parent item index.",
+                            "nullable": true
+                          },
+                          "parentAssemblyBinding": {
+                            "type": "string",
+                            "description": "Parent assembly binding.",
+                            "nullable": true
+                          },
+                          "priceValidUntil": {
+                            "type": "string",
+                            "description": "Price expiration date and time."
+                          },
+                          "tax": {
+                            "type": "integer",
+                            "description": "Tax value in cents."
+                          },
+                          "taxCode": {
+                            "type": "string",
+                            "description": "A unique identifier code assigned to a tax within the VTEX Admin."
+                          },
+                          "price": {
+                            "type": "integer",
+                            "description": "Price in cents."
+                          },
+                          "listPrice": {
+                            "type": "integer",
+                            "description": "List price in cents."
+                          },
+                          "manualPrice": {
+                            "type": "integer",
+                            "description": "Manual price in cents.",
+                            "nullable": true
+                          },
+                          "manualPriceAppliedBy": {
+                            "type": "string",
+                            "description": "User that applied the manual price, if that is the case.",
+                            "nullable": true
+                          },
+                          "sellingPrice": {
+                            "type": "integer",
+                            "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
+                          },
+                          "rewardValue": {
+                            "type": "integer",
+                            "description": "Reward value in cents."
+                          },
+                          "isGift": {
+                            "type": "boolean",
+                            "description": "Indicates whether item is a gift."
+                          },
+                          "additionalInfo": {
+                            "type": "object",
+                            "description": "Additional information.",
+                            "properties": {
+                              "dimension": {
+                                "type": "string",
+                                "description": "Dimension.",
+                                "nullable": true
+                              },
+                              "brandName": {
+                                "type": "string",
+                                "description": "Brand name."
+                              },
+                              "brandId": {
+                                "type": "string",
+                                "description": "Brand ID."
+                              },
+                              "offeringInfo": {
+                                "type": "string",
+                                "description": "Offering information.",
+                                "nullable": true
+                              },
+                              "offeringType": {
+                                "type": "string",
+                                "description": "Offering type.",
+                                "nullable": true
+                              },
+                              "offeringTypeId": {
+                                "type": "string",
+                                "description": "Offering type ID.",
+                                "nullable": true
+                              }
+                            }
+                          },
+                          "preSaleDate": {
+                            "type": "string",
+                            "description": "Presale date.",
+                            "nullable": true
+                          },
+                          "productCategoryIds": {
+                            "type": "string",
+                            "description": "Product category IDs."
+                          },
+                          "productCategories": {
+                            "type": "object",
+                            "description": "Object, where each field is an ID from `productCategoryIds`.",
+                            "properties": {
+                              "{ID}": {
+                                "type": "string",
+                                "description": "Product category corresponding to the ID in the field key."
+                              }
+                            }
+                          },
+                          "quantity": {
+                            "type": "integer",
+                            "description": "Quantity."
+                          },
+                          "seller": {
+                            "type": "string",
+                            "description": "Seller."
+                          },
+                          "sellerChain": {
+                            "type": "array",
+                            "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
+                            "items": {
+                              "type": "string",
+                              "description": "Seller."
+                            }
+                          },
+                          "imageUrl": {
+                            "type": "string",
+                            "description": "Image URL."
+                          },
+                          "detailUrl": {
+                            "type": "string",
+                            "description": "Detail URL."
+                          },
+                          "bundleItems": {
+                            "type": "array",
+                            "description": "Information on services sold along with the SKU. Example: a gift package.",
+                            "items": {
+                              "description": "Service information.",
+                              "type": "object",
+                              "properties": {
+                                "type": {
+                                  "type": "string",
+                                  "description": "Service type."
+                                },
+                                "id": {
+                                  "type": "integer",
+                                  "description": "Service identifier."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Service name."
+                                },
+                                "price": {
+                                  "type": "integer",
+                                  "description": "Service price in cents."
+                                }
+                              }
+                            }
+                          },
+                          "attachments": {
+                            "type": "array",
+                            "description": "Array containing information on attachments.",
+                            "items": {
+                              "type": "string",
+                              "description": "Attachment."
+                            }
+                          },
+                          "priceTags": {
+                            "type": "array",
+                            "description": "Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.",
+                            "items": {
+                              "description": "Price tag information.",
+                              "type": "object",
+                              "properties": {
+                                "identifier": {
+                                  "type": "string",
+                                  "description": "Promotion unique identifier.",
+                                  "nullable": true
+                                },
+                                "isPercentual": {
+                                  "type": "boolean",
+                                  "description": "Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\r\n- `type` indicates whether the tag refers to a discount or tax.\r\n- `where` specifies the context, either price or shipping.\r\n- `identifier` is the promotion ID.\r\n- `calculationId` is a hash that may vary with each price calculation."
+                                },
+                                "rawValue": {
+                                  "type": "number",
+                                  "description": "Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations."
+                                },
+                                "value": {
+                                  "type": "integer",
+                                  "description": "Price tag value representing either a promotion (value decrease) or a tax (value increase)."
+                                }
+                              }
+                            }
+                          },
+                          "availability": {
+                            "type": "string",
+                            "description": "Availability."
+                          },
+                          "measurementUnit": {
+                            "type": "string",
+                            "description": "Measurement unit."
+                          },
+                          "unitMultiplier": {
+                            "type": "integer",
+                            "description": "Unit multiplier."
+                          },
+                          "manufacturerCode": {
+                            "type": "string",
+                            "description": "Manufacturer code.",
+                            "nullable": true
+                          },
+                          "priceDefinition": {
+                            "type": "object",
+                            "description": "Price information for all units of a specific item.",
+                            "properties": {
+                              "calculatedSellingPrice": {
+                                "type": "integer",
+                                "description": "Item's calculated unitary selling price in cents."
+                              },
+                              "total": {
+                                "type": "integer",
+                                "description": "Total value for all units of the item in cents."
+                              },
+                              "sellingPrices": {
+                                "type": "array",
+                                "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
+                                "items": {
+                                  "description": "Rounding information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value in cents for that specific rounding."
+                                    },
+                                    "quantity": {
+                                      "type": "integer",
+                                      "description": "Rounding quantity, meaning how many items are rounded to this value."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "selectableGifts": {
+                      "type": "array",
+                      "description": "Array containing the data of the item selected as a gift.",
+                      "items": {
+                        "type": "string",
+                        "description": "Gift."
+                      }
+                    },
+                    "totalizers": {
+                      "type": "array",
+                      "description": "Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).",
+                      "items": {
+                        "type": "object",
+                        "description": "Totalizer of purchases."
+                      }
+                    },
+                    "shippingData": {
+                      "type": "object",
+                      "description": "Shipping information pertinent to the order.",
+                      "nullable": true,
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Address information.",
+                          "nullable": true,
+                          "properties": {
+                            "addressType": {
+                              "type": "string",
+                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                            },
+                            "receiverName": {
+                              "type": "string",
+                              "description": "Name of the person who is going to receive the order."
+                            },
+                            "addressId": {
+                              "type": "string",
+                              "description": "Address ID.",
+                              "nullable": true
+                            },
+                            "isDisposable": {
+                              "type": "boolean",
+                              "description": "Indicates whether address is disposable."
+                            },
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City of the shipping address."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State of the shipping address."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Three letter ISO code of the country of the shipping address."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street of the shipping address."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Number of the building, house or apartment in the shipping address."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood of the shipping address."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Complement to the shipping address, in case it applies.",
+                              "nullable": true
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                              "nullable": true
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                              "items": {
+                                "type": "number",
+                                "description": "Geocoordinates."
+                              }
+                            }
+                          }
+                        },
+                        "logisticsInfo": {
+                          "type": "array",
+                          "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.",
+                          "items": {
+                            "description": "Logistics information.",
+                            "type": "object",
+                            "properties": {
+                              "itemIndex": {
+                                "type": "integer",
+                                "description": "Index corresponding to the position of the object in the `items` array."
+                              },
+                              "selectedSla": {
+                                "type": "string",
+                                "description": "SLA selected by the customer.",
+                                "nullable": true
+                              },
+                              "selectedDeliveryChannel": {
+                                "type": "string",
+                                "description": "Delivery channel selected by the customer.",
+                                "nullable": true
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "slas": {
+                                "type": "array",
+                                "description": "Information on available SLAs.",
+                                "items": {
+                                  "description": "SLA information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "SLA ID."
+                                    },
+                                    "deliveryChannel": {
+                                      "type": "string",
+                                      "description": "Delivery channel."
+                                    },
+                                    "name": {
+                                      "type": "string",
+                                      "description": "SLA name."
+                                    },
+                                    "deliveryIds": {
+                                      "type": "array",
+                                      "description": "Information on each delivery ID.",
+                                      "items": {
+                                        "description": "Delivery ID information.",
+                                        "type": "object",
+                                        "properties": {
+                                          "courierId": {
+                                            "type": "string",
+                                            "description": "Courier ID."
+                                          },
+                                          "warehouseId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "dockId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "courierName": {
+                                            "type": "string",
+                                            "description": "Courier name."
+                                          },
+                                          "quantity": {
+                                            "type": "integer",
+                                            "description": "Quantity."
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "attachmentOfferings": {
+                                      "type": "array",
+                                      "description": "List of attachments details.",
+                                      "nullable": true,
+                                      "items": {
+                                        "description": "Attachment details.",
+                                        "type": "object",
+                                        "required": [
+                                          "name",
+                                          "required",
+                                          "schema"
+                                        ],
+                                        "properties": {
+                                          "name": {
+                                            "type": "string",
+                                            "description": "Name of the attachment.",
+                                            "nullable": true
+                                          },
+                                          "required": {
+                                            "type": "boolean",
+                                            "description": "Defines if the attachment is required (`true`) or not (`false`).",
+                                            "nullable": true
+                                          },
+                                          "schema": {
+                                            "type": "object",
+                                            "description": "Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).",
+                                            "nullable": true
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "shippingEstimate": {
+                                      "type": "string",
+                                      "description": "Shipping estimate. For instance, \"three business days\" will be represented as `3bd`."
+                                    },
+                                    "shippingEstimateDate": {
+                                      "type": "string",
+                                      "description": "When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.",
+                                      "nullable": true
+                                    },
+                                    "useIndividualShippingEstimates": {
+                                      "type": "boolean",
+                                      "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`."
+                                    },
+                                    "lockTTL": {
+                                      "type": "string",
+                                      "description": "Estimate date of delivery.",
+                                      "nullable": true
+                                    },
+                                    "price": {
+                                      "type": "integer",
+                                      "description": "Price in cents."
+                                    },
+                                    "listPrice": {
+                                      "type": "integer",
+                                      "description": "List price in cents."
+                                    },
+                                    "tax": {
+                                      "type": "integer",
+                                      "description": "Tax in cents."
+                                    },
+                                    "pickupStoreInfo": {
+                                      "type": "object",
+                                      "description": "Information on the pickup store.",
+                                      "properties": {
+                                        "isPickupStore": {
+                                          "type": "boolean",
+                                          "description": "Indicates whether it is the pickup store."
+                                        },
+                                        "friendlyName": {
+                                          "type": "string",
+                                          "description": "Friendly name.",
+                                          "nullable": true
+                                        },
+                                        "address": {
+                                          "type": "object",
+                                          "description": "Address information.",
+                                          "nullable": true,
+                                          "properties": {
+                                            "addressType": {
+                                              "type": "string",
+                                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                                            },
+                                            "postalCode": {
+                                              "type": "string",
+                                              "description": "Postal code."
+                                            },
+                                            "city": {
+                                              "type": "string",
+                                              "description": "City of the shipping address."
+                                            },
+                                            "state": {
+                                              "type": "string",
+                                              "description": "State of the shipping address."
+                                            },
+                                            "country": {
+                                              "type": "string",
+                                              "description": "Three letter ISO code of the country of the shipping address."
+                                            },
+                                            "street": {
+                                              "type": "string",
+                                              "description": "Street of the shipping address."
+                                            },
+                                            "number": {
+                                              "type": "string",
+                                              "description": "Number of the building, house or apartment in the shipping address."
+                                            },
+                                            "neighborhood": {
+                                              "type": "string",
+                                              "description": "Neighborhood of the shipping address."
+                                            },
+                                            "complement": {
+                                              "type": "string",
+                                              "description": "Complement to the shipping address, in case it applies.",
+                                              "nullable": true
+                                            },
+                                            "reference": {
+                                              "type": "string",
+                                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                              "nullable": true
+                                            },
+                                            "geoCoordinates": {
+                                              "type": "array",
+                                              "description": "Array with two strings that repesent geocoordinates: first latitude, then longitude.",
+                                              "items": {
+                                                "type": "number",
+                                                "description": "Geocoordinates."
+                                              }
+                                            }
+                                          }
+                                        },
+                                        "additionalInfo": {
+                                          "type": "string",
+                                          "description": "Additional information.",
+                                          "nullable": true
+                                        },
+                                        "dockId": {
+                                          "type": "string",
+                                          "description": "Corresponding dock ID.",
+                                          "nullable": true
+                                        }
+                                      }
+                                    },
+                                    "pickupPointId": {
+                                      "type": "string",
+                                      "description": "Pickup point ID.",
+                                      "nullable": true
+                                    },
+                                    "pickupDistance": {
+                                      "type": "integer",
+                                      "description": "Pickup point distance."
+                                    },
+                                    "polygonName": {
+                                      "type": "string",
+                                      "description": "Polygon name.",
+                                      "nullable": true
+                                    },
+                                    "transitTime": {
+                                      "type": "string",
+                                      "description": "Transit time. For instance, \"three business days\" is represented as `3bd`."
+                                    }
+                                  }
+                                }
+                              },
+                              "shipsTo": {
+                                "type": "array",
+                                "description": "List of countries that the item may be shipped to.",
+                                "items": {
+                                  "type": "string",
+                                  "description": "Three letter country code."
+                                }
+                              },
+                              "itemId": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "deliveryChannels": {
+                                "type": "array",
+                                "description": "List of available delivery channels.",
+                                "items": {
+                                  "description": "Delivery channel information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "Delivery channel ID."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "selectedAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the selected addresses for the order.",
+                          "items": {
+                            "description": "Selected address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "availableAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the available addresses for the order.",
+                          "items": {
+                            "description": "Available address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "clientProfileData": {
+                      "type": "object",
+                      "description": "Customer's profile information.",
+                      "nullable": true,
+                      "properties": {
+                        "email": {
+                          "type": "string",
+                          "description": "Email address.",
+                          "nullable": true
+                        },
+                        "firstName": {
+                          "type": "string",
+                          "description": "First name.",
+                          "nullable": true
+                        },
+                        "lastName": {
+                          "type": "string",
+                          "description": "Last name."
+                        },
+                        "documentType": {
+                          "type": "string",
+                          "description": "Type of the document informed by the customer."
+                        },
+                        "document": {
+                          "type": "string",
+                          "description": "Document informed by the customer."
+                        },
+                        "phone": {
+                          "type": "string",
+                          "description": "Phone number."
+                        },
+                        "corporateName": {
+                          "type": "string",
+                          "description": "Company name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "tradeName": {
+                          "type": "string",
+                          "description": "Trade name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporateDocument": {
+                          "type": "string",
+                          "description": "Corporate document, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "stateInscription": {
+                          "type": "string",
+                          "description": "State inscription, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporatePhone": {
+                          "type": "string",
+                          "description": "Corporate phone number, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "isCorporate": {
+                          "type": "boolean",
+                          "description": "Indicates whether the customer is a legal entity."
+                        },
+                        "profileCompleteOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile is complete on loading."
+                        },
+                        "profileErrorOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile presents error on loading.",
+                          "nullable": true
+                        },
+                        "customerClass": {
+                          "type": "string",
+                          "description": "Customer class.",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "paymentData": {
+                      "type": "object",
+                      "description": "Information on the order's payment.",
+                      "properties": {
+                        "giftCards": {
+                          "type": "array",
+                          "description": "Gift card information, if it applies to the order.",
+                          "items": {
+                            "description": "Gift card information.",
+                            "type": "object",
+                            "properties": {
+                              "redemptionCode": {
+                                "type": "string",
+                                "description": "Gift card redemption code."
+                              },
+                              "value": {
+                                "type": "integer",
+                                "description": "Gift card value in cents."
+                              },
+                              "balance": {
+                                "type": "integer",
+                                "description": "Gift card balance in cents."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Gift card name."
+                              },
+                              "id": {
+                                "type": "string",
+                                "description": "Gift card ID."
+                              },
+                              "inUse": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is in use."
+                              },
+                              "isSpecialCard": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is special."
+                              }
+                            }
+                          }
+                        },
+                        "transactions": {
+                          "type": "array",
+                          "description": "Information on each transaction pertinent to the order.",
+                          "items": {
+                            "description": "Transaction information.",
+                            "nullable": true,
+                            "type": "object",
+                            "properties": {
+                              "isActive": {
+                                "type": "boolean",
+                                "description": "Indicates whether transaction is active."
+                              },
+                              "transactionId": {
+                                "type": "string",
+                                "description": "Transaction ID."
+                              },
+                              "merchantName": {
+                                "type": "string",
+                                "description": "Merchant name."
+                              },
+                              "payments": {
+                                "type": "array",
+                                "description": "Information on each payment.",
+                                "items": {
+                                  "description": "Payment information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "accountId": {
+                                      "type": "string",
+                                      "description": "Account ID."
+                                    },
+                                    "bin": {
+                                      "type": "string",
+                                      "description": "Bin.",
+                                      "nullable": true
+                                    },
+                                    "installments": {
+                                      "type": "integer",
+                                      "description": "Number of installments."
+                                    },
+                                    "paymentSystem": {
+                                      "type": "string",
+                                      "description": "Payment system."
+                                    },
+                                    "referenceValue": {
+                                      "type": "integer",
+                                      "description": "Reference value for calculating interest rates, in case it applies. Displayed in cents."
+                                    },
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value including interest, in case it applies. Displayed in cents."
+                                    }
+                                  }
+                                }
+                              },
+                              "sharedTransaction": {
+                                "type": "boolean",
+                                "description": "Indicates whather transaction is shared."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "marketingData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Object containing promotion data such as coupon tracking information and internal or external UTMs.",
+                      "properties": {
+                        "coupon": {
+                          "type": "string",
+                          "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.",
+                          "example": "free-shipping"
+                        },
+                        "utmSource": {
+                          "type": "string",
+                          "description": "UTM source.",
+                          "example": "Facebook"
+                        },
+                        "utmMedium": {
+                          "type": "string",
+                          "description": "UTM medium.",
+                          "example": "CPC"
+                        },
+                        "utmCampaign": {
+                          "type": "string",
+                          "description": "UTM campaign.",
+                          "example": "Black friday"
+                        },
+                        "utmiPage": {
+                          "type": "string",
+                          "description": "utmi_page (internal utm).",
+                          "example": "utmi_page-example",
+                          "nullable": true
+                        },
+                        "utmiPart": {
+                          "type": "string",
+                          "description": "utmi_part (internal utm).",
+                          "example": "utmi_part-example",
+                          "nullable": true
+                        },
+                        "utmiCampaign": {
+                          "type": "string",
+                          "description": "utmi_campaign (internal utm).",
+                          "example": "utmi_campaign-example",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "sellers": {
+                      "type": "array",
+                      "description": "Information on each seller.",
+                      "items": {
+                        "description": "Seller information.",
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "Seller ID."
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Seller name."
+                          },
+                          "logo": {
+                            "type": "string",
+                            "description": "Seller logo.",
+                            "nullable": true
+                          }
+                        }
+                      }
+                    },
+                    "clientPreferencesData": {
+                      "type": "object",
+                      "description": "Object containing preferences from the client who placed the order.",
+                      "properties": {
+                        "locale": {
+                          "type": "string",
+                          "description": "Client's locale. Examples: `pt-BR` and `en-US`."
+                        },
+                        "optinNewsLetter": {
+                          "type": "boolean",
+                          "description": "`true` if the client opted to receive newsletter from the store.",
+                          "example": false,
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "commercialConditionData": {
+                      "type": "object",
+                      "description": "Object containing commercial condition information.",
+                      "nullable": true
+                    },
+                    "storePreferencesData": {
+                      "type": "object",
+                      "description": "Object containing data from the store's configuration (stored in VTEX's License Manager)."
+                    },
+                    "giftRegistryData": {
+                      "type": "object",
+                      "description": "Gift registry list information.",
+                      "nullable": true
+                    },
+                    "openTextField": {
+                      "type": "string",
+                      "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).",
+                      "example": "open-text-example",
+                      "nullable": true
+                    },
+                    "invoiceData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Invoice data including billing address.",
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Billing address.",
+                          "properties": {
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City name."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State name."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Country."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street name."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Street number."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Address complement."
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Reference for location."
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Geographic coordinates (latitude, longitude).",
+                              "items": {
+                                "type": "number"
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "customData": {
+                      "type": "object",
+                      "description": "Customer additional information.",
+                      "nullable": true
+                    },
+                    "itemMetadata": {
+                      "type": "object",
+                      "description": "Item metadata.",
+                      "properties": {
+                        "items": {
+                          "type": "array",
+                          "description": "List of objects containing metadata on each item in the order.",
+                          "items": {
+                            "description": "Item metadata.",
+                            "type": "object",
+                            "properties": {
+                              "id": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "seller": {
+                                "type": "string",
+                                "description": "Seller."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Product name."
+                              },
+                              "skuName": {
+                                "type": "string",
+                                "description": "SKU name."
+                              },
+                              "productId": {
+                                "type": "string",
+                                "description": "Product ID."
+                              },
+                              "refId": {
+                                "type": "string",
+                                "description": "Ref ID."
+                              },
+                              "ean": {
+                                "type": "string",
+                                "description": "European Article Number.",
+                                "nullable": true
+                              },
+                              "imageUrl": {
+                                "type": "string",
+                                "description": "Image URL."
+                              },
+                              "detailUrl": {
+                                "type": "string",
+                                "description": "Detail URL."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "hooksData": {
+                      "type": "object",
+                      "description": "Hooks information.",
+                      "nullable": true
+                    },
+                    "ratesAndBenefitsData": {
+                      "type": "object",
+                      "description": "Information on rates and benefits that apply to the order.",
+                      "properties": {
+                        "rateAndBenefitsIdentifiers": {
+                          "type": "array",
+                          "description": "List with rates and benefits identifiers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit identifier."
+                          }
+                        },
+                        "teaser": {
+                          "type": "array",
+                          "description": "List with rates and benefits teasers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit teaser."
+                          }
+                        }
+                      }
+                    },
+                    "subscriptionData": {
+                      "type": "object",
+                      "description": "Subscription information.",
+                      "nullable": true
+                    },
+                    "itemsOrdination": {
+                      "type": "object",
+                      "description": "Object containing information about the ordering of items within the `orderForm`.",
+                      "properties": {
+                        "criteria": {
+                          "type": "string",
+                          "description": "Criteria adopted to order the items in the list."
+                        },
+                        "ascending": {
+                          "type": "boolean",
+                          "description": "Indicates whether the ordering is ascending."
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/api/checkout/pub/orderForm/{orderFormId}": {
+      "get": {
+        "tags": [
+          "Shopping cart"
+        ],
+        "summary": "Get cart information by ID",
+        "description": "Retrieves all information associated to a given shopping  cart.\r\n\r\nThe [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.\n\r\n\r> This request has a time out of 45 seconds.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | Checkout | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "GetCartInformationById",
+        "security": [],
+        "parameters": [
+          {
+            "name": "orderFormId",
+            "in": "path",
+            "description": "ID of the orderForm corresponding to the cart whose information you want to retrieve.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "ede846222cd44046ba6c638442c3505a"
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "refreshOutdatedData",
+            "in": "query",
+            "description": "It is possible to use the [Update cart items request](https://developers.vtex.com/vtex-rest-api/reference/cart-update#itemsupdate) so as to allow outdated information in the `orderForm`, which may improve performance in some cases. To guarantee that all cart information is updated, send this request with this parameter as `true`. We recommend doing this in the final stages of the shopping experience, starting from the checkout page.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "example": {
+                  "orderFormId": "ede846222cd44046ba6c638442c3505a",
+                  "salesChannel": "1",
+                  "loggedIn": false,
+                  "isCheckedIn": false,
+                  "storeId": "1",
+                  "checkedInPickupPointId": "21",
+                  "allowManualPrice": false,
+                  "canEditData": true,
+                  "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
+                  "userType": "User type",
+                  "ignoreProfileData": false,
+                  "value": 15000,
+                  "messages": [],
+                  "items": [
+                    {
+                      "uniqueId": "E0F2B7AF5CD74D668F1E27537206912C",
+                      "id": "1",
+                      "productId": "1",
+                      "productRefId": "1",
+                      "refId": "0001",
+                      "ean": "123456789",
+                      "name": "Ração Royal Canin Feline Urinary 500g",
+                      "skuName": "Ração Royal Canin Feline Urinary 500g",
+                      "modalType": null,
+                      "parentItemIndex": null,
+                      "parentAssemblyBinding": null,
+                      "assemblies": [],
+                      "priceValidUntil": "2021-02-27T14:59:00.8288784Z",
+                      "tax": 0,
+                      "taxCode": "54WC8ZN6K8",
+                      "price": 15000,
+                      "listPrice": 30000,
+                      "manualPrice": null,
+                      "sellingPrice": 15000,
+                      "rewardValue": 0,
+                      "isGift": false,
+                      "additionalInfo": {
+                        "brandName": "Royal Canin",
+                        "brandId": "2000000",
+                        "offeringInfo": null,
+                        "offeringType": null,
+                        "offeringTypeId": null
+                      },
+                      "preSaleDate": null,
+                      "productCategoryIds": "/1/10/",
+                      "productCategories": {
+                        "1": "Alimentação",
+                        "10": "Ração Seca"
+                      },
+                      "quantity": 1,
+                      "seller": "1",
+                      "sellerChain": [
+                        "1"
+                      ],
+                      "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
+                      "detailUrl": "/racao-royal-canin-feline-urinary/p",
+                      "components": [],
+                      "bundleItems": [],
+                      "attachments": [],
+                      "attachmentOfferings": [
+                        {
+                          "name": "vtex.subscription.weekly",
+                          "required": false,
+                          "schema": {
+                            "vtex.subscription.key.frequency": {
+                              "MaximumNumberOfCharacters": 7,
+                              "Domain": [
+                                "1 week",
+                                "2 week",
+                                "3 week",
+                                "4 week"
+                              ]
+                            }
+                          }
+                        },
+                        {
+                          "name": "vtex.subscription.daily",
+                          "required": false,
+                          "schema": {
+                            "vtex.subscription.key.frequency": {
+                              "MaximumNumberOfCharacters": 5,
+                              "Domain": [
+                                "1 day"
+                              ]
+                            }
+                          }
+                        }
+                      ],
+                      "offerings": [],
+                      "priceTags": [
+                        {
+                          "name": "DISCOUNT@MANUALPRICE",
+                          "value": -5000,
+                          "rawValue": -50,
+                          "isPercentual": false,
+                          "identifier": "1234abc-5678b-1234c"
+                        }
+                      ],
+                      "availability": "available",
+                      "measurementUnit": "un",
+                      "unitMultiplier": 1,
+                      "manufacturerCode": null
+                    }
+                  ],
+                  "selectableGifts": [],
+                  "totalizers": [
+                    {
+                      "id": "Items",
+                      "name": "Total dos Itens",
+                      "value": 15000
+                    }
+                  ],
+                  "shippingData": {
+                    "address": null,
+                    "logisticsInfo": [
+                      {
+                        "itemIndex": 0,
+                        "selectedSla": "Normal",
+                        "selectedDeliveryChannel": "delivery",
+                        "addressId": "666c2e830bd9474ab6f6cc53fb6dd2d2",
+                        "slas": [],
+                        "shipsTo": [
+                          "BRA"
+                        ],
+                        "itemId": "1",
+                        "deliveryChannels": [
+                          {
+                            "id": "pickup-in-point"
+                          },
+                          {
+                            "id": "delivery"
+                          }
+                        ]
+                      }
+                    ],
+                    "selectedAddresses": [],
+                    "availableAddresses": [],
+                    "pickupPoints": []
+                  },
+                  "clientProfileData": {
+                    "email": "clark.kent@examplemail.com",
+                    "firstName": "Clark",
+                    "lastName": "Kent",
+                    "document": "12345678900",
+                    "documentType": "cpf",
+                    "phone": "+5500123456789",
+                    "corporateName": "company-name",
+                    "tradeName": "trade-name",
+                    "corporateDocument": "12345678000100",
+                    "stateInscription": "12345678",
+                    "corporatePhone": "551100988887777",
+                    "isCorporate": false,
+                    "profileCompleteOnLoading": false,
+                    "profileErrorOnLoading": false,
+                    "customerClass": null
+                  },
+                  "paymentData": {
+                    "installmentOptions": [
+                      {
+                        "paymentSystem": 2,
+                        "bin": null,
+                        "paymentName": null,
+                        "paymentGroupName": null,
+                        "value": 15000,
+                        "installments": [
+                          {
+                            "count": 1,
+                            "hasInterestRate": false,
+                            "interestRate": 0,
+                            "value": 15000,
+                            "total": 15000,
+                            "sellerMerchantInstallments": [
+                              {
+                                "id": "LOJADOBRENO",
+                                "count": 1,
+                                "hasInterestRate": false,
+                                "interestRate": 0,
+                                "value": 15000,
+                                "total": 15000
+                              }
+                            ]
+                          },
+                          {
+                            "count": 2,
+                            "hasInterestRate": false,
+                            "interestRate": 0,
+                            "value": 7500,
+                            "total": 15000,
+                            "sellerMerchantInstallments": [
+                              {
+                                "id": "LOJADOBRENO",
+                                "count": 2,
+                                "hasInterestRate": false,
+                                "interestRate": 0,
+                                "value": 7500,
+                                "total": 15000
+                              }
+                            ]
+                          }
+                        ]
+                      }
+                    ],
+                    "paymentSystems": [
+                      {
+                        "id": 2,
+                        "name": "Visa",
+                        "groupName": "creditCardPaymentGroup",
+                        "validator": {
+                          "regex": "^2[1-8]{17}$",
+                          "mask": "9999 9999 9999 9999",
+                          "cardCodeRegex": "^[0-3]{8}$",
+                          "cardCodeMask": "999",
+                          "weights": [
+                            2,
+                            1,
+                            2,
+                            1,
+                            2,
+                            1
+                          ],
+                          "useCvv": true,
+                          "useExpirationDate": true,
+                          "useCardHolderName": true,
+                          "useBillingAddress": true
+                        },
+                        "stringId": "2",
+                        "template": "creditCardPaymentGroup-template",
+                        "requiresDocument": false,
+                        "isCustom": false,
+                        "description": "Payment description",
+                        "requiresAuthentication": false,
+                        "dueDate": "2020-03-05T14:59:00.7879306Z",
+                        "availablePayments": null
+                      }
+                    ],
+                    "payments": [
+                      {
+                        "paymentSystem": 6,
+                        "bin": null,
+                        "accountId": "12",
+                        "tokenId": null,
+                        "value": 34390,
+                        "referenceValue": 34390,
+                        "giftCardRedemptionCode": null,
+                        "giftCardProvider": null,
+                        "giftCardId": null
+                      }
+                    ],
+                    "giftCards": [],
+                    "giftCardMessages": [],
+                    "availableAccounts": [],
+                    "availableTokens": []
+                  },
+                  "marketingData": null,
+                  "sellers": [
+                    {
+                      "id": "1",
+                      "name": "lojadobreno",
+                      "logo": "Logo"
+                    }
+                  ],
+                  "clientPreferencesData": {
+                    "locale": "pt-BR",
+                    "optinNewsLetter": null
+                  },
+                  "commercialConditionData": null,
+                  "storePreferencesData": {
+                    "countryCode": "BRA",
+                    "saveUserData": true,
+                    "timeZone": "E. South America Standard Time",
+                    "currencyCode": "BRL",
+                    "currencyLocale": 1046,
+                    "currencySymbol": "R$",
+                    "currencyFormatInfo": {
+                      "currencyDecimalDigits": 2,
+                      "currencyDecimalSeparator": ",",
+                      "currencyGroupSeparator": ".",
+                      "currencyGroupSize": 3,
+                      "startsWithCurrencySymbol": true
+                    }
+                  },
+                  "giftRegistryData": null,
+                  "openTextField": null,
+                  "invoiceData": null,
+                  "customData": null,
+                  "itemMetadata": {
+                    "items": [
+                      {
+                        "id": "1",
+                        "seller": "1",
+                        "name": "Ração Royal Canin Feline Urinary 500g",
+                        "skuName": "Ração Royal Canin Feline Urinary 500g",
+                        "productId": "1",
+                        "refId": "0001",
+                        "ean": "123456789",
+                        "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
+                        "detailUrl": "/racao-royal-canin-feline-urinary/p",
+                        "assemblyOptions": []
+                      }
+                    ]
+                  },
+                  "hooksData": null,
+                  "ratesAndBenefitsData": {
+                    "rateAndBenefitsIdentifiers": [],
+                    "teaser": []
+                  },
+                  "subscriptionData": null,
+                  "itemsOrdination": {
+                    "criteria": "NAME",
+                    "ascending": true
+                  }
+                },
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "orderFormId": {
+                      "type": "string",
+                      "description": "ID of the orderForm corresponding to a specific cart."
+                    },
+                    "salesChannel": {
+                      "type": "string",
+                      "description": "Attribute created by the seller, in their VTEX store configuration."
+                    },
+                    "loggedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether the user is logged into the store."
+                    },
+                    "isCheckedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether order is checked in."
+                    },
+                    "storeId": {
+                      "type": "string",
+                      "description": "ID of the store.",
+                      "nullable": true
+                    },
+                    "allowManualPrice": {
+                      "type": "boolean",
+                      "description": "Permission to modify item price manually."
+                    },
+                    "canEditData": {
+                      "type": "boolean",
+                      "description": "Data can be edited."
+                    },
+                    "userProfileId": {
+                      "type": "string",
+                      "description": "Unique ID associated with the customer profile."
+                    },
+                    "profileProvider": {
+                      "type": "string",
+                      "description": "Profile provider."
+                    },
+                    "availableAccounts": {
+                      "type": "array",
+                      "description": "Available accounts.",
+                      "items": {
+                        "type": "string",
+                        "description": "Account."
+                      }
+                    },
+                    "availableAddresses": {
+                      "type": "array",
+                      "description": "Information on each available address.",
+                      "items": {
+                        "description": "Address information.",
+                        "type": "object",
+                        "properties": {
+                          "addressType": {
+                            "type": "string",
+                            "description": "Address type."
+                          },
+                          "receiverName": {
+                            "type": "string",
+                            "description": "Name of the receiver."
+                          },
+                          "addressId": {
+                            "type": "string",
+                            "description": "Address ID.",
+                            "nullable": true
+                          },
+                          "isDisposable": {
+                            "type": "boolean",
+                            "description": "Indicates whether address is disposable."
+                          },
+                          "city": {
+                            "type": "string",
+                            "description": "City of the address."
+                          },
+                          "state": {
+                            "type": "string",
+                            "description": "State of the address."
+                          },
+                          "country": {
+                            "type": "string",
+                            "description": "Country of the address. ISO three-letter code."
+                          },
+                          "street": {
+                            "type": "string",
+                            "description": "Street of the address."
+                          },
+                          "number": {
+                            "type": "string",
+                            "description": "Number of the address."
+                          },
+                          "neighborhood": {
+                            "type": "string",
+                            "description": "Neighborhood of the address."
+                          },
+                          "complement": {
+                            "description": "Complement to the shipping address, in case it applies.",
+                            "type": "string",
+                            "nullable": true
+                          },
+                          "reference": {
+                            "type": "string",
+                            "description": "Reference that may help in the location of the address.",
+                            "nullable": true
+                          },
+                          "geoCoordinates": {
+                            "type": "array",
+                            "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                            "items": {
+                              "type": "number",
+                              "description": "Geocoordinates."
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "userType": {
+                      "type": "string",
+                      "description": "User type.",
+                      "nullable": true
+                    },
+                    "ignoreProfileData": {
+                      "type": "boolean",
+                      "description": "Ignore customer profile data."
+                    },
+                    "value": {
+                      "type": "integer",
+                      "description": "Total value of the order without separating cents. For example, $24.99 is represented as `2499`."
+                    },
+                    "messages": {
+                      "type": "array",
+                      "description": "Array containing an object for each message generated by our servers while processing the request.",
+                      "items": {
+                        "type": "string",
+                        "description": "Message."
+                      }
+                    },
+                    "items": {
+                      "type": "array",
+                      "description": "Information on each item in the order.",
+                      "items": {
+                        "description": "Item information.",
+                        "type": "object",
+                        "properties": {
+                          "uniqueId": {
+                            "type": "string",
+                            "description": "Unique ID."
+                          },
+                          "id": {
+                            "type": "string",
+                            "description": "ID of the item."
+                          },
+                          "productId": {
+                            "type": "string",
+                            "description": "Product ID."
+                          },
+                          "productRefId": {
+                            "type": "string",
+                            "description": "Product Ref ID."
+                          },
+                          "refId": {
+                            "type": "string",
+                            "description": "Ref ID."
+                          },
+                          "ean": {
+                            "type": "string",
+                            "description": "European Article Number.",
+                            "nullable": true
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Product name."
+                          },
+                          "skuName": {
+                            "type": "string",
+                            "description": "SKU name."
+                          },
+                          "modalType": {
+                            "type": "string",
+                            "description": "Modal type.",
+                            "nullable": true
+                          },
+                          "parentItemIndex": {
+                            "type": "integer",
+                            "description": "Parent item index.",
+                            "nullable": true
+                          },
+                          "parentAssemblyBinding": {
+                            "type": "string",
+                            "description": "Parent assembly binding.",
+                            "nullable": true
+                          },
+                          "priceValidUntil": {
+                            "type": "string",
+                            "description": "Price expiration date and time."
+                          },
+                          "tax": {
+                            "type": "integer",
+                            "description": "Tax value in cents."
+                          },
+                          "taxCode": {
+                            "type": "string",
+                            "description": "A unique identifier code assigned to a tax within the VTEX Admin."
+                          },
+                          "price": {
+                            "type": "integer",
+                            "description": "Price in cents."
+                          },
+                          "listPrice": {
+                            "type": "integer",
+                            "description": "List price in cents."
+                          },
+                          "manualPrice": {
+                            "type": "integer",
+                            "description": "Manual price in cents.",
+                            "nullable": true
+                          },
+                          "manualPriceAppliedBy": {
+                            "type": "string",
+                            "description": "User that applied the manual price, if that is the case.",
+                            "nullable": true
+                          },
+                          "sellingPrice": {
+                            "type": "integer",
+                            "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
+                          },
+                          "rewardValue": {
+                            "type": "integer",
+                            "description": "Reward value in cents."
+                          },
+                          "isGift": {
+                            "type": "boolean",
+                            "description": "Indicates whether item is a gift."
+                          },
+                          "additionalInfo": {
+                            "type": "object",
+                            "description": "Additional information.",
+                            "properties": {
+                              "dimension": {
+                                "type": "string",
+                                "description": "Dimension.",
+                                "nullable": true
+                              },
+                              "brandName": {
+                                "type": "string",
+                                "description": "Brand name."
+                              },
+                              "brandId": {
+                                "type": "string",
+                                "description": "Brand ID."
+                              },
+                              "offeringInfo": {
+                                "type": "string",
+                                "description": "Offering information.",
+                                "nullable": true
+                              },
+                              "offeringType": {
+                                "type": "string",
+                                "description": "Offering type.",
+                                "nullable": true
+                              },
+                              "offeringTypeId": {
+                                "type": "string",
+                                "description": "Offering type ID.",
+                                "nullable": true
+                              }
+                            }
+                          },
+                          "preSaleDate": {
+                            "type": "string",
+                            "description": "Presale date.",
+                            "nullable": true
+                          },
+                          "productCategoryIds": {
+                            "type": "string",
+                            "description": "Product category IDs."
+                          },
+                          "productCategories": {
+                            "type": "object",
+                            "description": "Object, where each field is an ID from `productCategoryIds`.",
+                            "properties": {
+                              "{ID}": {
+                                "type": "string",
+                                "description": "Product category corresponding to the ID in the field key."
+                              }
+                            }
+                          },
+                          "quantity": {
+                            "type": "integer",
+                            "description": "Quantity."
+                          },
+                          "seller": {
+                            "type": "string",
+                            "description": "Seller."
+                          },
+                          "sellerChain": {
+                            "type": "array",
+                            "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
+                            "items": {
+                              "type": "string",
+                              "description": "Seller."
+                            }
+                          },
+                          "imageUrl": {
+                            "type": "string",
+                            "description": "Image URL."
+                          },
+                          "detailUrl": {
+                            "type": "string",
+                            "description": "Detail URL."
+                          },
+                          "bundleItems": {
+                            "type": "array",
+                            "description": "Information on services sold along with the SKU. Example: a gift package.",
+                            "items": {
+                              "description": "Service information.",
+                              "type": "object",
+                              "properties": {
+                                "type": {
+                                  "type": "string",
+                                  "description": "Service type."
+                                },
+                                "id": {
+                                  "type": "integer",
+                                  "description": "Service identifier."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Service name."
+                                },
+                                "price": {
+                                  "type": "integer",
+                                  "description": "Service price in cents."
+                                }
+                              }
+                            }
+                          },
+                          "attachments": {
+                            "type": "array",
+                            "description": "Array containing information on attachments.",
+                            "items": {
+                              "type": "string",
+                              "description": "Attachment."
+                            }
+                          },
+                          "priceTags": {
+                            "type": "array",
+                            "description": "Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.",
+                            "items": {
+                              "description": "Price tag information.",
+                              "type": "object",
+                              "properties": {
+                                "identifier": {
+                                  "type": "string",
+                                  "description": "Promotion unique identifier.",
+                                  "nullable": true
+                                },
+                                "isPercentual": {
+                                  "type": "boolean",
+                                  "description": "Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\r\n- `type` indicates whether the tag refers to a discount or tax.\r\n- `where` specifies the context, either price or shipping.\r\n- `identifier` is the promotion ID.\r\n- `calculationId` is a hash that may vary with each price calculation."
+                                },
+                                "rawValue": {
+                                  "type": "number",
+                                  "description": "Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations."
+                                },
+                                "value": {
+                                  "type": "integer",
+                                  "description": "Price tag value representing either a promotion (value decrease) or a tax (value increase)."
+                                }
+                              }
+                            }
+                          },
+                          "availability": {
+                            "type": "string",
+                            "description": "Availability."
+                          },
+                          "measurementUnit": {
+                            "type": "string",
+                            "description": "Measurement unit."
+                          },
+                          "unitMultiplier": {
+                            "type": "integer",
+                            "description": "Unit multiplier."
+                          },
+                          "manufacturerCode": {
+                            "type": "string",
+                            "description": "Manufacturer code.",
+                            "nullable": true
+                          },
+                          "priceDefinition": {
+                            "type": "object",
+                            "description": "Price information for all units of a specific item.",
+                            "properties": {
+                              "calculatedSellingPrice": {
+                                "type": "integer",
+                                "description": "Item's calculated unitary selling price in cents."
+                              },
+                              "total": {
+                                "type": "integer",
+                                "description": "Total value for all units of the item in cents."
+                              },
+                              "sellingPrices": {
+                                "type": "array",
+                                "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
+                                "items": {
+                                  "description": "Rounding information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value in cents for that specific rounding."
+                                    },
+                                    "quantity": {
+                                      "type": "integer",
+                                      "description": "Rounding quantity, meaning how many items are rounded to this value."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "selectableGifts": {
+                      "type": "array",
+                      "description": "Array containing the data of the item selected as a gift.",
+                      "items": {
+                        "type": "string",
+                        "description": "Gift."
+                      }
+                    },
+                    "totalizers": {
+                      "type": "array",
+                      "description": "Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).",
+                      "items": {
+                        "type": "object",
+                        "description": "Totalizer of purchases."
+                      }
+                    },
+                    "shippingData": {
+                      "type": "object",
+                      "description": "Shipping information pertinent to the order.",
+                      "nullable": true,
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Address information.",
+                          "nullable": true,
+                          "properties": {
+                            "addressType": {
+                              "type": "string",
+                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                            },
+                            "receiverName": {
+                              "type": "string",
+                              "description": "Name of the person who is going to receive the order."
+                            },
+                            "addressId": {
+                              "type": "string",
+                              "description": "Address ID.",
+                              "nullable": true
+                            },
+                            "isDisposable": {
+                              "type": "boolean",
+                              "description": "Indicates whether address is disposable."
+                            },
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City of the shipping address."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State of the shipping address."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Three letter ISO code of the country of the shipping address."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street of the shipping address."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Number of the building, house or apartment in the shipping address."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood of the shipping address."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Complement to the shipping address, in case it applies.",
+                              "nullable": true
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                              "nullable": true
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                              "items": {
+                                "type": "number",
+                                "description": "Geocoordinates."
+                              }
+                            }
+                          }
+                        },
+                        "logisticsInfo": {
+                          "type": "array",
+                          "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.",
+                          "items": {
+                            "description": "Logistics information.",
+                            "type": "object",
+                            "properties": {
+                              "itemIndex": {
+                                "type": "integer",
+                                "description": "Index corresponding to the position of the object in the `items` array."
+                              },
+                              "selectedSla": {
+                                "type": "string",
+                                "description": "SLA selected by the customer.",
+                                "nullable": true
+                              },
+                              "selectedDeliveryChannel": {
+                                "type": "string",
+                                "description": "Delivery channel selected by the customer.",
+                                "nullable": true
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "slas": {
+                                "type": "array",
+                                "description": "Information on available SLAs.",
+                                "items": {
+                                  "description": "SLA information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "SLA ID."
+                                    },
+                                    "deliveryChannel": {
+                                      "type": "string",
+                                      "description": "Delivery channel."
+                                    },
+                                    "name": {
+                                      "type": "string",
+                                      "description": "SLA name."
+                                    },
+                                    "deliveryIds": {
+                                      "type": "array",
+                                      "description": "Information on each delivery ID.",
+                                      "items": {
+                                        "description": "Delivery ID information.",
+                                        "type": "object",
+                                        "properties": {
+                                          "courierId": {
+                                            "type": "string",
+                                            "description": "Courier ID."
+                                          },
+                                          "warehouseId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "dockId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "courierName": {
+                                            "type": "string",
+                                            "description": "Courier name."
+                                          },
+                                          "quantity": {
+                                            "type": "integer",
+                                            "description": "Quantity."
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "attachmentOfferings": {
+                                      "type": "array",
+                                      "description": "List of attachments details.",
+                                      "nullable": true,
+                                      "items": {
+                                        "description": "Attachment details.",
+                                        "type": "object",
+                                        "required": [
+                                          "name",
+                                          "required",
+                                          "schema"
+                                        ],
+                                        "properties": {
+                                          "name": {
+                                            "type": "string",
+                                            "description": "Name of the attachment.",
+                                            "nullable": true
+                                          },
+                                          "required": {
+                                            "type": "boolean",
+                                            "description": "Defines if the attachment is required (`true`) or not (`false`).",
+                                            "nullable": true
+                                          },
+                                          "schema": {
+                                            "type": "object",
+                                            "description": "Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).",
+                                            "nullable": true
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "shippingEstimate": {
+                                      "type": "string",
+                                      "description": "Shipping estimate. For instance, \"three business days\" will be represented as `3bd`."
+                                    },
+                                    "shippingEstimateDate": {
+                                      "type": "string",
+                                      "description": "When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.",
+                                      "nullable": true
+                                    },
+                                    "useIndividualShippingEstimates": {
+                                      "type": "boolean",
+                                      "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`."
+                                    },
+                                    "lockTTL": {
+                                      "type": "string",
+                                      "description": "Estimate date of delivery.",
+                                      "nullable": true
+                                    },
+                                    "price": {
+                                      "type": "integer",
+                                      "description": "Price in cents."
+                                    },
+                                    "listPrice": {
+                                      "type": "integer",
+                                      "description": "List price in cents."
+                                    },
+                                    "tax": {
+                                      "type": "integer",
+                                      "description": "Tax in cents."
+                                    },
+                                    "pickupStoreInfo": {
+                                      "type": "object",
+                                      "description": "Information on the pickup store.",
+                                      "properties": {
+                                        "isPickupStore": {
+                                          "type": "boolean",
+                                          "description": "Indicates whether it is the pickup store."
+                                        },
+                                        "friendlyName": {
+                                          "type": "string",
+                                          "description": "Friendly name.",
+                                          "nullable": true
+                                        },
+                                        "address": {
+                                          "type": "object",
+                                          "description": "Address information.",
+                                          "nullable": true,
+                                          "properties": {
+                                            "addressType": {
+                                              "type": "string",
+                                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                                            },
+                                            "postalCode": {
+                                              "type": "string",
+                                              "description": "Postal code."
+                                            },
+                                            "city": {
+                                              "type": "string",
+                                              "description": "City of the shipping address."
+                                            },
+                                            "state": {
+                                              "type": "string",
+                                              "description": "State of the shipping address."
+                                            },
+                                            "country": {
+                                              "type": "string",
+                                              "description": "Three letter ISO code of the country of the shipping address."
+                                            },
+                                            "street": {
+                                              "type": "string",
+                                              "description": "Street of the shipping address."
+                                            },
+                                            "number": {
+                                              "type": "string",
+                                              "description": "Number of the building, house or apartment in the shipping address."
+                                            },
+                                            "neighborhood": {
+                                              "type": "string",
+                                              "description": "Neighborhood of the shipping address."
+                                            },
+                                            "complement": {
+                                              "type": "string",
+                                              "description": "Complement to the shipping address, in case it applies.",
+                                              "nullable": true
+                                            },
+                                            "reference": {
+                                              "type": "string",
+                                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                              "nullable": true
+                                            },
+                                            "geoCoordinates": {
+                                              "type": "array",
+                                              "description": "Array with two strings that repesent geocoordinates: first latitude, then longitude.",
+                                              "items": {
+                                                "type": "number",
+                                                "description": "Geocoordinates."
+                                              }
+                                            }
+                                          }
+                                        },
+                                        "additionalInfo": {
+                                          "type": "string",
+                                          "description": "Additional information.",
+                                          "nullable": true
+                                        },
+                                        "dockId": {
+                                          "type": "string",
+                                          "description": "Corresponding dock ID.",
+                                          "nullable": true
+                                        }
+                                      }
+                                    },
+                                    "pickupPointId": {
+                                      "type": "string",
+                                      "description": "Pickup point ID.",
+                                      "nullable": true
+                                    },
+                                    "pickupDistance": {
+                                      "type": "integer",
+                                      "description": "Pickup point distance."
+                                    },
+                                    "polygonName": {
+                                      "type": "string",
+                                      "description": "Polygon name.",
+                                      "nullable": true
+                                    },
+                                    "transitTime": {
+                                      "type": "string",
+                                      "description": "Transit time. For instance, \"three business days\" is represented as `3bd`."
+                                    }
+                                  }
+                                }
+                              },
+                              "shipsTo": {
+                                "type": "array",
+                                "description": "List of countries that the item may be shipped to.",
+                                "items": {
+                                  "type": "string",
+                                  "description": "Three letter country code."
+                                }
+                              },
+                              "itemId": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "deliveryChannels": {
+                                "type": "array",
+                                "description": "List of available delivery channels.",
+                                "items": {
+                                  "description": "Delivery channel information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "Delivery channel ID."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "selectedAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the selected addresses for the order.",
+                          "items": {
+                            "description": "Selected address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "availableAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the available addresses for the order.",
+                          "items": {
+                            "description": "Available address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "clientProfileData": {
+                      "type": "object",
+                      "description": "Customer's profile information.",
+                      "nullable": true,
+                      "properties": {
+                        "email": {
+                          "type": "string",
+                          "description": "Email address.",
+                          "nullable": true
+                        },
+                        "firstName": {
+                          "type": "string",
+                          "description": "First name.",
+                          "nullable": true
+                        },
+                        "lastName": {
+                          "type": "string",
+                          "description": "Last name."
+                        },
+                        "documentType": {
+                          "type": "string",
+                          "description": "Type of the document informed by the customer."
+                        },
+                        "document": {
+                          "type": "string",
+                          "description": "Document informed by the customer."
+                        },
+                        "phone": {
+                          "type": "string",
+                          "description": "Phone number."
+                        },
+                        "corporateName": {
+                          "type": "string",
+                          "description": "Company name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "tradeName": {
+                          "type": "string",
+                          "description": "Trade name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporateDocument": {
+                          "type": "string",
+                          "description": "Corporate document, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "stateInscription": {
+                          "type": "string",
+                          "description": "State inscription, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporatePhone": {
+                          "type": "string",
+                          "description": "Corporate phone number, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "isCorporate": {
+                          "type": "boolean",
+                          "description": "Indicates whether the customer is a legal entity."
+                        },
+                        "profileCompleteOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile is complete on loading."
+                        },
+                        "profileErrorOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile presents error on loading.",
+                          "nullable": true
+                        },
+                        "customerClass": {
+                          "type": "string",
+                          "description": "Customer class.",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "paymentData": {
+                      "type": "object",
+                      "description": "Information on the order's payment.",
+                      "properties": {
+                        "giftCards": {
+                          "type": "array",
+                          "description": "Gift card information, if it applies to the order.",
+                          "items": {
+                            "description": "Gift card information.",
+                            "type": "object",
+                            "properties": {
+                              "redemptionCode": {
+                                "type": "string",
+                                "description": "Gift card redemption code."
+                              },
+                              "value": {
+                                "type": "integer",
+                                "description": "Gift card value in cents."
+                              },
+                              "balance": {
+                                "type": "integer",
+                                "description": "Gift card balance in cents."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Gift card name."
+                              },
+                              "id": {
+                                "type": "string",
+                                "description": "Gift card ID."
+                              },
+                              "inUse": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is in use."
+                              },
+                              "isSpecialCard": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is special."
+                              }
+                            }
+                          }
+                        },
+                        "transactions": {
+                          "type": "array",
+                          "description": "Information on each transaction pertinent to the order.",
+                          "items": {
+                            "description": "Transaction information.",
+                            "nullable": true,
+                            "type": "object",
+                            "properties": {
+                              "isActive": {
+                                "type": "boolean",
+                                "description": "Indicates whether transaction is active."
+                              },
+                              "transactionId": {
+                                "type": "string",
+                                "description": "Transaction ID."
+                              },
+                              "merchantName": {
+                                "type": "string",
+                                "description": "Merchant name."
+                              },
+                              "payments": {
+                                "type": "array",
+                                "description": "Information on each payment.",
+                                "items": {
+                                  "description": "Payment information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "accountId": {
+                                      "type": "string",
+                                      "description": "Account ID."
+                                    },
+                                    "bin": {
+                                      "type": "string",
+                                      "description": "Bin.",
+                                      "nullable": true
+                                    },
+                                    "installments": {
+                                      "type": "integer",
+                                      "description": "Number of installments."
+                                    },
+                                    "paymentSystem": {
+                                      "type": "string",
+                                      "description": "Payment system."
+                                    },
+                                    "referenceValue": {
+                                      "type": "integer",
+                                      "description": "Reference value for calculating interest rates, in case it applies. Displayed in cents."
+                                    },
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value including interest, in case it applies. Displayed in cents."
+                                    }
+                                  }
+                                }
+                              },
+                              "sharedTransaction": {
+                                "type": "boolean",
+                                "description": "Indicates whather transaction is shared."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "marketingData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Object containing promotion data such as coupon tracking information and internal or external UTMs.",
+                      "properties": {
+                        "coupon": {
+                          "type": "string",
+                          "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.",
+                          "example": "free-shipping"
+                        },
+                        "utmSource": {
+                          "type": "string",
+                          "description": "UTM source.",
+                          "example": "Facebook"
+                        },
+                        "utmMedium": {
+                          "type": "string",
+                          "description": "UTM medium.",
+                          "example": "CPC"
+                        },
+                        "utmCampaign": {
+                          "type": "string",
+                          "description": "UTM campaign.",
+                          "example": "Black friday"
+                        },
+                        "utmiPage": {
+                          "type": "string",
+                          "description": "utmi_page (internal utm).",
+                          "example": "utmi_page-example",
+                          "nullable": true
+                        },
+                        "utmiPart": {
+                          "type": "string",
+                          "description": "utmi_part (internal utm).",
+                          "example": "utmi_part-example",
+                          "nullable": true
+                        },
+                        "utmiCampaign": {
+                          "type": "string",
+                          "description": "utmi_campaign (internal utm).",
+                          "example": "utmi_campaign-example",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "sellers": {
+                      "type": "array",
+                      "description": "Information on each seller.",
+                      "items": {
+                        "description": "Seller information.",
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "Seller ID."
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Seller name."
+                          },
+                          "logo": {
+                            "type": "string",
+                            "description": "Seller logo.",
+                            "nullable": true
+                          }
+                        }
+                      }
+                    },
+                    "clientPreferencesData": {
+                      "type": "object",
+                      "description": "Object containing preferences from the client who placed the order.",
+                      "properties": {
+                        "locale": {
+                          "type": "string",
+                          "description": "Client's locale. Examples: `pt-BR` and `en-US`."
+                        },
+                        "optinNewsLetter": {
+                          "type": "boolean",
+                          "description": "`true` if the client opted to receive newsletter from the store.",
+                          "example": false,
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "commercialConditionData": {
+                      "type": "object",
+                      "description": "Object containing commercial condition information.",
+                      "nullable": true
+                    },
+                    "storePreferencesData": {
+                      "type": "object",
+                      "description": "Object containing data from the store's configuration (stored in VTEX's License Manager)."
+                    },
+                    "giftRegistryData": {
+                      "type": "object",
+                      "description": "Gift registry list information.",
+                      "nullable": true
+                    },
+                    "openTextField": {
+                      "type": "string",
+                      "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).",
+                      "example": "open-text-example",
+                      "nullable": true
+                    },
+                    "invoiceData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Invoice data including billing address.",
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Billing address.",
+                          "properties": {
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City name."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State name."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Country."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street name."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Street number."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Address complement."
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Reference for location."
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Geographic coordinates (latitude, longitude).",
+                              "items": {
+                                "type": "number"
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "customData": {
+                      "type": "object",
+                      "description": "Customer additional information.",
+                      "nullable": true
+                    },
+                    "itemMetadata": {
+                      "type": "object",
+                      "description": "Item metadata.",
+                      "properties": {
+                        "items": {
+                          "type": "array",
+                          "description": "List of objects containing metadata on each item in the order.",
+                          "items": {
+                            "description": "Item metadata.",
+                            "type": "object",
+                            "properties": {
+                              "id": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "seller": {
+                                "type": "string",
+                                "description": "Seller."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Product name."
+                              },
+                              "skuName": {
+                                "type": "string",
+                                "description": "SKU name."
+                              },
+                              "productId": {
+                                "type": "string",
+                                "description": "Product ID."
+                              },
+                              "refId": {
+                                "type": "string",
+                                "description": "Ref ID."
+                              },
+                              "ean": {
+                                "type": "string",
+                                "description": "European Article Number.",
+                                "nullable": true
+                              },
+                              "imageUrl": {
+                                "type": "string",
+                                "description": "Image URL."
+                              },
+                              "detailUrl": {
+                                "type": "string",
+                                "description": "Detail URL."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "hooksData": {
+                      "type": "object",
+                      "description": "Hooks information.",
+                      "nullable": true
+                    },
+                    "ratesAndBenefitsData": {
+                      "type": "object",
+                      "description": "Information on rates and benefits that apply to the order.",
+                      "properties": {
+                        "rateAndBenefitsIdentifiers": {
+                          "type": "array",
+                          "description": "List with rates and benefits identifiers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit identifier."
+                          }
+                        },
+                        "teaser": {
+                          "type": "array",
+                          "description": "List with rates and benefits teasers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit teaser."
+                          }
+                        }
+                      }
+                    },
+                    "subscriptionData": {
+                      "type": "object",
+                      "description": "Subscription information.",
+                      "nullable": true
+                    },
+                    "itemsOrdination": {
+                      "type": "object",
+                      "description": "Object containing information about the ordering of items within the `orderForm`.",
+                      "properties": {
+                        "criteria": {
+                          "type": "string",
+                          "description": "Criteria adopted to order the items in the list."
+                        },
+                        "ascending": {
+                          "type": "boolean",
+                          "description": "Indicates whether the ordering is ascending."
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/api/checkout/pub/orderForm/{orderFormId}/items/removeAll": {
+      "post": {
+        "tags": [
+          "Shopping cart"
+        ],
+        "summary": "Remove all items from shopping cart",
+        "description": "This request removes all items from a given cart, leaving it empty.\r\n\r\nYou must send an empty JSON in the body of the request.\r\n\r\nThe [orderForm](https://developers.vtex.com/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.\r\n\r\n>ℹ️ Request body must always be sent with empty value \"{ }\" in this endpoint.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Shopping Cart Full Access** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "RemoveAllItems",
+        "security": [],
+        "parameters": [
+          {
+            "name": "orderFormId",
+            "in": "path",
+            "description": "ID of the orderForm corresponding to the cart whose items you want to remove.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "ede846222cd44046ba6c638442c3505a"
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "description": "This object must be empty.",
+                "default": {}
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "orderFormId": {
+                      "type": "string",
+                      "description": "ID of the orderForm corresponding to a specific cart."
+                    },
+                    "salesChannel": {
+                      "type": "string",
+                      "description": "Attribute created by the seller, in their VTEX store configuration."
+                    },
+                    "loggedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether the user is logged into the store."
+                    },
+                    "isCheckedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether order is checked in."
+                    },
+                    "storeId": {
+                      "type": "string",
+                      "description": "ID of the store.",
+                      "nullable": true
+                    },
+                    "allowManualPrice": {
+                      "type": "boolean",
+                      "description": "Permission to modify item price manually."
+                    },
+                    "canEditData": {
+                      "type": "boolean",
+                      "description": "Data can be edited."
+                    },
+                    "userProfileId": {
+                      "type": "string",
+                      "description": "Unique ID associated with the customer profile."
+                    },
+                    "profileProvider": {
+                      "type": "string",
+                      "description": "Profile provider."
+                    },
+                    "availableAccounts": {
+                      "type": "array",
+                      "description": "Available accounts.",
+                      "items": {
+                        "type": "string",
+                        "description": "Account."
+                      }
+                    },
+                    "availableAddresses": {
+                      "type": "array",
+                      "description": "Information on each available address.",
+                      "items": {
+                        "description": "Address information.",
+                        "type": "object",
+                        "properties": {
+                          "addressType": {
+                            "type": "string",
+                            "description": "Address type."
+                          },
+                          "receiverName": {
+                            "type": "string",
+                            "description": "Name of the receiver."
+                          },
+                          "addressId": {
+                            "type": "string",
+                            "description": "Address ID.",
+                            "nullable": true
+                          },
+                          "isDisposable": {
+                            "type": "boolean",
+                            "description": "Indicates whether address is disposable."
+                          },
+                          "city": {
+                            "type": "string",
+                            "description": "City of the address."
+                          },
+                          "state": {
+                            "type": "string",
+                            "description": "State of the address."
+                          },
+                          "country": {
+                            "type": "string",
+                            "description": "Country of the address. ISO three-letter code."
+                          },
+                          "street": {
+                            "type": "string",
+                            "description": "Street of the address."
+                          },
+                          "number": {
+                            "type": "string",
+                            "description": "Number of the address."
+                          },
+                          "neighborhood": {
+                            "type": "string",
+                            "description": "Neighborhood of the address."
+                          },
+                          "complement": {
+                            "description": "Complement to the shipping address, in case it applies.",
+                            "type": "string",
+                            "nullable": true
+                          },
+                          "reference": {
+                            "type": "string",
+                            "description": "Reference that may help in the location of the address.",
+                            "nullable": true
+                          },
+                          "geoCoordinates": {
+                            "type": "array",
+                            "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                            "items": {
+                              "type": "number",
+                              "description": "Geocoordinates."
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "userType": {
+                      "type": "string",
+                      "description": "User type.",
+                      "nullable": true
+                    },
+                    "ignoreProfileData": {
+                      "type": "boolean",
+                      "description": "Ignore customer profile data."
+                    },
+                    "value": {
+                      "type": "integer",
+                      "description": "Total value of the order without separating cents. For example, $24.99 is represented as `2499`."
+                    },
+                    "messages": {
+                      "type": "array",
+                      "description": "Array containing an object for each message generated by our servers while processing the request.",
+                      "items": {
+                        "type": "string",
+                        "description": "Message."
+                      }
+                    },
+                    "items": {
+                      "type": "array",
+                      "description": "Information on each item in the order.",
+                      "items": {
+                        "description": "Item information.",
+                        "type": "object",
+                        "properties": {
+                          "uniqueId": {
+                            "type": "string",
+                            "description": "Unique ID."
+                          },
+                          "id": {
+                            "type": "string",
+                            "description": "ID of the item."
+                          },
+                          "productId": {
+                            "type": "string",
+                            "description": "Product ID."
+                          },
+                          "productRefId": {
+                            "type": "string",
+                            "description": "Product Ref ID."
+                          },
+                          "refId": {
+                            "type": "string",
+                            "description": "Ref ID."
+                          },
+                          "ean": {
+                            "type": "string",
+                            "description": "European Article Number.",
+                            "nullable": true
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Product name."
+                          },
+                          "skuName": {
+                            "type": "string",
+                            "description": "SKU name."
+                          },
+                          "modalType": {
+                            "type": "string",
+                            "description": "Modal type.",
+                            "nullable": true
+                          },
+                          "parentItemIndex": {
+                            "type": "integer",
+                            "description": "Parent item index.",
+                            "nullable": true
+                          },
+                          "parentAssemblyBinding": {
+                            "type": "string",
+                            "description": "Parent assembly binding.",
+                            "nullable": true
+                          },
+                          "priceValidUntil": {
+                            "type": "string",
+                            "description": "Price expiration date and time."
+                          },
+                          "tax": {
+                            "type": "integer",
+                            "description": "Tax value in cents."
+                          },
+                          "taxCode": {
+                            "type": "string",
+                            "description": "A unique identifier code assigned to a tax within the VTEX Admin."
+                          },
+                          "price": {
+                            "type": "integer",
+                            "description": "Price in cents."
+                          },
+                          "listPrice": {
+                            "type": "integer",
+                            "description": "List price in cents."
+                          },
+                          "manualPrice": {
+                            "type": "integer",
+                            "description": "Manual price in cents.",
+                            "nullable": true
+                          },
+                          "manualPriceAppliedBy": {
+                            "type": "string",
+                            "description": "User that applied the manual price, if that is the case.",
+                            "nullable": true
+                          },
+                          "sellingPrice": {
+                            "type": "integer",
+                            "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
+                          },
+                          "rewardValue": {
+                            "type": "integer",
+                            "description": "Reward value in cents."
+                          },
+                          "isGift": {
+                            "type": "boolean",
+                            "description": "Indicates whether item is a gift."
+                          },
+                          "additionalInfo": {
+                            "type": "object",
+                            "description": "Additional information.",
+                            "properties": {
+                              "dimension": {
+                                "type": "string",
+                                "description": "Dimension.",
+                                "nullable": true
+                              },
+                              "brandName": {
+                                "type": "string",
+                                "description": "Brand name."
+                              },
+                              "brandId": {
+                                "type": "string",
+                                "description": "Brand ID."
+                              },
+                              "offeringInfo": {
+                                "type": "string",
+                                "description": "Offering information.",
+                                "nullable": true
+                              },
+                              "offeringType": {
+                                "type": "string",
+                                "description": "Offering type.",
+                                "nullable": true
+                              },
+                              "offeringTypeId": {
+                                "type": "string",
+                                "description": "Offering type ID.",
+                                "nullable": true
+                              }
+                            }
+                          },
+                          "preSaleDate": {
+                            "type": "string",
+                            "description": "Presale date.",
+                            "nullable": true
+                          },
+                          "productCategoryIds": {
+                            "type": "string",
+                            "description": "Product category IDs."
+                          },
+                          "productCategories": {
+                            "type": "object",
+                            "description": "Object, where each field is an ID from `productCategoryIds`.",
+                            "properties": {
+                              "{ID}": {
+                                "type": "string",
+                                "description": "Product category corresponding to the ID in the field key."
+                              }
+                            }
+                          },
+                          "quantity": {
+                            "type": "integer",
+                            "description": "Quantity."
+                          },
+                          "seller": {
+                            "type": "string",
+                            "description": "Seller."
+                          },
+                          "sellerChain": {
+                            "type": "array",
+                            "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
+                            "items": {
+                              "type": "string",
+                              "description": "Seller."
+                            }
+                          },
+                          "imageUrl": {
+                            "type": "string",
+                            "description": "Image URL."
+                          },
+                          "detailUrl": {
+                            "type": "string",
+                            "description": "Detail URL."
+                          },
+                          "bundleItems": {
+                            "type": "array",
+                            "description": "Information on services sold along with the SKU. Example: a gift package.",
+                            "items": {
+                              "description": "Service information.",
+                              "type": "object",
+                              "properties": {
+                                "type": {
+                                  "type": "string",
+                                  "description": "Service type."
+                                },
+                                "id": {
+                                  "type": "integer",
+                                  "description": "Service identifier."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Service name."
+                                },
+                                "price": {
+                                  "type": "integer",
+                                  "description": "Service price in cents."
+                                }
+                              }
+                            }
+                          },
+                          "attachments": {
+                            "type": "array",
+                            "description": "Array containing information on attachments.",
+                            "items": {
+                              "type": "string",
+                              "description": "Attachment."
+                            }
+                          },
+                          "priceTags": {
+                            "type": "array",
+                            "description": "Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.",
+                            "items": {
+                              "description": "Price tag information.",
+                              "type": "object",
+                              "properties": {
+                                "identifier": {
+                                  "type": "string",
+                                  "description": "Promotion unique identifier.",
+                                  "nullable": true
+                                },
+                                "isPercentual": {
+                                  "type": "boolean",
+                                  "description": "Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\r\n- `type` indicates whether the tag refers to a discount or tax.\r\n- `where` specifies the context, either price or shipping.\r\n- `identifier` is the promotion ID.\r\n- `calculationId` is a hash that may vary with each price calculation."
+                                },
+                                "rawValue": {
+                                  "type": "number",
+                                  "description": "Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations."
+                                },
+                                "value": {
+                                  "type": "integer",
+                                  "description": "Price tag value representing either a promotion (value decrease) or a tax (value increase)."
+                                }
+                              }
+                            }
+                          },
+                          "availability": {
+                            "type": "string",
+                            "description": "Availability."
+                          },
+                          "measurementUnit": {
+                            "type": "string",
+                            "description": "Measurement unit."
+                          },
+                          "unitMultiplier": {
+                            "type": "integer",
+                            "description": "Unit multiplier."
+                          },
+                          "manufacturerCode": {
+                            "type": "string",
+                            "description": "Manufacturer code.",
+                            "nullable": true
+                          },
+                          "priceDefinition": {
+                            "type": "object",
+                            "description": "Price information for all units of a specific item.",
+                            "properties": {
+                              "calculatedSellingPrice": {
+                                "type": "integer",
+                                "description": "Item's calculated unitary selling price in cents."
+                              },
+                              "total": {
+                                "type": "integer",
+                                "description": "Total value for all units of the item in cents."
+                              },
+                              "sellingPrices": {
+                                "type": "array",
+                                "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
+                                "items": {
+                                  "description": "Rounding information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value in cents for that specific rounding."
+                                    },
+                                    "quantity": {
+                                      "type": "integer",
+                                      "description": "Rounding quantity, meaning how many items are rounded to this value."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "selectableGifts": {
+                      "type": "array",
+                      "description": "Array containing the data of the item selected as a gift.",
+                      "items": {
+                        "type": "string",
+                        "description": "Gift."
+                      }
+                    },
+                    "totalizers": {
+                      "type": "array",
+                      "description": "Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).",
+                      "items": {
+                        "type": "object",
+                        "description": "Totalizer of purchases."
+                      }
+                    },
+                    "shippingData": {
+                      "type": "object",
+                      "description": "Shipping information pertinent to the order.",
+                      "nullable": true,
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Address information.",
+                          "nullable": true,
+                          "properties": {
+                            "addressType": {
+                              "type": "string",
+                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                            },
+                            "receiverName": {
+                              "type": "string",
+                              "description": "Name of the person who is going to receive the order."
+                            },
+                            "addressId": {
+                              "type": "string",
+                              "description": "Address ID.",
+                              "nullable": true
+                            },
+                            "isDisposable": {
+                              "type": "boolean",
+                              "description": "Indicates whether address is disposable."
+                            },
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City of the shipping address."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State of the shipping address."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Three letter ISO code of the country of the shipping address."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street of the shipping address."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Number of the building, house or apartment in the shipping address."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood of the shipping address."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Complement to the shipping address, in case it applies.",
+                              "nullable": true
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                              "nullable": true
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                              "items": {
+                                "type": "number",
+                                "description": "Geocoordinates."
+                              }
+                            }
+                          }
+                        },
+                        "logisticsInfo": {
+                          "type": "array",
+                          "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.",
+                          "items": {
+                            "description": "Logistics information.",
+                            "type": "object",
+                            "properties": {
+                              "itemIndex": {
+                                "type": "integer",
+                                "description": "Index corresponding to the position of the object in the `items` array."
+                              },
+                              "selectedSla": {
+                                "type": "string",
+                                "description": "SLA selected by the customer.",
+                                "nullable": true
+                              },
+                              "selectedDeliveryChannel": {
+                                "type": "string",
+                                "description": "Delivery channel selected by the customer.",
+                                "nullable": true
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "slas": {
+                                "type": "array",
+                                "description": "Information on available SLAs.",
+                                "items": {
+                                  "description": "SLA information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "SLA ID."
+                                    },
+                                    "deliveryChannel": {
+                                      "type": "string",
+                                      "description": "Delivery channel."
+                                    },
+                                    "name": {
+                                      "type": "string",
+                                      "description": "SLA name."
+                                    },
+                                    "deliveryIds": {
+                                      "type": "array",
+                                      "description": "Information on each delivery ID.",
+                                      "items": {
+                                        "description": "Delivery ID information.",
+                                        "type": "object",
+                                        "properties": {
+                                          "courierId": {
+                                            "type": "string",
+                                            "description": "Courier ID."
+                                          },
+                                          "warehouseId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "dockId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "courierName": {
+                                            "type": "string",
+                                            "description": "Courier name."
+                                          },
+                                          "quantity": {
+                                            "type": "integer",
+                                            "description": "Quantity."
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "attachmentOfferings": {
+                                      "type": "array",
+                                      "description": "List of attachments details.",
+                                      "nullable": true,
+                                      "items": {
+                                        "description": "Attachment details.",
+                                        "type": "object",
+                                        "required": [
+                                          "name",
+                                          "required",
+                                          "schema"
+                                        ],
+                                        "properties": {
+                                          "name": {
+                                            "type": "string",
+                                            "description": "Name of the attachment.",
+                                            "nullable": true
+                                          },
+                                          "required": {
+                                            "type": "boolean",
+                                            "description": "Defines if the attachment is required (`true`) or not (`false`).",
+                                            "nullable": true
+                                          },
+                                          "schema": {
+                                            "type": "object",
+                                            "description": "Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).",
+                                            "nullable": true
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "shippingEstimate": {
+                                      "type": "string",
+                                      "description": "Shipping estimate. For instance, \"three business days\" will be represented as `3bd`."
+                                    },
+                                    "shippingEstimateDate": {
+                                      "type": "string",
+                                      "description": "When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.",
+                                      "nullable": true
+                                    },
+                                    "useIndividualShippingEstimates": {
+                                      "type": "boolean",
+                                      "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`."
+                                    },
+                                    "lockTTL": {
+                                      "type": "string",
+                                      "description": "Estimate date of delivery.",
+                                      "nullable": true
+                                    },
+                                    "price": {
+                                      "type": "integer",
+                                      "description": "Price in cents."
+                                    },
+                                    "listPrice": {
+                                      "type": "integer",
+                                      "description": "List price in cents."
+                                    },
+                                    "tax": {
+                                      "type": "integer",
+                                      "description": "Tax in cents."
+                                    },
+                                    "pickupStoreInfo": {
+                                      "type": "object",
+                                      "description": "Information on the pickup store.",
+                                      "properties": {
+                                        "isPickupStore": {
+                                          "type": "boolean",
+                                          "description": "Indicates whether it is the pickup store."
+                                        },
+                                        "friendlyName": {
+                                          "type": "string",
+                                          "description": "Friendly name.",
+                                          "nullable": true
+                                        },
+                                        "address": {
+                                          "type": "object",
+                                          "description": "Address information.",
+                                          "nullable": true,
+                                          "properties": {
+                                            "addressType": {
+                                              "type": "string",
+                                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                                            },
+                                            "postalCode": {
+                                              "type": "string",
+                                              "description": "Postal code."
+                                            },
+                                            "city": {
+                                              "type": "string",
+                                              "description": "City of the shipping address."
+                                            },
+                                            "state": {
+                                              "type": "string",
+                                              "description": "State of the shipping address."
+                                            },
+                                            "country": {
+                                              "type": "string",
+                                              "description": "Three letter ISO code of the country of the shipping address."
+                                            },
+                                            "street": {
+                                              "type": "string",
+                                              "description": "Street of the shipping address."
+                                            },
+                                            "number": {
+                                              "type": "string",
+                                              "description": "Number of the building, house or apartment in the shipping address."
+                                            },
+                                            "neighborhood": {
+                                              "type": "string",
+                                              "description": "Neighborhood of the shipping address."
+                                            },
+                                            "complement": {
+                                              "type": "string",
+                                              "description": "Complement to the shipping address, in case it applies.",
+                                              "nullable": true
+                                            },
+                                            "reference": {
+                                              "type": "string",
+                                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                              "nullable": true
+                                            },
+                                            "geoCoordinates": {
+                                              "type": "array",
+                                              "description": "Array with two strings that repesent geocoordinates: first latitude, then longitude.",
+                                              "items": {
+                                                "type": "number",
+                                                "description": "Geocoordinates."
+                                              }
+                                            }
+                                          }
+                                        },
+                                        "additionalInfo": {
+                                          "type": "string",
+                                          "description": "Additional information.",
+                                          "nullable": true
+                                        },
+                                        "dockId": {
+                                          "type": "string",
+                                          "description": "Corresponding dock ID.",
+                                          "nullable": true
+                                        }
+                                      }
+                                    },
+                                    "pickupPointId": {
+                                      "type": "string",
+                                      "description": "Pickup point ID.",
+                                      "nullable": true
+                                    },
+                                    "pickupDistance": {
+                                      "type": "integer",
+                                      "description": "Pickup point distance."
+                                    },
+                                    "polygonName": {
+                                      "type": "string",
+                                      "description": "Polygon name.",
+                                      "nullable": true
+                                    },
+                                    "transitTime": {
+                                      "type": "string",
+                                      "description": "Transit time. For instance, \"three business days\" is represented as `3bd`."
+                                    }
+                                  }
+                                }
+                              },
+                              "shipsTo": {
+                                "type": "array",
+                                "description": "List of countries that the item may be shipped to.",
+                                "items": {
+                                  "type": "string",
+                                  "description": "Three letter country code."
+                                }
+                              },
+                              "itemId": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "deliveryChannels": {
+                                "type": "array",
+                                "description": "List of available delivery channels.",
+                                "items": {
+                                  "description": "Delivery channel information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "Delivery channel ID."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "selectedAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the selected addresses for the order.",
+                          "items": {
+                            "description": "Selected address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "availableAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the available addresses for the order.",
+                          "items": {
+                            "description": "Available address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "clientProfileData": {
+                      "type": "object",
+                      "description": "Customer's profile information.",
+                      "nullable": true,
+                      "properties": {
+                        "email": {
+                          "type": "string",
+                          "description": "Email address.",
+                          "nullable": true
+                        },
+                        "firstName": {
+                          "type": "string",
+                          "description": "First name.",
+                          "nullable": true
+                        },
+                        "lastName": {
+                          "type": "string",
+                          "description": "Last name."
+                        },
+                        "documentType": {
+                          "type": "string",
+                          "description": "Type of the document informed by the customer."
+                        },
+                        "document": {
+                          "type": "string",
+                          "description": "Document informed by the customer."
+                        },
+                        "phone": {
+                          "type": "string",
+                          "description": "Phone number."
+                        },
+                        "corporateName": {
+                          "type": "string",
+                          "description": "Company name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "tradeName": {
+                          "type": "string",
+                          "description": "Trade name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporateDocument": {
+                          "type": "string",
+                          "description": "Corporate document, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "stateInscription": {
+                          "type": "string",
+                          "description": "State inscription, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporatePhone": {
+                          "type": "string",
+                          "description": "Corporate phone number, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "isCorporate": {
+                          "type": "boolean",
+                          "description": "Indicates whether the customer is a legal entity."
+                        },
+                        "profileCompleteOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile is complete on loading."
+                        },
+                        "profileErrorOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile presents error on loading.",
+                          "nullable": true
+                        },
+                        "customerClass": {
+                          "type": "string",
+                          "description": "Customer class.",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "paymentData": {
+                      "type": "object",
+                      "description": "Information on the order's payment.",
+                      "properties": {
+                        "giftCards": {
+                          "type": "array",
+                          "description": "Gift card information, if it applies to the order.",
+                          "items": {
+                            "description": "Gift card information.",
+                            "type": "object",
+                            "properties": {
+                              "redemptionCode": {
+                                "type": "string",
+                                "description": "Gift card redemption code."
+                              },
+                              "value": {
+                                "type": "integer",
+                                "description": "Gift card value in cents."
+                              },
+                              "balance": {
+                                "type": "integer",
+                                "description": "Gift card balance in cents."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Gift card name."
+                              },
+                              "id": {
+                                "type": "string",
+                                "description": "Gift card ID."
+                              },
+                              "inUse": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is in use."
+                              },
+                              "isSpecialCard": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is special."
+                              }
+                            }
+                          }
+                        },
+                        "transactions": {
+                          "type": "array",
+                          "description": "Information on each transaction pertinent to the order.",
+                          "items": {
+                            "description": "Transaction information.",
+                            "nullable": true,
+                            "type": "object",
+                            "properties": {
+                              "isActive": {
+                                "type": "boolean",
+                                "description": "Indicates whether transaction is active."
+                              },
+                              "transactionId": {
+                                "type": "string",
+                                "description": "Transaction ID."
+                              },
+                              "merchantName": {
+                                "type": "string",
+                                "description": "Merchant name."
+                              },
+                              "payments": {
+                                "type": "array",
+                                "description": "Information on each payment.",
+                                "items": {
+                                  "description": "Payment information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "accountId": {
+                                      "type": "string",
+                                      "description": "Account ID."
+                                    },
+                                    "bin": {
+                                      "type": "string",
+                                      "description": "Bin.",
+                                      "nullable": true
+                                    },
+                                    "installments": {
+                                      "type": "integer",
+                                      "description": "Number of installments."
+                                    },
+                                    "paymentSystem": {
+                                      "type": "string",
+                                      "description": "Payment system."
+                                    },
+                                    "referenceValue": {
+                                      "type": "integer",
+                                      "description": "Reference value for calculating interest rates, in case it applies. Displayed in cents."
+                                    },
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value including interest, in case it applies. Displayed in cents."
+                                    }
+                                  }
+                                }
+                              },
+                              "sharedTransaction": {
+                                "type": "boolean",
+                                "description": "Indicates whather transaction is shared."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "marketingData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Object containing promotion data such as coupon tracking information and internal or external UTMs.",
+                      "properties": {
+                        "coupon": {
+                          "type": "string",
+                          "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.",
+                          "example": "free-shipping"
+                        },
+                        "utmSource": {
+                          "type": "string",
+                          "description": "UTM source.",
+                          "example": "Facebook"
+                        },
+                        "utmMedium": {
+                          "type": "string",
+                          "description": "UTM medium.",
+                          "example": "CPC"
+                        },
+                        "utmCampaign": {
+                          "type": "string",
+                          "description": "UTM campaign.",
+                          "example": "Black friday"
+                        },
+                        "utmiPage": {
+                          "type": "string",
+                          "description": "utmi_page (internal utm).",
+                          "example": "utmi_page-example",
+                          "nullable": true
+                        },
+                        "utmiPart": {
+                          "type": "string",
+                          "description": "utmi_part (internal utm).",
+                          "example": "utmi_part-example",
+                          "nullable": true
+                        },
+                        "utmiCampaign": {
+                          "type": "string",
+                          "description": "utmi_campaign (internal utm).",
+                          "example": "utmi_campaign-example",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "sellers": {
+                      "type": "array",
+                      "description": "Information on each seller.",
+                      "items": {
+                        "description": "Seller information.",
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "Seller ID."
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Seller name."
+                          },
+                          "logo": {
+                            "type": "string",
+                            "description": "Seller logo.",
+                            "nullable": true
+                          }
+                        }
+                      }
+                    },
+                    "clientPreferencesData": {
+                      "type": "object",
+                      "description": "Object containing preferences from the client who placed the order.",
+                      "properties": {
+                        "locale": {
+                          "type": "string",
+                          "description": "Client's locale. Examples: `pt-BR` and `en-US`."
+                        },
+                        "optinNewsLetter": {
+                          "type": "boolean",
+                          "description": "`true` if the client opted to receive newsletter from the store.",
+                          "example": false,
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "commercialConditionData": {
+                      "type": "object",
+                      "description": "Object containing commercial condition information.",
+                      "nullable": true
+                    },
+                    "storePreferencesData": {
+                      "type": "object",
+                      "description": "Object containing data from the store's configuration (stored in VTEX's License Manager)."
+                    },
+                    "giftRegistryData": {
+                      "type": "object",
+                      "description": "Gift registry list information.",
+                      "nullable": true
+                    },
+                    "openTextField": {
+                      "type": "string",
+                      "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).",
+                      "example": "open-text-example",
+                      "nullable": true
+                    },
+                    "invoiceData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Invoice data including billing address.",
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Billing address.",
+                          "properties": {
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City name."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State name."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Country."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street name."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Street number."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Address complement."
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Reference for location."
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Geographic coordinates (latitude, longitude).",
+                              "items": {
+                                "type": "number"
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "customData": {
+                      "type": "object",
+                      "description": "Customer additional information.",
+                      "nullable": true
+                    },
+                    "itemMetadata": {
+                      "type": "object",
+                      "description": "Item metadata.",
+                      "properties": {
+                        "items": {
+                          "type": "array",
+                          "description": "List of objects containing metadata on each item in the order.",
+                          "items": {
+                            "description": "Item metadata.",
+                            "type": "object",
+                            "properties": {
+                              "id": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "seller": {
+                                "type": "string",
+                                "description": "Seller."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Product name."
+                              },
+                              "skuName": {
+                                "type": "string",
+                                "description": "SKU name."
+                              },
+                              "productId": {
+                                "type": "string",
+                                "description": "Product ID."
+                              },
+                              "refId": {
+                                "type": "string",
+                                "description": "Ref ID."
+                              },
+                              "ean": {
+                                "type": "string",
+                                "description": "European Article Number.",
+                                "nullable": true
+                              },
+                              "imageUrl": {
+                                "type": "string",
+                                "description": "Image URL."
+                              },
+                              "detailUrl": {
+                                "type": "string",
+                                "description": "Detail URL."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "hooksData": {
+                      "type": "object",
+                      "description": "Hooks information.",
+                      "nullable": true
+                    },
+                    "ratesAndBenefitsData": {
+                      "type": "object",
+                      "description": "Information on rates and benefits that apply to the order.",
+                      "properties": {
+                        "rateAndBenefitsIdentifiers": {
+                          "type": "array",
+                          "description": "List with rates and benefits identifiers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit identifier."
+                          }
+                        },
+                        "teaser": {
+                          "type": "array",
+                          "description": "List with rates and benefits teasers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit teaser."
+                          }
+                        }
+                      }
+                    },
+                    "subscriptionData": {
+                      "type": "object",
+                      "description": "Subscription information.",
+                      "nullable": true
+                    },
+                    "itemsOrdination": {
+                      "type": "object",
+                      "description": "Object containing information about the ordering of items within the `orderForm`.",
+                      "properties": {
+                        "criteria": {
+                          "type": "string",
+                          "description": "Criteria adopted to order the items in the list."
+                        },
+                        "ascending": {
+                          "type": "boolean",
+                          "description": "Indicates whether the ordering is ascending."
+                        }
+                      }
+                    }
+                  }
+                },
+                "example": {
+                  "orderFormId": "ede846222cd44046ba6c638442c3505a",
+                  "salesChannel": "1",
+                  "loggedIn": false,
+                  "isCheckedIn": false,
+                  "storeId": "1",
+                  "checkedInPickupPointId": "21",
+                  "allowManualPrice": false,
+                  "canEditData": true,
+                  "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
+                  "userType": "User type",
+                  "ignoreProfileData": false,
+                  "value": 0,
+                  "messages": [],
+                  "items": [],
+                  "selectableGifts": [],
+                  "totalizers": [],
+                  "shippingData": {
+                    "address": null,
+                    "logisticsInfo": [],
+                    "selectedAddresses": [],
+                    "availableAddresses": [],
+                    "pickupPoints": []
+                  },
+                  "clientProfileData": {
+                    "email": "john.doe@google.com",
+                    "firstName": "John",
+                    "lastName": "Doe",
+                    "document": "769387308",
+                    "documentType": "dni",
+                    "phone": "+5491111223344",
+                    "corporateName": "company-name",
+                    "tradeName": "trade-name",
+                    "corporateDocument": "12345678000100",
+                    "stateInscription": "12345678",
+                    "corporatePhone": "551100988887777",
+                    "isCorporate": false,
+                    "profileCompleteOnLoading": false,
+                    "profileErrorOnLoading": false,
+                    "customerClass": null
+                  },
+                  "paymentData": {
+                    "installmentOptions": [
+                      {
+                        "paymentSystem": 2,
+                        "bin": null,
+                        "paymentName": null,
+                        "paymentGroupName": null,
+                        "value": 15000,
+                        "installments": [
+                          {
+                            "count": 1,
+                            "hasInterestRate": false,
+                            "interestRate": 0,
+                            "value": 15000,
+                            "total": 15000,
+                            "sellerMerchantInstallments": [
+                              {
+                                "id": "LOJADOBRENO",
+                                "count": 1,
+                                "hasInterestRate": false,
+                                "interestRate": 0,
+                                "value": 15000,
+                                "total": 15000
+                              }
+                            ]
+                          }
+                        ]
+                      }
+                    ],
+                    "paymentSystems": [
+                      {
+                        "id": 4,
+                        "name": "Mastercard",
+                        "groupName": "creditCardPaymentGroup",
+                        "validator": {
+                          "regex": "^((5(([1-2]|[5-5])[0-3]{8}|0((2|9)([0-2]{5}))|1(0(5((0|[4-8])[1-7]{6})|([2-3]|[1-9])[0-9]{6})|[1-9][0-9]{7})))|((508116)\\d{4,10})|((502121)\\d{4,10})|((589916)\\d{4,10})|(2[0-9]{15})|(67[0-9]{14})|(506387)\\d{4,10})",
+                          "mask": "9999 9999 9999 9999",
+                          "cardCodeRegex": "^[1-3]{9}$",
+                          "cardCodeMask": "999",
+                          "weights": [
+                            2,
+                            1,
+                            2,
+                            1,
+                            2
+                          ],
+                          "useCvv": true,
+                          "useExpirationDate": true,
+                          "useCardHolderName": true,
+                          "useBillingAddress": true
+                        },
+                        "stringId": "4",
+                        "template": "creditCardPaymentGroup-template",
+                        "requiresDocument": false,
+                        "isCustom": false,
+                        "description": "Payment description",
+                        "requiresAuthentication": false,
+                        "dueDate": "2020-03-05T14:23:23.8196668Z",
+                        "availablePayments": null
+                      }
+                    ],
+                    "payments": [
+                      {
+                        "paymentSystem": 6,
+                        "bin": null,
+                        "accountId": "12",
+                        "tokenId": null,
+                        "value": 34390,
+                        "referenceValue": 34390,
+                        "giftCardRedemptionCode": null,
+                        "giftCardProvider": null,
+                        "giftCardId": null
+                      }
+                    ],
+                    "giftCards": [],
+                    "giftCardMessages": [],
+                    "availableAccounts": [],
+                    "availableTokens": []
+                  },
+                  "marketingData": null,
+                  "sellers": [],
+                  "clientPreferencesData": {
+                    "locale": "pt-BR",
+                    "optinNewsLetter": null
+                  },
+                  "commercialConditionData": null,
+                  "storePreferencesData": {
+                    "countryCode": "BRA",
+                    "saveUserData": true,
+                    "timeZone": "E. South America Standard Time",
+                    "currencyCode": "BRL",
+                    "currencyLocale": 1046,
+                    "currencySymbol": "R$",
+                    "currencyFormatInfo": {
+                      "currencyDecimalDigits": 2,
+                      "currencyDecimalSeparator": ",",
+                      "currencyGroupSeparator": ".",
+                      "currencyGroupSize": 3,
+                      "startsWithCurrencySymbol": true
+                    }
+                  },
+                  "giftRegistryData": null,
+                  "openTextField": null,
+                  "invoiceData": null,
+                  "customData": null,
+                  "itemMetadata": {
+                    "items": []
+                  },
+                  "hooksData": null,
+                  "ratesAndBenefitsData": {
+                    "rateAndBenefitsIdentifiers": [],
+                    "teaser": []
+                  },
+                  "subscriptionData": null,
+                  "itemsOrdination": {
+                    "criteria": "NAME",
+                    "ascending": true
+                  }
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/checkout/changeToAnonymousUser/{orderFormId}": {
+      "get": {
+        "tags": [
+          "Shopping cart"
+        ],
+        "summary": "Remove all personal data from shopping cart",
+        "description": "This call removes all user information, making a cart anonymous while leaving the items.\r\n\r\nThe [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.\r\n\r\nThis call works by creating a new orderForm, setting a new cookie, and returning a redirect 302 to the cart URL (`/checkout/#/orderform`).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Save OrderForm Configuration** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "Removeallpersonaldata",
+        "security": [],
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "orderFormId",
+            "in": "path",
+            "description": "ID of the orderForm corresponding to the cart whose user's personal data you want to remove.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "ede846222cd44046ba6c638442c3505a"
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "type": "object",
+                  "description": "Empty object."
+                },
+                "example": {}
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/api/checkout/pub/orderForm/{orderFormId}/items/update": {
+      "post": {
+        "tags": [
+          "Shopping cart"
+        ],
+        "summary": "Update cart items",
+        "description": "You can use this request to:\n\r\n\r1. Change the quantity of one or more items in a specific cart.\n\r2. Remove an item from the cart (by sending the `quantity` value = `0` in the request body).\r\n\r\n>ℹ️ To remove all items from the cart at the same time, use the [Remove all items](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pub/orderForm/-orderFormId-/items/removeAll?endpoint=post-/api/checkout/pub/orderForm/-orderFormId-/items/removeAll) endpoint.\r\n\r\nThe [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.\n\r\n\r> This request has a time out of 45 seconds.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "ItemsUpdate",
+        "security": [],
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "orderFormId",
+            "in": "path",
+            "description": "ID of the `orderForm` corresponding to the cart whose items you want to update.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "ede846222cd44046ba6c638442c3505a"
+            }
+          },
+          {
+            "name": "allowedOutdatedData",
+            "in": "query",
+            "description": "In order to optimize performance, this parameter allows some information to not be updated when there are changes in the minicart. For instance, if a shopper adds another unit of a given SKU to the cart, it may not be necessary to recalculate payment information, which could impact performance.\n\r\n\rThis array accepts strings and currently the only possible value is `”paymentData”`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "array",
+              "example": [
+                "paymentData"
+              ],
+              "items": {
+                "type": "string",
+                "description": "Information that will not be updated when there are changes in the minicart."
+              }
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "orderItems": {
+                    "type": "array",
+                    "description": "Array containing the cart items. Each object inside this array corresponds to a different item.",
+                    "items": {
+                      "type": "object",
+                      "description": "Cart item information.",
+                      "properties": {
+                        "quantity": {
+                          "type": "integer",
+                          "format": "int32",
+                          "description": "The quantity of the item in the cart.",
+                          "example": 3
+                        },
+                        "index": {
+                          "type": "integer",
+                          "description": "The position of the item in the array.",
+                          "example": 0
+                        }
+                      }
+                    }
+                  }
+                }
+              },
+              "example": {
+                "orderItems": [
+                  {
+                    "quantity": 3,
+                    "index": 0
+                  },
+                  {
+                    "quantity": 1,
+                    "index": 1
+                  },
+                  {
+                    "quantity": 2,
+                    "index": 2
+                  }
+                ]
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "orderFormId": {
+                      "type": "string",
+                      "description": "ID of the orderForm corresponding to a specific cart."
+                    },
+                    "salesChannel": {
+                      "type": "string",
+                      "description": "Attribute created by the seller, in their VTEX store configuration."
+                    },
+                    "loggedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether the user is logged into the store."
+                    },
+                    "isCheckedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether order is checked in."
+                    },
+                    "storeId": {
+                      "type": "string",
+                      "description": "ID of the store.",
+                      "nullable": true
+                    },
+                    "allowManualPrice": {
+                      "type": "boolean",
+                      "description": "Permission to modify item price manually."
+                    },
+                    "canEditData": {
+                      "type": "boolean",
+                      "description": "Data can be edited."
+                    },
+                    "userProfileId": {
+                      "type": "string",
+                      "description": "Unique ID associated with the customer profile."
+                    },
+                    "profileProvider": {
+                      "type": "string",
+                      "description": "Profile provider."
+                    },
+                    "availableAccounts": {
+                      "type": "array",
+                      "description": "Available accounts.",
+                      "items": {
+                        "type": "string",
+                        "description": "Account."
+                      }
+                    },
+                    "availableAddresses": {
+                      "type": "array",
+                      "description": "Information on each available address.",
+                      "items": {
+                        "description": "Address information.",
+                        "type": "object",
+                        "properties": {
+                          "addressType": {
+                            "type": "string",
+                            "description": "Address type."
+                          },
+                          "receiverName": {
+                            "type": "string",
+                            "description": "Name of the receiver."
+                          },
+                          "addressId": {
+                            "type": "string",
+                            "description": "Address ID.",
+                            "nullable": true
+                          },
+                          "isDisposable": {
+                            "type": "boolean",
+                            "description": "Indicates whether address is disposable."
+                          },
+                          "city": {
+                            "type": "string",
+                            "description": "City of the address."
+                          },
+                          "state": {
+                            "type": "string",
+                            "description": "State of the address."
+                          },
+                          "country": {
+                            "type": "string",
+                            "description": "Country of the address. ISO three-letter code."
+                          },
+                          "street": {
+                            "type": "string",
+                            "description": "Street of the address."
+                          },
+                          "number": {
+                            "type": "string",
+                            "description": "Number of the address."
+                          },
+                          "neighborhood": {
+                            "type": "string",
+                            "description": "Neighborhood of the address."
+                          },
+                          "complement": {
+                            "description": "Complement to the shipping address, in case it applies.",
+                            "type": "string",
+                            "nullable": true
+                          },
+                          "reference": {
+                            "type": "string",
+                            "description": "Reference that may help in the location of the address.",
+                            "nullable": true
+                          },
+                          "geoCoordinates": {
+                            "type": "array",
+                            "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                            "items": {
+                              "type": "number",
+                              "description": "Geocoordinates."
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "userType": {
+                      "type": "string",
+                      "description": "User type.",
+                      "nullable": true
+                    },
+                    "ignoreProfileData": {
+                      "type": "boolean",
+                      "description": "Ignore customer profile data."
+                    },
+                    "value": {
+                      "type": "integer",
+                      "description": "Total value of the order without separating cents. For example, $24.99 is represented as `2499`."
+                    },
+                    "messages": {
+                      "type": "array",
+                      "description": "Array containing an object for each message generated by our servers while processing the request.",
+                      "items": {
+                        "type": "string",
+                        "description": "Message."
+                      }
+                    },
+                    "items": {
+                      "type": "array",
+                      "description": "Information on each item in the order.",
+                      "items": {
+                        "description": "Item information.",
+                        "type": "object",
+                        "properties": {
+                          "uniqueId": {
+                            "type": "string",
+                            "description": "Unique ID."
+                          },
+                          "id": {
+                            "type": "string",
+                            "description": "ID of the item."
+                          },
+                          "productId": {
+                            "type": "string",
+                            "description": "Product ID."
+                          },
+                          "productRefId": {
+                            "type": "string",
+                            "description": "Product Ref ID."
+                          },
+                          "refId": {
+                            "type": "string",
+                            "description": "Ref ID."
+                          },
+                          "ean": {
+                            "type": "string",
+                            "description": "European Article Number.",
+                            "nullable": true
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Product name."
+                          },
+                          "skuName": {
+                            "type": "string",
+                            "description": "SKU name."
+                          },
+                          "modalType": {
+                            "type": "string",
+                            "description": "Modal type.",
+                            "nullable": true
+                          },
+                          "parentItemIndex": {
+                            "type": "integer",
+                            "description": "Parent item index.",
+                            "nullable": true
+                          },
+                          "parentAssemblyBinding": {
+                            "type": "string",
+                            "description": "Parent assembly binding.",
+                            "nullable": true
+                          },
+                          "priceValidUntil": {
+                            "type": "string",
+                            "description": "Price expiration date and time."
+                          },
+                          "tax": {
+                            "type": "integer",
+                            "description": "Tax value in cents."
+                          },
+                          "taxCode": {
+                            "type": "string",
+                            "description": "A unique identifier code assigned to a tax within the VTEX Admin."
+                          },
+                          "price": {
+                            "type": "integer",
+                            "description": "Price in cents."
+                          },
+                          "listPrice": {
+                            "type": "integer",
+                            "description": "List price in cents."
+                          },
+                          "manualPrice": {
+                            "type": "integer",
+                            "description": "Manual price in cents.",
+                            "nullable": true
+                          },
+                          "manualPriceAppliedBy": {
+                            "type": "string",
+                            "description": "User that applied the manual price, if that is the case.",
+                            "nullable": true
+                          },
+                          "sellingPrice": {
+                            "type": "integer",
+                            "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
+                          },
+                          "rewardValue": {
+                            "type": "integer",
+                            "description": "Reward value in cents."
+                          },
+                          "isGift": {
+                            "type": "boolean",
+                            "description": "Indicates whether item is a gift."
+                          },
+                          "additionalInfo": {
+                            "type": "object",
+                            "description": "Additional information.",
+                            "properties": {
+                              "dimension": {
+                                "type": "string",
+                                "description": "Dimension.",
+                                "nullable": true
+                              },
+                              "brandName": {
+                                "type": "string",
+                                "description": "Brand name."
+                              },
+                              "brandId": {
+                                "type": "string",
+                                "description": "Brand ID."
+                              },
+                              "offeringInfo": {
+                                "type": "string",
+                                "description": "Offering information.",
+                                "nullable": true
+                              },
+                              "offeringType": {
+                                "type": "string",
+                                "description": "Offering type.",
+                                "nullable": true
+                              },
+                              "offeringTypeId": {
+                                "type": "string",
+                                "description": "Offering type ID.",
+                                "nullable": true
+                              }
+                            }
+                          },
+                          "preSaleDate": {
+                            "type": "string",
+                            "description": "Presale date.",
+                            "nullable": true
+                          },
+                          "productCategoryIds": {
+                            "type": "string",
+                            "description": "Product category IDs."
+                          },
+                          "productCategories": {
+                            "type": "object",
+                            "description": "Object, where each field is an ID from `productCategoryIds`.",
+                            "properties": {
+                              "{ID}": {
+                                "type": "string",
+                                "description": "Product category corresponding to the ID in the field key."
+                              }
+                            }
+                          },
+                          "quantity": {
+                            "type": "integer",
+                            "description": "Quantity."
+                          },
+                          "seller": {
+                            "type": "string",
+                            "description": "Seller."
+                          },
+                          "sellerChain": {
+                            "type": "array",
+                            "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
+                            "items": {
+                              "type": "string",
+                              "description": "Seller."
+                            }
+                          },
+                          "imageUrl": {
+                            "type": "string",
+                            "description": "Image URL."
+                          },
+                          "detailUrl": {
+                            "type": "string",
+                            "description": "Detail URL."
+                          },
+                          "bundleItems": {
+                            "type": "array",
+                            "description": "Information on services sold along with the SKU. Example: a gift package.",
+                            "items": {
+                              "description": "Service information.",
+                              "type": "object",
+                              "properties": {
+                                "type": {
+                                  "type": "string",
+                                  "description": "Service type."
+                                },
+                                "id": {
+                                  "type": "integer",
+                                  "description": "Service identifier."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Service name."
+                                },
+                                "price": {
+                                  "type": "integer",
+                                  "description": "Service price in cents."
+                                }
+                              }
+                            }
+                          },
+                          "attachments": {
+                            "type": "array",
+                            "description": "Array containing information on attachments.",
+                            "items": {
+                              "type": "string",
+                              "description": "Attachment."
+                            }
+                          },
+                          "priceTags": {
+                            "type": "array",
+                            "description": "Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.",
+                            "items": {
+                              "description": "Price tag information.",
+                              "type": "object",
+                              "properties": {
+                                "identifier": {
+                                  "type": "string",
+                                  "description": "Promotion unique identifier.",
+                                  "nullable": true
+                                },
+                                "isPercentual": {
+                                  "type": "boolean",
+                                  "description": "Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\r\n- `type` indicates whether the tag refers to a discount or tax.\r\n- `where` specifies the context, either price or shipping.\r\n- `identifier` is the promotion ID.\r\n- `calculationId` is a hash that may vary with each price calculation."
+                                },
+                                "rawValue": {
+                                  "type": "number",
+                                  "description": "Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations."
+                                },
+                                "value": {
+                                  "type": "integer",
+                                  "description": "Price tag value representing either a promotion (value decrease) or a tax (value increase)."
+                                }
+                              }
+                            }
+                          },
+                          "availability": {
+                            "type": "string",
+                            "description": "Availability."
+                          },
+                          "measurementUnit": {
+                            "type": "string",
+                            "description": "Measurement unit."
+                          },
+                          "unitMultiplier": {
+                            "type": "integer",
+                            "description": "Unit multiplier."
+                          },
+                          "manufacturerCode": {
+                            "type": "string",
+                            "description": "Manufacturer code.",
+                            "nullable": true
+                          },
+                          "priceDefinition": {
+                            "type": "object",
+                            "description": "Price information for all units of a specific item.",
+                            "properties": {
+                              "calculatedSellingPrice": {
+                                "type": "integer",
+                                "description": "Item's calculated unitary selling price in cents."
+                              },
+                              "total": {
+                                "type": "integer",
+                                "description": "Total value for all units of the item in cents."
+                              },
+                              "sellingPrices": {
+                                "type": "array",
+                                "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
+                                "items": {
+                                  "description": "Rounding information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value in cents for that specific rounding."
+                                    },
+                                    "quantity": {
+                                      "type": "integer",
+                                      "description": "Rounding quantity, meaning how many items are rounded to this value."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "selectableGifts": {
+                      "type": "array",
+                      "description": "Array containing the data of the item selected as a gift.",
+                      "items": {
+                        "type": "string",
+                        "description": "Gift."
+                      }
+                    },
+                    "totalizers": {
+                      "type": "array",
+                      "description": "Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).",
+                      "items": {
+                        "type": "object",
+                        "description": "Totalizer of purchases."
+                      }
+                    },
+                    "shippingData": {
+                      "type": "object",
+                      "description": "Shipping information pertinent to the order.",
+                      "nullable": true,
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Address information.",
+                          "nullable": true,
+                          "properties": {
+                            "addressType": {
+                              "type": "string",
+                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                            },
+                            "receiverName": {
+                              "type": "string",
+                              "description": "Name of the person who is going to receive the order."
+                            },
+                            "addressId": {
+                              "type": "string",
+                              "description": "Address ID.",
+                              "nullable": true
+                            },
+                            "isDisposable": {
+                              "type": "boolean",
+                              "description": "Indicates whether address is disposable."
+                            },
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City of the shipping address."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State of the shipping address."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Three letter ISO code of the country of the shipping address."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street of the shipping address."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Number of the building, house or apartment in the shipping address."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood of the shipping address."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Complement to the shipping address, in case it applies.",
+                              "nullable": true
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                              "nullable": true
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                              "items": {
+                                "type": "number",
+                                "description": "Geocoordinates."
+                              }
+                            }
+                          }
+                        },
+                        "logisticsInfo": {
+                          "type": "array",
+                          "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.",
+                          "items": {
+                            "description": "Logistics information.",
+                            "type": "object",
+                            "properties": {
+                              "itemIndex": {
+                                "type": "integer",
+                                "description": "Index corresponding to the position of the object in the `items` array."
+                              },
+                              "selectedSla": {
+                                "type": "string",
+                                "description": "SLA selected by the customer.",
+                                "nullable": true
+                              },
+                              "selectedDeliveryChannel": {
+                                "type": "string",
+                                "description": "Delivery channel selected by the customer.",
+                                "nullable": true
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "slas": {
+                                "type": "array",
+                                "description": "Information on available SLAs.",
+                                "items": {
+                                  "description": "SLA information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "SLA ID."
+                                    },
+                                    "deliveryChannel": {
+                                      "type": "string",
+                                      "description": "Delivery channel."
+                                    },
+                                    "name": {
+                                      "type": "string",
+                                      "description": "SLA name."
+                                    },
+                                    "deliveryIds": {
+                                      "type": "array",
+                                      "description": "Information on each delivery ID.",
+                                      "items": {
+                                        "description": "Delivery ID information.",
+                                        "type": "object",
+                                        "properties": {
+                                          "courierId": {
+                                            "type": "string",
+                                            "description": "Courier ID."
+                                          },
+                                          "warehouseId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "dockId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "courierName": {
+                                            "type": "string",
+                                            "description": "Courier name."
+                                          },
+                                          "quantity": {
+                                            "type": "integer",
+                                            "description": "Quantity."
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "attachmentOfferings": {
+                                      "type": "array",
+                                      "description": "List of attachments details.",
+                                      "nullable": true,
+                                      "items": {
+                                        "description": "Attachment details.",
+                                        "type": "object",
+                                        "required": [
+                                          "name",
+                                          "required",
+                                          "schema"
+                                        ],
+                                        "properties": {
+                                          "name": {
+                                            "type": "string",
+                                            "description": "Name of the attachment.",
+                                            "nullable": true
+                                          },
+                                          "required": {
+                                            "type": "boolean",
+                                            "description": "Defines if the attachment is required (`true`) or not (`false`).",
+                                            "nullable": true
+                                          },
+                                          "schema": {
+                                            "type": "object",
+                                            "description": "Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).",
+                                            "nullable": true
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "shippingEstimate": {
+                                      "type": "string",
+                                      "description": "Shipping estimate. For instance, \"three business days\" will be represented as `3bd`."
+                                    },
+                                    "shippingEstimateDate": {
+                                      "type": "string",
+                                      "description": "When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.",
+                                      "nullable": true
+                                    },
+                                    "useIndividualShippingEstimates": {
+                                      "type": "boolean",
+                                      "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`."
+                                    },
+                                    "lockTTL": {
+                                      "type": "string",
+                                      "description": "Estimate date of delivery.",
+                                      "nullable": true
+                                    },
+                                    "price": {
+                                      "type": "integer",
+                                      "description": "Price in cents."
+                                    },
+                                    "listPrice": {
+                                      "type": "integer",
+                                      "description": "List price in cents."
+                                    },
+                                    "tax": {
+                                      "type": "integer",
+                                      "description": "Tax in cents."
+                                    },
+                                    "pickupStoreInfo": {
+                                      "type": "object",
+                                      "description": "Information on the pickup store.",
+                                      "properties": {
+                                        "isPickupStore": {
+                                          "type": "boolean",
+                                          "description": "Indicates whether it is the pickup store."
+                                        },
+                                        "friendlyName": {
+                                          "type": "string",
+                                          "description": "Friendly name.",
+                                          "nullable": true
+                                        },
+                                        "address": {
+                                          "type": "object",
+                                          "description": "Address information.",
+                                          "nullable": true,
+                                          "properties": {
+                                            "addressType": {
+                                              "type": "string",
+                                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                                            },
+                                            "postalCode": {
+                                              "type": "string",
+                                              "description": "Postal code."
+                                            },
+                                            "city": {
+                                              "type": "string",
+                                              "description": "City of the shipping address."
+                                            },
+                                            "state": {
+                                              "type": "string",
+                                              "description": "State of the shipping address."
+                                            },
+                                            "country": {
+                                              "type": "string",
+                                              "description": "Three letter ISO code of the country of the shipping address."
+                                            },
+                                            "street": {
+                                              "type": "string",
+                                              "description": "Street of the shipping address."
+                                            },
+                                            "number": {
+                                              "type": "string",
+                                              "description": "Number of the building, house or apartment in the shipping address."
+                                            },
+                                            "neighborhood": {
+                                              "type": "string",
+                                              "description": "Neighborhood of the shipping address."
+                                            },
+                                            "complement": {
+                                              "type": "string",
+                                              "description": "Complement to the shipping address, in case it applies.",
+                                              "nullable": true
+                                            },
+                                            "reference": {
+                                              "type": "string",
+                                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                              "nullable": true
+                                            },
+                                            "geoCoordinates": {
+                                              "type": "array",
+                                              "description": "Array with two strings that repesent geocoordinates: first latitude, then longitude.",
+                                              "items": {
+                                                "type": "number",
+                                                "description": "Geocoordinates."
+                                              }
+                                            }
+                                          }
+                                        },
+                                        "additionalInfo": {
+                                          "type": "string",
+                                          "description": "Additional information.",
+                                          "nullable": true
+                                        },
+                                        "dockId": {
+                                          "type": "string",
+                                          "description": "Corresponding dock ID.",
+                                          "nullable": true
+                                        }
+                                      }
+                                    },
+                                    "pickupPointId": {
+                                      "type": "string",
+                                      "description": "Pickup point ID.",
+                                      "nullable": true
+                                    },
+                                    "pickupDistance": {
+                                      "type": "integer",
+                                      "description": "Pickup point distance."
+                                    },
+                                    "polygonName": {
+                                      "type": "string",
+                                      "description": "Polygon name.",
+                                      "nullable": true
+                                    },
+                                    "transitTime": {
+                                      "type": "string",
+                                      "description": "Transit time. For instance, \"three business days\" is represented as `3bd`."
+                                    }
+                                  }
+                                }
+                              },
+                              "shipsTo": {
+                                "type": "array",
+                                "description": "List of countries that the item may be shipped to.",
+                                "items": {
+                                  "type": "string",
+                                  "description": "Three letter country code."
+                                }
+                              },
+                              "itemId": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "deliveryChannels": {
+                                "type": "array",
+                                "description": "List of available delivery channels.",
+                                "items": {
+                                  "description": "Delivery channel information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "Delivery channel ID."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "selectedAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the selected addresses for the order.",
+                          "items": {
+                            "description": "Selected address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "availableAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the available addresses for the order.",
+                          "items": {
+                            "description": "Available address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "clientProfileData": {
+                      "type": "object",
+                      "description": "Customer's profile information.",
+                      "nullable": true,
+                      "properties": {
+                        "email": {
+                          "type": "string",
+                          "description": "Email address.",
+                          "nullable": true
+                        },
+                        "firstName": {
+                          "type": "string",
+                          "description": "First name.",
+                          "nullable": true
+                        },
+                        "lastName": {
+                          "type": "string",
+                          "description": "Last name."
+                        },
+                        "documentType": {
+                          "type": "string",
+                          "description": "Type of the document informed by the customer."
+                        },
+                        "document": {
+                          "type": "string",
+                          "description": "Document informed by the customer."
+                        },
+                        "phone": {
+                          "type": "string",
+                          "description": "Phone number."
+                        },
+                        "corporateName": {
+                          "type": "string",
+                          "description": "Company name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "tradeName": {
+                          "type": "string",
+                          "description": "Trade name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporateDocument": {
+                          "type": "string",
+                          "description": "Corporate document, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "stateInscription": {
+                          "type": "string",
+                          "description": "State inscription, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporatePhone": {
+                          "type": "string",
+                          "description": "Corporate phone number, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "isCorporate": {
+                          "type": "boolean",
+                          "description": "Indicates whether the customer is a legal entity."
+                        },
+                        "profileCompleteOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile is complete on loading."
+                        },
+                        "profileErrorOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile presents error on loading.",
+                          "nullable": true
+                        },
+                        "customerClass": {
+                          "type": "string",
+                          "description": "Customer class.",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "paymentData": {
+                      "type": "object",
+                      "description": "Information on the order's payment.",
+                      "properties": {
+                        "giftCards": {
+                          "type": "array",
+                          "description": "Gift card information, if it applies to the order.",
+                          "items": {
+                            "description": "Gift card information.",
+                            "type": "object",
+                            "properties": {
+                              "redemptionCode": {
+                                "type": "string",
+                                "description": "Gift card redemption code."
+                              },
+                              "value": {
+                                "type": "integer",
+                                "description": "Gift card value in cents."
+                              },
+                              "balance": {
+                                "type": "integer",
+                                "description": "Gift card balance in cents."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Gift card name."
+                              },
+                              "id": {
+                                "type": "string",
+                                "description": "Gift card ID."
+                              },
+                              "inUse": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is in use."
+                              },
+                              "isSpecialCard": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is special."
+                              }
+                            }
+                          }
+                        },
+                        "transactions": {
+                          "type": "array",
+                          "description": "Information on each transaction pertinent to the order.",
+                          "items": {
+                            "description": "Transaction information.",
+                            "nullable": true,
+                            "type": "object",
+                            "properties": {
+                              "isActive": {
+                                "type": "boolean",
+                                "description": "Indicates whether transaction is active."
+                              },
+                              "transactionId": {
+                                "type": "string",
+                                "description": "Transaction ID."
+                              },
+                              "merchantName": {
+                                "type": "string",
+                                "description": "Merchant name."
+                              },
+                              "payments": {
+                                "type": "array",
+                                "description": "Information on each payment.",
+                                "items": {
+                                  "description": "Payment information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "accountId": {
+                                      "type": "string",
+                                      "description": "Account ID."
+                                    },
+                                    "bin": {
+                                      "type": "string",
+                                      "description": "Bin.",
+                                      "nullable": true
+                                    },
+                                    "installments": {
+                                      "type": "integer",
+                                      "description": "Number of installments."
+                                    },
+                                    "paymentSystem": {
+                                      "type": "string",
+                                      "description": "Payment system."
+                                    },
+                                    "referenceValue": {
+                                      "type": "integer",
+                                      "description": "Reference value for calculating interest rates, in case it applies. Displayed in cents."
+                                    },
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value including interest, in case it applies. Displayed in cents."
+                                    }
+                                  }
+                                }
+                              },
+                              "sharedTransaction": {
+                                "type": "boolean",
+                                "description": "Indicates whather transaction is shared."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "marketingData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Object containing promotion data such as coupon tracking information and internal or external UTMs.",
+                      "properties": {
+                        "coupon": {
+                          "type": "string",
+                          "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.",
+                          "example": "free-shipping"
+                        },
+                        "utmSource": {
+                          "type": "string",
+                          "description": "UTM source.",
+                          "example": "Facebook"
+                        },
+                        "utmMedium": {
+                          "type": "string",
+                          "description": "UTM medium.",
+                          "example": "CPC"
+                        },
+                        "utmCampaign": {
+                          "type": "string",
+                          "description": "UTM campaign.",
+                          "example": "Black friday"
+                        },
+                        "utmiPage": {
+                          "type": "string",
+                          "description": "utmi_page (internal utm).",
+                          "example": "utmi_page-example",
+                          "nullable": true
+                        },
+                        "utmiPart": {
+                          "type": "string",
+                          "description": "utmi_part (internal utm).",
+                          "example": "utmi_part-example",
+                          "nullable": true
+                        },
+                        "utmiCampaign": {
+                          "type": "string",
+                          "description": "utmi_campaign (internal utm).",
+                          "example": "utmi_campaign-example",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "sellers": {
+                      "type": "array",
+                      "description": "Information on each seller.",
+                      "items": {
+                        "description": "Seller information.",
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "Seller ID."
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Seller name."
+                          },
+                          "logo": {
+                            "type": "string",
+                            "description": "Seller logo.",
+                            "nullable": true
+                          }
+                        }
+                      }
+                    },
+                    "clientPreferencesData": {
+                      "type": "object",
+                      "description": "Object containing preferences from the client who placed the order.",
+                      "properties": {
+                        "locale": {
+                          "type": "string",
+                          "description": "Client's locale. Examples: `pt-BR` and `en-US`."
+                        },
+                        "optinNewsLetter": {
+                          "type": "boolean",
+                          "description": "`true` if the client opted to receive newsletter from the store.",
+                          "example": false,
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "commercialConditionData": {
+                      "type": "object",
+                      "description": "Object containing commercial condition information.",
+                      "nullable": true
+                    },
+                    "storePreferencesData": {
+                      "type": "object",
+                      "description": "Object containing data from the store's configuration (stored in VTEX's License Manager)."
+                    },
+                    "giftRegistryData": {
+                      "type": "object",
+                      "description": "Gift registry list information.",
+                      "nullable": true
+                    },
+                    "openTextField": {
+                      "type": "string",
+                      "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).",
+                      "example": "open-text-example",
+                      "nullable": true
+                    },
+                    "invoiceData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Invoice data including billing address.",
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Billing address.",
+                          "properties": {
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City name."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State name."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Country."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street name."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Street number."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Address complement."
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Reference for location."
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Geographic coordinates (latitude, longitude).",
+                              "items": {
+                                "type": "number"
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "customData": {
+                      "type": "object",
+                      "description": "Customer additional information.",
+                      "nullable": true
+                    },
+                    "itemMetadata": {
+                      "type": "object",
+                      "description": "Item metadata.",
+                      "properties": {
+                        "items": {
+                          "type": "array",
+                          "description": "List of objects containing metadata on each item in the order.",
+                          "items": {
+                            "description": "Item metadata.",
+                            "type": "object",
+                            "properties": {
+                              "id": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "seller": {
+                                "type": "string",
+                                "description": "Seller."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Product name."
+                              },
+                              "skuName": {
+                                "type": "string",
+                                "description": "SKU name."
+                              },
+                              "productId": {
+                                "type": "string",
+                                "description": "Product ID."
+                              },
+                              "refId": {
+                                "type": "string",
+                                "description": "Ref ID."
+                              },
+                              "ean": {
+                                "type": "string",
+                                "description": "European Article Number.",
+                                "nullable": true
+                              },
+                              "imageUrl": {
+                                "type": "string",
+                                "description": "Image URL."
+                              },
+                              "detailUrl": {
+                                "type": "string",
+                                "description": "Detail URL."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "hooksData": {
+                      "type": "object",
+                      "description": "Hooks information.",
+                      "nullable": true
+                    },
+                    "ratesAndBenefitsData": {
+                      "type": "object",
+                      "description": "Information on rates and benefits that apply to the order.",
+                      "properties": {
+                        "rateAndBenefitsIdentifiers": {
+                          "type": "array",
+                          "description": "List with rates and benefits identifiers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit identifier."
+                          }
+                        },
+                        "teaser": {
+                          "type": "array",
+                          "description": "List with rates and benefits teasers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit teaser."
+                          }
+                        }
+                      }
+                    },
+                    "subscriptionData": {
+                      "type": "object",
+                      "description": "Subscription information.",
+                      "nullable": true
+                    },
+                    "itemsOrdination": {
+                      "type": "object",
+                      "description": "Object containing information about the ordering of items within the `orderForm`.",
+                      "properties": {
+                        "criteria": {
+                          "type": "string",
+                          "description": "Criteria adopted to order the items in the list."
+                        },
+                        "ascending": {
+                          "type": "boolean",
+                          "description": "Indicates whether the ordering is ascending."
+                        }
+                      }
+                    }
+                  }
+                },
+                "example": {
+                  "orderFormId": "ede846222cd44046ba6c638442c3505a",
+                  "salesChannel": "1",
+                  "loggedIn": false,
+                  "isCheckedIn": false,
+                  "storeId": "1",
+                  "allowManualPrice": false,
+                  "canEditData": true,
+                  "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
+                  "profileProvider": "VTEX",
+                  "availableAccounts": [],
+                  "availableAddresses": [
+                    {
+                      "addressType": "residential",
+                      "receiverName": "Clark Kent",
+                      "addressId": "666c2e830bd9474ab6f6cc53fb6dd2d2",
+                      "isDisposable": true,
+                      "postalCode": "70386000",
+                      "city": "Brasília",
+                      "state": "DF",
+                      "country": "BRA",
+                      "street": "Rua da minha casa",
+                      "number": "123",
+                      "neighborhood": "Copacabana",
+                      "complement": "15º andar",
+                      "reference": null,
+                      "geoCoordinates": [
+                        -47.924747467041016,
+                        -15.832582473754883
+                      ]
+                    }
+                  ],
+                  "userType": "User type",
+                  "ignoreProfileData": false,
+                  "value": 34390,
+                  "messages": [],
+                  "items": [
+                    {
+                      "uniqueId": "9D6E447B3FF64CEDA33B17C01379C119",
+                      "id": "2",
+                      "productId": "2",
+                      "productRefId": "1",
+                      "refId": "CBC30L",
+                      "ean": null,
+                      "name": "Chopp Brahma Claro 30L",
+                      "skuName": "Chopp Brahma Claro 30L",
+                      "modalType": null,
+                      "parentItemIndex": null,
+                      "parentAssemblyBinding": null,
+                      "assemblies": [],
+                      "priceValidUntil": "2022-07-13T18:30:46Z",
+                      "tax": 0,
+                      "taxCode": "54WC8ZN6K8",
+                      "price": 32890,
+                      "listPrice": 49900,
+                      "manualPrice": null,
+                      "manualPriceAppliedBy": null,
+                      "sellingPrice": 32890,
+                      "rewardValue": 0,
+                      "isGift": false,
+                      "additionalInfo": {
+                        "dimension": null,
+                        "brandName": "Brahma",
+                        "brandId": "2000000",
+                        "offeringInfo": null,
+                        "offeringType": null,
+                        "offeringTypeId": null
+                      },
+                      "preSaleDate": null,
+                      "productCategoryIds": "/1/",
+                      "productCategories": {
+                        "1": "Bebidas"
+                      },
+                      "quantity": 1,
+                      "seller": "1",
+                      "sellerChain": [
+                        "1"
+                      ],
+                      "imageUrl": "http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000",
+                      "detailUrl": "/chopp-brahma-claro-30l/p",
+                      "components": [],
+                      "bundleItems": [],
+                      "attachments": [],
+                      "attachmentOfferings": [
+                        {
+                          "name": "vtex.subscription.weekly",
+                          "required": false,
+                          "schema": {
+                            "vtex.subscription.key.frequency": {
+                              "MaximumNumberOfCharacters": 7,
+                              "Domain": [
+                                "1 week",
+                                "2 week",
+                                "3 week",
+                                "4 week"
+                              ]
+                            }
+                          }
+                        },
+                        {
+                          "name": "vtex.subscription.daily",
+                          "required": false,
+                          "schema": {
+                            "vtex.subscription.key.frequency": {
+                              "MaximumNumberOfCharacters": 5,
+                              "Domain": [
+                                "1 day"
+                              ]
+                            }
+                          }
+                        }
+                      ],
+                      "offerings": [],
+                      "priceTags": [
+                        {
+                          "name": "DISCOUNT@MANUALPRICE",
+                          "value": -5000,
+                          "rawValue": -50,
+                          "isPercentual": false,
+                          "identifier": "1234abc-5678b-1234c"
+                        }
+                      ],
+                      "availability": "available",
+                      "measurementUnit": "un",
+                      "unitMultiplier": 1,
+                      "manufacturerCode": null,
+                      "priceDefinition": {
+                        "calculatedSellingPrice": 32890,
+                        "total": 32890,
+                        "sellingPrices": [
+                          {
+                            "value": 32890,
+                            "quantity": 1
+                          }
+                        ]
+                      }
+                    }
+                  ],
+                  "selectableGifts": [],
+                  "totalizers": [
+                    {
+                      "id": "Items",
+                      "name": "Total dos Itens",
+                      "value": 15000
+                    }
+                  ],
+                  "shippingData": {
+                    "address": {
+                      "addressType": "residential",
+                      "receiverName": "Clark Kent",
+                      "addressId": "teste",
+                      "isDisposable": true,
+                      "postalCode": "70386000",
+                      "city": "Brasília",
+                      "state": "DF",
+                      "country": "BRA",
+                      "street": "Rua da minha casa",
+                      "number": "123",
+                      "neighborhood": "Copacabana",
+                      "complement": "15º andar",
+                      "reference": null,
+                      "geoCoordinates": [
+                        -47.924747467041016,
+                        -15.832582473754883
+                      ]
+                    },
+                    "logisticsInfo": [
+                      {
+                        "itemIndex": 0,
+                        "selectedSla": "Normal",
+                        "selectedDeliveryChannel": "delivery",
+                        "addressId": "teste",
+                        "slas": [
+                          {
+                            "id": "Normal",
+                            "deliveryChannel": "delivery",
+                            "name": "Normal",
+                            "deliveryIds": [
+                              {
+                                "courierId": "1",
+                                "warehouseId": "1_1",
+                                "dockId": "1",
+                                "courierName": "Transportadora",
+                                "quantity": 1,
+                                "kitItemDetails": []
+                              }
+                            ],
+                            "shippingEstimate": "3bd",
+                            "shippingEstimateDate": null,
+                            "lockTTL": "10d",
+                            "availableDeliveryWindows": [],
+                            "deliveryWindow": null,
+                            "price": 1500,
+                            "listPrice": 1500,
+                            "tax": 0,
+                            "pickupStoreInfo": {
+                              "isPickupStore": false,
+                              "friendlyName": null,
+                              "address": null,
+                              "additionalInfo": null,
+                              "dockId": null
+                            },
+                            "pickupPointId": null,
+                            "pickupDistance": 0,
+                            "polygonName": null,
+                            "transitTime": "3bd"
+                          }
+                        ],
+                        "shipsTo": [
+                          "BRA",
+                          "COL",
+                          "USA"
+                        ],
+                        "itemId": "2",
+                        "deliveryChannels": [
+                          {
+                            "id": "delivery"
+                          },
+                          {
+                            "id": "pickup-in-point"
+                          }
+                        ]
+                      }
+                    ],
+                    "selectedAddresses": [
+                      {
+                        "addressType": "residential",
+                        "receiverName": "Clark Kent",
+                        "addressId": "teste",
+                        "isDisposable": true,
+                        "postalCode": "12345000",
+                        "city": "Rio de Janeiro",
+                        "state": "RJ",
+                        "country": "BRA",
+                        "street": "Rua da minha casa",
+                        "number": "123",
+                        "neighborhood": "Copacabana",
+                        "complement": "15º andar",
+                        "reference": null,
+                        "geoCoordinates": [
+                          -47.924747467041016,
+                          -15.832582473754883
+                        ]
+                      }
+                    ],
+                    "availableAddresses": [
+                      {
+                        "addressType": "residential",
+                        "receiverName": "Clark Kent",
+                        "addressId": "teste",
+                        "isDisposable": true,
+                        "postalCode": "12345000",
+                        "city": "Rio de Janeiro",
+                        "state": "RJ",
+                        "country": "BRA",
+                        "street": "Rua da minha casa",
+                        "number": "123",
+                        "neighborhood": "Copacabana",
+                        "complement": "15º andar",
+                        "reference": null,
+                        "geoCoordinates": [
+                          -47.924747467041016,
+                          -15.832582473754883
+                        ]
+                      }
+                    ],
+                    "pickupPoints": []
+                  },
+                  "clientProfileData": {
+                    "email": "clark.kent@example.com",
+                    "firstName": "Clark",
+                    "lastName": "Kent",
+                    "document": "12345678900",
+                    "documentType": "cpf",
+                    "phone": "+5521998765432",
+                    "corporateName": "company-name",
+                    "tradeName": "trade-name",
+                    "corporateDocument": "12345678000100",
+                    "stateInscription": "12345678",
+                    "corporatePhone": "551100988887777",
+                    "isCorporate": false,
+                    "profileCompleteOnLoading": false,
+                    "profileErrorOnLoading": false,
+                    "customerClass": null
+                  },
+                  "paymentData": {
+                    "installmentOptions": [
+                      {
+                        "paymentSystem": 2,
+                        "bin": null,
+                        "paymentName": null,
+                        "paymentGroupName": null,
+                        "value": 15000,
+                        "installments": [
+                          {
+                            "count": 1,
+                            "hasInterestRate": false,
+                            "interestRate": 0,
+                            "value": 15000,
+                            "total": 15000,
+                            "sellerMerchantInstallments": [
+                              {
+                                "id": "LOJADOBRENO",
+                                "count": 1,
+                                "hasInterestRate": false,
+                                "interestRate": 0,
+                                "value": 15000,
+                                "total": 15000
+                              }
+                            ]
+                          },
+                          {
+                            "count": 2,
+                            "hasInterestRate": false,
+                            "interestRate": 0,
+                            "value": 7500,
+                            "total": 15000,
+                            "sellerMerchantInstallments": [
+                              {
+                                "id": "LOJADOBRENO",
+                                "count": 2,
+                                "hasInterestRate": false,
+                                "interestRate": 0,
+                                "value": 7500,
+                                "total": 15000
+                              }
+                            ]
+                          }
+                        ]
+                      }
+                    ],
+                    "paymentSystems": [
+                      {
+                        "id": 2,
+                        "name": "Visa",
+                        "groupName": "creditCardPaymentGroup",
+                        "validator": {
+                          "regex": "^2[1-8]{17}$",
+                          "mask": "9999 9999 9999 9999",
+                          "cardCodeRegex": "^[0-3]{8}$",
+                          "cardCodeMask": "999",
+                          "weights": [
+                            2,
+                            1,
+                            2,
+                            1,
+                            2,
+                            1
+                          ],
+                          "useCvv": true,
+                          "useExpirationDate": true,
+                          "useCardHolderName": true,
+                          "useBillingAddress": true
+                        },
+                        "stringId": "2",
+                        "template": "creditCardPaymentGroup-template",
+                        "requiresDocument": false,
+                        "isCustom": false,
+                        "description": "Payment description",
+                        "requiresAuthentication": false,
+                        "dueDate": "2020-03-05T14:59:00.7879306Z",
+                        "availablePayments": null
+                      }
+                    ],
+                    "payments": [
+                      {
+                        "paymentSystem": 6,
+                        "bin": null,
+                        "accountId": "12",
+                        "tokenId": null,
+                        "value": 34390,
+                        "referenceValue": 34390,
+                        "giftCardRedemptionCode": null,
+                        "giftCardProvider": null,
+                        "giftCardId": null
+                      }
+                    ],
+                    "giftCards": [],
+                    "giftCardMessages": [],
+                    "availableAccounts": [],
+                    "availableTokens": []
+                  },
+                  "marketingData": {
+                    "coupon": "free-shipping",
+                    "utmSource": "app",
+                    "utmMedium": "CPC",
+                    "utmCampaign": "Black friday",
+                    "utmipage": null,
+                    "utmiPart": null,
+                    "utmiCampaign": null
+                  },
+                  "sellers": [
+                    {
+                      "id": "1",
+                      "name": "lojadobreno",
+                      "logo": "Logo"
+                    }
+                  ],
+                  "clientPreferencesData": {
+                    "locale": "pt-BR",
+                    "optinNewsLetter": false
+                  },
+                  "commercialConditionData": null,
+                  "storePreferencesData": {
+                    "countryCode": "BRA",
+                    "saveUserData": true,
+                    "timeZone": "E. South America Standard Time",
+                    "currencyCode": "BRL",
+                    "currencyLocale": 1046,
+                    "currencySymboupdate cartl": "R$",
+                    "currencyFormatInfo": {
+                      "currencyDecimalDigits": 2,
+                      "currencyDecimalSeparator": ",",
+                      "currencyGroupSeparator": ".",
+                      "currencyGroupSize": 3,
+                      "startsWithCurrencySymbol": true
+                    }
+                  },
+                  "giftRegistryData": null,
+                  "openTextField": null,
+                  "invoiceData": null,
+                  "customData": null,
+                  "itemMetadata": {
+                    "items": [
+                      {
+                        "id": "1",
+                        "seller": "1",
+                        "name": "Ração Royal Canin Feline Urinary 500g",
+                        "skuName": "Ração Royal Canin Feline Urinary 500g",
+                        "productId": "1",
+                        "refId": "0001",
+                        "ean": "123456789",
+                        "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
+                        "detailUrl": "/racao-royal-canin-feline-urinary/p",
+                        "assemblyOptions": []
+                      }
+                    ]
+                  },
+                  "hooksData": null,
+                  "ratesAndBenefitsData": {
+                    "rateAndBenefitsIdentifiers": [],
+                    "teaser": []
+                  },
+                  "subscriptionData": null,
+                  "itemsOrdination": {
+                    "criteria": "NAME",
+                    "ascending": true
+                  }
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/api/checkout/pub/orderForm/{orderFormId}/items": {
+      "post": {
+        "tags": [
+          "Shopping cart"
+        ],
+        "summary": "Add cart items",
+        "description": "Use this request to add a new item to the shopping cart.\r\n\r\nThe [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.\n\r\n\r> This request has a time out of 45 seconds.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "Items",
+        "security": [],
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "orderFormId",
+            "in": "path",
+            "description": "ID of the orderForm corresponding to the cart in which the new item will be added.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "ede846222cd44046ba6c638442c3505a"
+            }
+          },
+          {
+            "name": "allowedOutdatedData",
+            "in": "query",
+            "description": "In order to optimize performance, this parameter allows some information to not be updated when there are changes in the minicart. For instance, if a shopper adds another unit of a given SKU to the cart, it may not be necessary to recalculate payment information, which could impact performance.\n\r\n\rThis array accepts strings and currently the only possible value is `”paymentData”`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "array",
+              "example": [
+                "paymentData"
+              ],
+              "items": {
+                "type": "string",
+                "description": "Information that will not be updated when there are changes in the minicart."
+              }
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "orderItems": {
+                    "type": "array",
+                    "description": "Array containing the cart items. Each object inside this array corresponds to a different item.",
+                    "items": {
+                      "required": [
+                        "quantity",
+                        "seller",
+                        "id",
+                        "index"
+                      ],
+                      "type": "object",
+                      "description": "Cart item information",
+                      "properties": {
+                        "quantity": {
+                          "type": "integer",
+                          "format": "int32",
+                          "description": "The quantity of the item (SKU) in the cart.",
+                          "example": 3
+                        },
+                        "seller": {
+                          "type": "string",
+                          "description": "The seller responsible for the SKU.",
+                          "example": "1"
+                        },
+                        "id": {
+                          "type": "string",
+                          "description": "The ID of the SKU in VTEX platform.",
+                          "example": "2005"
+                        },
+                        "index": {
+                          "type": "integer",
+                          "description": "The position of the item in the array.",
+                          "example": 0
+                        },
+                        "price": {
+                          "type": "integer",
+                          "description": "Price of the item in cents. Send this value in case you want to make a bulk price change.",
+                          "example": 1099
+                        }
+                      }
+                    }
+                  }
+                }
+              },
+              "example": {
+                "orderItems": [
+                  {
+                    "quantity": 3,
+                    "seller": "1",
+                    "id": "2005",
+                    "index": 0,
+                    "price": 1099
+                  }
+                ]
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "orderFormId": {
+                      "type": "string",
+                      "description": "ID of the orderForm corresponding to a specific cart."
+                    },
+                    "salesChannel": {
+                      "type": "string",
+                      "description": "Attribute created by the seller, in their VTEX store configuration."
+                    },
+                    "loggedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether the user is logged into the store."
+                    },
+                    "isCheckedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether order is checked in."
+                    },
+                    "storeId": {
+                      "type": "string",
+                      "description": "ID of the store.",
+                      "nullable": true
+                    },
+                    "allowManualPrice": {
+                      "type": "boolean",
+                      "description": "Permission to modify item price manually."
+                    },
+                    "canEditData": {
+                      "type": "boolean",
+                      "description": "Data can be edited."
+                    },
+                    "userProfileId": {
+                      "type": "string",
+                      "description": "Unique ID associated with the customer profile."
+                    },
+                    "profileProvider": {
+                      "type": "string",
+                      "description": "Profile provider."
+                    },
+                    "availableAccounts": {
+                      "type": "array",
+                      "description": "Available accounts.",
+                      "items": {
+                        "type": "string",
+                        "description": "Account."
+                      }
+                    },
+                    "availableAddresses": {
+                      "type": "array",
+                      "description": "Information on each available address.",
+                      "items": {
+                        "description": "Address information.",
+                        "type": "object",
+                        "properties": {
+                          "addressType": {
+                            "type": "string",
+                            "description": "Address type."
+                          },
+                          "receiverName": {
+                            "type": "string",
+                            "description": "Name of the receiver."
+                          },
+                          "addressId": {
+                            "type": "string",
+                            "description": "Address ID.",
+                            "nullable": true
+                          },
+                          "isDisposable": {
+                            "type": "boolean",
+                            "description": "Indicates whether address is disposable."
+                          },
+                          "city": {
+                            "type": "string",
+                            "description": "City of the address."
+                          },
+                          "state": {
+                            "type": "string",
+                            "description": "State of the address."
+                          },
+                          "country": {
+                            "type": "string",
+                            "description": "Country of the address. ISO three-letter code."
+                          },
+                          "street": {
+                            "type": "string",
+                            "description": "Street of the address."
+                          },
+                          "number": {
+                            "type": "string",
+                            "description": "Number of the address."
+                          },
+                          "neighborhood": {
+                            "type": "string",
+                            "description": "Neighborhood of the address."
+                          },
+                          "complement": {
+                            "description": "Complement to the shipping address, in case it applies.",
+                            "type": "string",
+                            "nullable": true
+                          },
+                          "reference": {
+                            "type": "string",
+                            "description": "Reference that may help in the location of the address.",
+                            "nullable": true
+                          },
+                          "geoCoordinates": {
+                            "type": "array",
+                            "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                            "items": {
+                              "type": "number",
+                              "description": "Geocoordinates."
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "userType": {
+                      "type": "string",
+                      "description": "User type.",
+                      "nullable": true
+                    },
+                    "ignoreProfileData": {
+                      "type": "boolean",
+                      "description": "Ignore customer profile data."
+                    },
+                    "value": {
+                      "type": "integer",
+                      "description": "Total value of the order without separating cents. For example, $24.99 is represented as `2499`."
+                    },
+                    "messages": {
+                      "type": "array",
+                      "description": "Array containing an object for each message generated by our servers while processing the request.",
+                      "items": {
+                        "type": "string",
+                        "description": "Message."
+                      }
+                    },
+                    "items": {
+                      "type": "array",
+                      "description": "Information on each item in the order.",
+                      "items": {
+                        "description": "Item information.",
+                        "type": "object",
+                        "properties": {
+                          "uniqueId": {
+                            "type": "string",
+                            "description": "Unique ID."
+                          },
+                          "id": {
+                            "type": "string",
+                            "description": "ID of the item."
+                          },
+                          "productId": {
+                            "type": "string",
+                            "description": "Product ID."
+                          },
+                          "productRefId": {
+                            "type": "string",
+                            "description": "Product Ref ID."
+                          },
+                          "refId": {
+                            "type": "string",
+                            "description": "Ref ID."
+                          },
+                          "ean": {
+                            "type": "string",
+                            "description": "European Article Number.",
+                            "nullable": true
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Product name."
+                          },
+                          "skuName": {
+                            "type": "string",
+                            "description": "SKU name."
+                          },
+                          "modalType": {
+                            "type": "string",
+                            "description": "Modal type.",
+                            "nullable": true
+                          },
+                          "parentItemIndex": {
+                            "type": "integer",
+                            "description": "Parent item index.",
+                            "nullable": true
+                          },
+                          "parentAssemblyBinding": {
+                            "type": "string",
+                            "description": "Parent assembly binding.",
+                            "nullable": true
+                          },
+                          "priceValidUntil": {
+                            "type": "string",
+                            "description": "Price expiration date and time."
+                          },
+                          "tax": {
+                            "type": "integer",
+                            "description": "Tax value in cents."
+                          },
+                          "taxCode": {
+                            "type": "string",
+                            "description": "A unique identifier code assigned to a tax within the VTEX Admin."
+                          },
+                          "price": {
+                            "type": "integer",
+                            "description": "Price in cents."
+                          },
+                          "listPrice": {
+                            "type": "integer",
+                            "description": "List price in cents."
+                          },
+                          "manualPrice": {
+                            "type": "integer",
+                            "description": "Manual price in cents.",
+                            "nullable": true
+                          },
+                          "manualPriceAppliedBy": {
+                            "type": "string",
+                            "description": "User that applied the manual price, if that is the case.",
+                            "nullable": true
+                          },
+                          "sellingPrice": {
+                            "type": "integer",
+                            "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
+                          },
+                          "rewardValue": {
+                            "type": "integer",
+                            "description": "Reward value in cents."
+                          },
+                          "isGift": {
+                            "type": "boolean",
+                            "description": "Indicates whether item is a gift."
+                          },
+                          "additionalInfo": {
+                            "type": "object",
+                            "description": "Additional information.",
+                            "properties": {
+                              "dimension": {
+                                "type": "string",
+                                "description": "Dimension.",
+                                "nullable": true
+                              },
+                              "brandName": {
+                                "type": "string",
+                                "description": "Brand name."
+                              },
+                              "brandId": {
+                                "type": "string",
+                                "description": "Brand ID."
+                              },
+                              "offeringInfo": {
+                                "type": "string",
+                                "description": "Offering information.",
+                                "nullable": true
+                              },
+                              "offeringType": {
+                                "type": "string",
+                                "description": "Offering type.",
+                                "nullable": true
+                              },
+                              "offeringTypeId": {
+                                "type": "string",
+                                "description": "Offering type ID.",
+                                "nullable": true
+                              }
+                            }
+                          },
+                          "preSaleDate": {
+                            "type": "string",
+                            "description": "Presale date.",
+                            "nullable": true
+                          },
+                          "productCategoryIds": {
+                            "type": "string",
+                            "description": "Product category IDs."
+                          },
+                          "productCategories": {
+                            "type": "object",
+                            "description": "Object, where each field is an ID from `productCategoryIds`.",
+                            "properties": {
+                              "{ID}": {
+                                "type": "string",
+                                "description": "Product category corresponding to the ID in the field key."
+                              }
+                            }
+                          },
+                          "quantity": {
+                            "type": "integer",
+                            "description": "Quantity."
+                          },
+                          "seller": {
+                            "type": "string",
+                            "description": "Seller."
+                          },
+                          "sellerChain": {
+                            "type": "array",
+                            "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
+                            "items": {
+                              "type": "string",
+                              "description": "Seller."
+                            }
+                          },
+                          "imageUrl": {
+                            "type": "string",
+                            "description": "Image URL."
+                          },
+                          "detailUrl": {
+                            "type": "string",
+                            "description": "Detail URL."
+                          },
+                          "bundleItems": {
+                            "type": "array",
+                            "description": "Information on services sold along with the SKU. Example: a gift package.",
+                            "items": {
+                              "description": "Service information.",
+                              "type": "object",
+                              "properties": {
+                                "type": {
+                                  "type": "string",
+                                  "description": "Service type."
+                                },
+                                "id": {
+                                  "type": "integer",
+                                  "description": "Service identifier."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Service name."
+                                },
+                                "price": {
+                                  "type": "integer",
+                                  "description": "Service price in cents."
+                                }
+                              }
+                            }
+                          },
+                          "attachments": {
+                            "type": "array",
+                            "description": "Array containing information on attachments.",
+                            "items": {
+                              "type": "string",
+                              "description": "Attachment."
+                            }
+                          },
+                          "priceTags": {
+                            "type": "array",
+                            "description": "Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.",
+                            "items": {
+                              "description": "Price tag information.",
+                              "type": "object",
+                              "properties": {
+                                "identifier": {
+                                  "type": "string",
+                                  "description": "Promotion unique identifier.",
+                                  "nullable": true
+                                },
+                                "isPercentual": {
+                                  "type": "boolean",
+                                  "description": "Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\r\n- `type` indicates whether the tag refers to a discount or tax.\r\n- `where` specifies the context, either price or shipping.\r\n- `identifier` is the promotion ID.\r\n- `calculationId` is a hash that may vary with each price calculation."
+                                },
+                                "rawValue": {
+                                  "type": "number",
+                                  "description": "Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations."
+                                },
+                                "value": {
+                                  "type": "integer",
+                                  "description": "Price tag value representing either a promotion (value decrease) or a tax (value increase)."
+                                }
+                              }
+                            }
+                          },
+                          "availability": {
+                            "type": "string",
+                            "description": "Availability."
+                          },
+                          "measurementUnit": {
+                            "type": "string",
+                            "description": "Measurement unit."
+                          },
+                          "unitMultiplier": {
+                            "type": "integer",
+                            "description": "Unit multiplier."
+                          },
+                          "manufacturerCode": {
+                            "type": "string",
+                            "description": "Manufacturer code.",
+                            "nullable": true
+                          },
+                          "priceDefinition": {
+                            "type": "object",
+                            "description": "Price information for all units of a specific item.",
+                            "properties": {
+                              "calculatedSellingPrice": {
+                                "type": "integer",
+                                "description": "Item's calculated unitary selling price in cents."
+                              },
+                              "total": {
+                                "type": "integer",
+                                "description": "Total value for all units of the item in cents."
+                              },
+                              "sellingPrices": {
+                                "type": "array",
+                                "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
+                                "items": {
+                                  "description": "Rounding information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value in cents for that specific rounding."
+                                    },
+                                    "quantity": {
+                                      "type": "integer",
+                                      "description": "Rounding quantity, meaning how many items are rounded to this value."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "selectableGifts": {
+                      "type": "array",
+                      "description": "Array containing the data of the item selected as a gift.",
+                      "items": {
+                        "type": "string",
+                        "description": "Gift."
+                      }
+                    },
+                    "totalizers": {
+                      "type": "array",
+                      "description": "Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).",
+                      "items": {
+                        "type": "object",
+                        "description": "Totalizer of purchases."
+                      }
+                    },
+                    "shippingData": {
+                      "type": "object",
+                      "description": "Shipping information pertinent to the order.",
+                      "nullable": true,
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Address information.",
+                          "nullable": true,
+                          "properties": {
+                            "addressType": {
+                              "type": "string",
+                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                            },
+                            "receiverName": {
+                              "type": "string",
+                              "description": "Name of the person who is going to receive the order."
+                            },
+                            "addressId": {
+                              "type": "string",
+                              "description": "Address ID.",
+                              "nullable": true
+                            },
+                            "isDisposable": {
+                              "type": "boolean",
+                              "description": "Indicates whether address is disposable."
+                            },
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City of the shipping address."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State of the shipping address."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Three letter ISO code of the country of the shipping address."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street of the shipping address."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Number of the building, house or apartment in the shipping address."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood of the shipping address."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Complement to the shipping address, in case it applies.",
+                              "nullable": true
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                              "nullable": true
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                              "items": {
+                                "type": "number",
+                                "description": "Geocoordinates."
+                              }
+                            }
+                          }
+                        },
+                        "logisticsInfo": {
+                          "type": "array",
+                          "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.",
+                          "items": {
+                            "description": "Logistics information.",
+                            "type": "object",
+                            "properties": {
+                              "itemIndex": {
+                                "type": "integer",
+                                "description": "Index corresponding to the position of the object in the `items` array."
+                              },
+                              "selectedSla": {
+                                "type": "string",
+                                "description": "SLA selected by the customer.",
+                                "nullable": true
+                              },
+                              "selectedDeliveryChannel": {
+                                "type": "string",
+                                "description": "Delivery channel selected by the customer.",
+                                "nullable": true
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "slas": {
+                                "type": "array",
+                                "description": "Information on available SLAs.",
+                                "items": {
+                                  "description": "SLA information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "SLA ID."
+                                    },
+                                    "deliveryChannel": {
+                                      "type": "string",
+                                      "description": "Delivery channel."
+                                    },
+                                    "name": {
+                                      "type": "string",
+                                      "description": "SLA name."
+                                    },
+                                    "deliveryIds": {
+                                      "type": "array",
+                                      "description": "Information on each delivery ID.",
+                                      "items": {
+                                        "description": "Delivery ID information.",
+                                        "type": "object",
+                                        "properties": {
+                                          "courierId": {
+                                            "type": "string",
+                                            "description": "Courier ID."
+                                          },
+                                          "warehouseId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "dockId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "courierName": {
+                                            "type": "string",
+                                            "description": "Courier name."
+                                          },
+                                          "quantity": {
+                                            "type": "integer",
+                                            "description": "Quantity."
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "attachmentOfferings": {
+                                      "type": "array",
+                                      "description": "List of attachments details.",
+                                      "nullable": true,
+                                      "items": {
+                                        "description": "Attachment details.",
+                                        "type": "object",
+                                        "required": [
+                                          "name",
+                                          "required",
+                                          "schema"
+                                        ],
+                                        "properties": {
+                                          "name": {
+                                            "type": "string",
+                                            "description": "Name of the attachment.",
+                                            "nullable": true
+                                          },
+                                          "required": {
+                                            "type": "boolean",
+                                            "description": "Defines if the attachment is required (`true`) or not (`false`).",
+                                            "nullable": true
+                                          },
+                                          "schema": {
+                                            "type": "object",
+                                            "description": "Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).",
+                                            "nullable": true
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "shippingEstimate": {
+                                      "type": "string",
+                                      "description": "Shipping estimate. For instance, \"three business days\" will be represented as `3bd`."
+                                    },
+                                    "shippingEstimateDate": {
+                                      "type": "string",
+                                      "description": "When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.",
+                                      "nullable": true
+                                    },
+                                    "useIndividualShippingEstimates": {
+                                      "type": "boolean",
+                                      "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`."
+                                    },
+                                    "lockTTL": {
+                                      "type": "string",
+                                      "description": "Estimate date of delivery.",
+                                      "nullable": true
+                                    },
+                                    "price": {
+                                      "type": "integer",
+                                      "description": "Price in cents."
+                                    },
+                                    "listPrice": {
+                                      "type": "integer",
+                                      "description": "List price in cents."
+                                    },
+                                    "tax": {
+                                      "type": "integer",
+                                      "description": "Tax in cents."
+                                    },
+                                    "pickupStoreInfo": {
+                                      "type": "object",
+                                      "description": "Information on the pickup store.",
+                                      "properties": {
+                                        "isPickupStore": {
+                                          "type": "boolean",
+                                          "description": "Indicates whether it is the pickup store."
+                                        },
+                                        "friendlyName": {
+                                          "type": "string",
+                                          "description": "Friendly name.",
+                                          "nullable": true
+                                        },
+                                        "address": {
+                                          "type": "object",
+                                          "description": "Address information.",
+                                          "nullable": true,
+                                          "properties": {
+                                            "addressType": {
+                                              "type": "string",
+                                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                                            },
+                                            "postalCode": {
+                                              "type": "string",
+                                              "description": "Postal code."
+                                            },
+                                            "city": {
+                                              "type": "string",
+                                              "description": "City of the shipping address."
+                                            },
+                                            "state": {
+                                              "type": "string",
+                                              "description": "State of the shipping address."
+                                            },
+                                            "country": {
+                                              "type": "string",
+                                              "description": "Three letter ISO code of the country of the shipping address."
+                                            },
+                                            "street": {
+                                              "type": "string",
+                                              "description": "Street of the shipping address."
+                                            },
+                                            "number": {
+                                              "type": "string",
+                                              "description": "Number of the building, house or apartment in the shipping address."
+                                            },
+                                            "neighborhood": {
+                                              "type": "string",
+                                              "description": "Neighborhood of the shipping address."
+                                            },
+                                            "complement": {
+                                              "type": "string",
+                                              "description": "Complement to the shipping address, in case it applies.",
+                                              "nullable": true
+                                            },
+                                            "reference": {
+                                              "type": "string",
+                                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                              "nullable": true
+                                            },
+                                            "geoCoordinates": {
+                                              "type": "array",
+                                              "description": "Array with two strings that repesent geocoordinates: first latitude, then longitude.",
+                                              "items": {
+                                                "type": "number",
+                                                "description": "Geocoordinates."
+                                              }
+                                            }
+                                          }
+                                        },
+                                        "additionalInfo": {
+                                          "type": "string",
+                                          "description": "Additional information.",
+                                          "nullable": true
+                                        },
+                                        "dockId": {
+                                          "type": "string",
+                                          "description": "Corresponding dock ID.",
+                                          "nullable": true
+                                        }
+                                      }
+                                    },
+                                    "pickupPointId": {
+                                      "type": "string",
+                                      "description": "Pickup point ID.",
+                                      "nullable": true
+                                    },
+                                    "pickupDistance": {
+                                      "type": "integer",
+                                      "description": "Pickup point distance."
+                                    },
+                                    "polygonName": {
+                                      "type": "string",
+                                      "description": "Polygon name.",
+                                      "nullable": true
+                                    },
+                                    "transitTime": {
+                                      "type": "string",
+                                      "description": "Transit time. For instance, \"three business days\" is represented as `3bd`."
+                                    }
+                                  }
+                                }
+                              },
+                              "shipsTo": {
+                                "type": "array",
+                                "description": "List of countries that the item may be shipped to.",
+                                "items": {
+                                  "type": "string",
+                                  "description": "Three letter country code."
+                                }
+                              },
+                              "itemId": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "deliveryChannels": {
+                                "type": "array",
+                                "description": "List of available delivery channels.",
+                                "items": {
+                                  "description": "Delivery channel information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "Delivery channel ID."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "selectedAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the selected addresses for the order.",
+                          "items": {
+                            "description": "Selected address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "availableAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the available addresses for the order.",
+                          "items": {
+                            "description": "Available address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "clientProfileData": {
+                      "type": "object",
+                      "description": "Customer's profile information.",
+                      "nullable": true,
+                      "properties": {
+                        "email": {
+                          "type": "string",
+                          "description": "Email address.",
+                          "nullable": true
+                        },
+                        "firstName": {
+                          "type": "string",
+                          "description": "First name.",
+                          "nullable": true
+                        },
+                        "lastName": {
+                          "type": "string",
+                          "description": "Last name."
+                        },
+                        "documentType": {
+                          "type": "string",
+                          "description": "Type of the document informed by the customer."
+                        },
+                        "document": {
+                          "type": "string",
+                          "description": "Document informed by the customer."
+                        },
+                        "phone": {
+                          "type": "string",
+                          "description": "Phone number."
+                        },
+                        "corporateName": {
+                          "type": "string",
+                          "description": "Company name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "tradeName": {
+                          "type": "string",
+                          "description": "Trade name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporateDocument": {
+                          "type": "string",
+                          "description": "Corporate document, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "stateInscription": {
+                          "type": "string",
+                          "description": "State inscription, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporatePhone": {
+                          "type": "string",
+                          "description": "Corporate phone number, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "isCorporate": {
+                          "type": "boolean",
+                          "description": "Indicates whether the customer is a legal entity."
+                        },
+                        "profileCompleteOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile is complete on loading."
+                        },
+                        "profileErrorOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile presents error on loading.",
+                          "nullable": true
+                        },
+                        "customerClass": {
+                          "type": "string",
+                          "description": "Customer class.",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "paymentData": {
+                      "type": "object",
+                      "description": "Information on the order's payment.",
+                      "properties": {
+                        "giftCards": {
+                          "type": "array",
+                          "description": "Gift card information, if it applies to the order.",
+                          "items": {
+                            "description": "Gift card information.",
+                            "type": "object",
+                            "properties": {
+                              "redemptionCode": {
+                                "type": "string",
+                                "description": "Gift card redemption code."
+                              },
+                              "value": {
+                                "type": "integer",
+                                "description": "Gift card value in cents."
+                              },
+                              "balance": {
+                                "type": "integer",
+                                "description": "Gift card balance in cents."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Gift card name."
+                              },
+                              "id": {
+                                "type": "string",
+                                "description": "Gift card ID."
+                              },
+                              "inUse": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is in use."
+                              },
+                              "isSpecialCard": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is special."
+                              }
+                            }
+                          }
+                        },
+                        "transactions": {
+                          "type": "array",
+                          "description": "Information on each transaction pertinent to the order.",
+                          "items": {
+                            "description": "Transaction information.",
+                            "nullable": true,
+                            "type": "object",
+                            "properties": {
+                              "isActive": {
+                                "type": "boolean",
+                                "description": "Indicates whether transaction is active."
+                              },
+                              "transactionId": {
+                                "type": "string",
+                                "description": "Transaction ID."
+                              },
+                              "merchantName": {
+                                "type": "string",
+                                "description": "Merchant name."
+                              },
+                              "payments": {
+                                "type": "array",
+                                "description": "Information on each payment.",
+                                "items": {
+                                  "description": "Payment information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "accountId": {
+                                      "type": "string",
+                                      "description": "Account ID."
+                                    },
+                                    "bin": {
+                                      "type": "string",
+                                      "description": "Bin.",
+                                      "nullable": true
+                                    },
+                                    "installments": {
+                                      "type": "integer",
+                                      "description": "Number of installments."
+                                    },
+                                    "paymentSystem": {
+                                      "type": "string",
+                                      "description": "Payment system."
+                                    },
+                                    "referenceValue": {
+                                      "type": "integer",
+                                      "description": "Reference value for calculating interest rates, in case it applies. Displayed in cents."
+                                    },
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value including interest, in case it applies. Displayed in cents."
+                                    }
+                                  }
+                                }
+                              },
+                              "sharedTransaction": {
+                                "type": "boolean",
+                                "description": "Indicates whather transaction is shared."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "marketingData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Object containing promotion data such as coupon tracking information and internal or external UTMs.",
+                      "properties": {
+                        "coupon": {
+                          "type": "string",
+                          "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.",
+                          "example": "free-shipping"
+                        },
+                        "utmSource": {
+                          "type": "string",
+                          "description": "UTM source.",
+                          "example": "Facebook"
+                        },
+                        "utmMedium": {
+                          "type": "string",
+                          "description": "UTM medium.",
+                          "example": "CPC"
+                        },
+                        "utmCampaign": {
+                          "type": "string",
+                          "description": "UTM campaign.",
+                          "example": "Black friday"
+                        },
+                        "utmiPage": {
+                          "type": "string",
+                          "description": "utmi_page (internal utm).",
+                          "example": "utmi_page-example",
+                          "nullable": true
+                        },
+                        "utmiPart": {
+                          "type": "string",
+                          "description": "utmi_part (internal utm).",
+                          "example": "utmi_part-example",
+                          "nullable": true
+                        },
+                        "utmiCampaign": {
+                          "type": "string",
+                          "description": "utmi_campaign (internal utm).",
+                          "example": "utmi_campaign-example",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "sellers": {
+                      "type": "array",
+                      "description": "Information on each seller.",
+                      "items": {
+                        "description": "Seller information.",
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "Seller ID."
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Seller name."
+                          },
+                          "logo": {
+                            "type": "string",
+                            "description": "Seller logo.",
+                            "nullable": true
+                          }
+                        }
+                      }
+                    },
+                    "clientPreferencesData": {
+                      "type": "object",
+                      "description": "Object containing preferences from the client who placed the order.",
+                      "properties": {
+                        "locale": {
+                          "type": "string",
+                          "description": "Client's locale. Examples: `pt-BR` and `en-US`."
+                        },
+                        "optinNewsLetter": {
+                          "type": "boolean",
+                          "description": "`true` if the client opted to receive newsletter from the store.",
+                          "example": false,
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "commercialConditionData": {
+                      "type": "object",
+                      "description": "Object containing commercial condition information.",
+                      "nullable": true
+                    },
+                    "storePreferencesData": {
+                      "type": "object",
+                      "description": "Object containing data from the store's configuration (stored in VTEX's License Manager)."
+                    },
+                    "giftRegistryData": {
+                      "type": "object",
+                      "description": "Gift registry list information.",
+                      "nullable": true
+                    },
+                    "openTextField": {
+                      "type": "string",
+                      "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).",
+                      "example": "open-text-example",
+                      "nullable": true
+                    },
+                    "invoiceData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Invoice data including billing address.",
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Billing address.",
+                          "properties": {
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City name."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State name."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Country."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street name."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Street number."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Address complement."
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Reference for location."
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Geographic coordinates (latitude, longitude).",
+                              "items": {
+                                "type": "number"
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "customData": {
+                      "type": "object",
+                      "description": "Customer additional information.",
+                      "nullable": true
+                    },
+                    "itemMetadata": {
+                      "type": "object",
+                      "description": "Item metadata.",
+                      "properties": {
+                        "items": {
+                          "type": "array",
+                          "description": "List of objects containing metadata on each item in the order.",
+                          "items": {
+                            "description": "Item metadata.",
+                            "type": "object",
+                            "properties": {
+                              "id": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "seller": {
+                                "type": "string",
+                                "description": "Seller."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Product name."
+                              },
+                              "skuName": {
+                                "type": "string",
+                                "description": "SKU name."
+                              },
+                              "productId": {
+                                "type": "string",
+                                "description": "Product ID."
+                              },
+                              "refId": {
+                                "type": "string",
+                                "description": "Ref ID."
+                              },
+                              "ean": {
+                                "type": "string",
+                                "description": "European Article Number.",
+                                "nullable": true
+                              },
+                              "imageUrl": {
+                                "type": "string",
+                                "description": "Image URL."
+                              },
+                              "detailUrl": {
+                                "type": "string",
+                                "description": "Detail URL."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "hooksData": {
+                      "type": "object",
+                      "description": "Hooks information.",
+                      "nullable": true
+                    },
+                    "ratesAndBenefitsData": {
+                      "type": "object",
+                      "description": "Information on rates and benefits that apply to the order.",
+                      "properties": {
+                        "rateAndBenefitsIdentifiers": {
+                          "type": "array",
+                          "description": "List with rates and benefits identifiers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit identifier."
+                          }
+                        },
+                        "teaser": {
+                          "type": "array",
+                          "description": "List with rates and benefits teasers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit teaser."
+                          }
+                        }
+                      }
+                    },
+                    "subscriptionData": {
+                      "type": "object",
+                      "description": "Subscription information.",
+                      "nullable": true
+                    },
+                    "itemsOrdination": {
+                      "type": "object",
+                      "description": "Object containing information about the ordering of items within the `orderForm`.",
+                      "properties": {
+                        "criteria": {
+                          "type": "string",
+                          "description": "Criteria adopted to order the items in the list."
+                        },
+                        "ascending": {
+                          "type": "boolean",
+                          "description": "Indicates whether the ordering is ascending."
+                        }
+                      }
+                    }
+                  }
+                },
+                "example": {
+                  "orderFormId": "ede846222cd44046ba6c638442c3505a",
+                  "salesChannel": "1",
+                  "loggedIn": false,
+                  "isCheckedIn": false,
+                  "storeId": "1",
+                  "allowManualPrice": false,
+                  "canEditData": true,
+                  "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
+                  "profileProvider": "VTEX",
+                  "availableAccounts": [],
+                  "availableAddresses": [
+                    {
+                      "addressType": "residential",
+                      "receiverName": "Clark Kent",
+                      "addressId": "666c2e830bd9474ab6f6cc53fb6dd2d2",
+                      "isDisposable": true,
+                      "postalCode": "70386000",
+                      "city": "Brasília",
+                      "state": "DF",
+                      "country": "BRA",
+                      "street": "Rua da minha casa",
+                      "number": "123",
+                      "neighborhood": "Copacabana",
+                      "complement": "15º andar",
+                      "reference": null,
+                      "geoCoordinates": [
+                        -47.924747467041016,
+                        -15.832582473754883
+                      ]
+                    }
+                  ],
+                  "userType": "User type",
+                  "ignoreProfileData": false,
+                  "value": 34390,
+                  "messages": [],
+                  "items": [
+                    {
+                      "uniqueId": "9D6E447B3FF64CEDA33B17C01379C119",
+                      "id": "2",
+                      "productId": "2005",
+                      "productRefId": "1",
+                      "refId": "CBC30L",
+                      "ean": null,
+                      "name": "Chopp Brahma Claro 30L",
+                      "skuName": "Chopp Brahma Claro 30L",
+                      "modalType": null,
+                      "parentItemIndex": null,
+                      "parentAssemblyBinding": null,
+                      "assemblies": [],
+                      "priceValidUntil": "2022-07-13T18:30:46Z",
+                      "tax": 0,
+                      "taxCode": "54WC8ZN6K8",
+                      "price": 32890,
+                      "listPrice": 49900,
+                      "manualPrice": null,
+                      "manualPriceAppliedBy": null,
+                      "sellingPrice": 32890,
+                      "rewardValue": 0,
+                      "isGift": false,
+                      "additionalInfo": {
+                        "dimension": null,
+                        "brandName": "Brahma",
+                        "brandId": "2000000",
+                        "offeringInfo": null,
+                        "offeringType": null,
+                        "offeringTypeId": null
+                      },
+                      "preSaleDate": null,
+                      "productCategoryIds": "/1/",
+                      "productCategories": {
+                        "1": "Bebidas"
+                      },
+                      "quantity": 3,
+                      "seller": "1",
+                      "sellerChain": [
+                        "1"
+                      ],
+                      "imageUrl": "http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000",
+                      "detailUrl": "/chopp-brahma-claro-30l/p",
+                      "components": [],
+                      "bundleItems": [],
+                      "attachments": [],
+                      "attachmentOfferings": [
+                        {
+                          "name": "vtex.subscription.weekly",
+                          "required": false,
+                          "schema": {
+                            "vtex.subscription.key.frequency": {
+                              "MaximumNumberOfCharacters": 7,
+                              "Domain": [
+                                "1 week",
+                                "2 week",
+                                "3 week",
+                                "4 week"
+                              ]
+                            }
+                          }
+                        },
+                        {
+                          "name": "vtex.subscription.daily",
+                          "required": false,
+                          "schema": {
+                            "vtex.subscription.key.frequency": {
+                              "MaximumNumberOfCharacters": 5,
+                              "Domain": [
+                                "1 day"
+                              ]
+                            }
+                          }
+                        }
+                      ],
+                      "offerings": [],
+                      "priceTags": [
+                        {
+                          "name": "DISCOUNT@MANUALPRICE",
+                          "value": -5000,
+                          "rawValue": -50,
+                          "isPercentual": false,
+                          "identifier": "1234abc-5678b-1234c"
+                        }
+                      ],
+                      "availability": "available",
+                      "measurementUnit": "un",
+                      "unitMultiplier": 1,
+                      "manufacturerCode": null,
+                      "priceDefinition": {
+                        "calculatedSellingPrice": 32890,
+                        "total": 32890,
+                        "sellingPrices": [
+                          {
+                            "value": 32890,
+                            "quantity": 1
+                          }
+                        ]
+                      }
+                    }
+                  ],
+                  "selectableGifts": [],
+                  "totalizers": [
+                    {
+                      "id": "Items",
+                      "name": "Total dos Itens",
+                      "value": 15000
+                    }
+                  ],
+                  "shippingData": {
+                    "address": {
+                      "addressType": "residential",
+                      "receiverName": "Clark Kent",
+                      "addressId": "teste",
+                      "isDisposable": true,
+                      "postalCode": "70386000",
+                      "city": "Brasília",
+                      "state": "DF",
+                      "country": "BRA",
+                      "street": "Rua da minha casa",
+                      "number": "123",
+                      "neighborhood": "Copacabana",
+                      "complement": "15º andar",
+                      "reference": null,
+                      "geoCoordinates": [
+                        -47.924747467041016,
+                        -15.832582473754883
+                      ]
+                    },
+                    "logisticsInfo": [
+                      {
+                        "itemIndex": 0,
+                        "selectedSla": "Normal",
+                        "selectedDeliveryChannel": "delivery",
+                        "addressId": "teste",
+                        "slas": [
+                          {
+                            "id": "Normal",
+                            "deliveryChannel": "delivery",
+                            "name": "Normal",
+                            "deliveryIds": [
+                              {
+                                "courierId": "1",
+                                "warehouseId": "1_1",
+                                "dockId": "1",
+                                "courierName": "Transportadora",
+                                "quantity": 1,
+                                "kitItemDetails": []
+                              }
+                            ],
+                            "shippingEstimate": "3bd",
+                            "shippingEstimateDate": null,
+                            "lockTTL": "10d",
+                            "availableDeliveryWindows": [],
+                            "deliveryWindow": null,
+                            "price": 1500,
+                            "listPrice": 1500,
+                            "tax": 0,
+                            "pickupStoreInfo": {
+                              "isPickupStore": false,
+                              "friendlyName": null,
+                              "address": null,
+                              "additionalInfo": null,
+                              "dockId": null
+                            },
+                            "pickupPointId": null,
+                            "pickupDistance": 0,
+                            "polygonName": null,
+                            "transitTime": "3bd"
+                          }
+                        ],
+                        "shipsTo": [
+                          "BRA",
+                          "COL",
+                          "USA"
+                        ],
+                        "itemId": "2",
+                        "deliveryChannels": [
+                          {
+                            "id": "delivery"
+                          },
+                          {
+                            "id": "pickup-in-point"
+                          }
+                        ]
+                      }
+                    ],
+                    "selectedAddresses": [
+                      {
+                        "addressType": "residential",
+                        "receiverName": "Clark Kent",
+                        "addressId": "teste",
+                        "isDisposable": true,
+                        "postalCode": "12345000",
+                        "city": "Rio de Janeiro",
+                        "state": "RJ",
+                        "country": "BRA",
+                        "street": "Rua da minha casa",
+                        "number": "123",
+                        "neighborhood": "Copacabana",
+                        "complement": "15º andar",
+                        "reference": null,
+                        "geoCoordinates": [
+                          -47.924747467041016,
+                          -15.832582473754883
+                        ]
+                      }
+                    ],
+                    "availableAddresses": [
+                      {
+                        "addressType": "residential",
+                        "receiverName": "Clark Kent",
+                        "addressId": "teste",
+                        "isDisposable": true,
+                        "postalCode": "12345000",
+                        "city": "Rio de Janeiro",
+                        "state": "RJ",
+                        "country": "BRA",
+                        "street": "Rua da minha casa",
+                        "number": "123",
+                        "neighborhood": "Copacabana",
+                        "complement": "15º andar",
+                        "reference": null,
+                        "geoCoordinates": [
+                          -47.924747467041016,
+                          -15.832582473754883
+                        ]
+                      }
+                    ],
+                    "pickupPoints": []
+                  },
+                  "clientProfileData": {
+                    "email": "clark.kent@example.com",
+                    "firstName": "Clark",
+                    "lastName": "Kent",
+                    "document": "12345678900",
+                    "documentType": "cpf",
+                    "phone": "+5521998765432",
+                    "corporateName": "company-name",
+                    "tradeName": "trade-name",
+                    "corporateDocument": "12345678000100",
+                    "stateInscription": "12345678",
+                    "corporatePhone": "551100988887777",
+                    "isCorporate": false,
+                    "profileCompleteOnLoading": false,
+                    "profileErrorOnLoading": false,
+                    "customerClass": null
+                  },
+                  "paymentData": {
+                    "installmentOptions": [
+                      {
+                        "paymentSystem": 2,
+                        "bin": null,
+                        "paymentName": null,
+                        "paymentGroupName": null,
+                        "value": 15000,
+                        "installments": [
+                          {
+                            "count": 1,
+                            "hasInterestRate": false,
+                            "interestRate": 0,
+                            "value": 15000,
+                            "total": 15000,
+                            "sellerMerchantInstallments": [
+                              {
+                                "id": "LOJADOBRENO",
+                                "count": 1,
+                                "hasInterestRate": false,
+                                "interestRate": 0,
+                                "value": 15000,
+                                "total": 15000
+                              }
+                            ]
+                          },
+                          {
+                            "count": 2,
+                            "hasInterestRate": false,
+                            "interestRate": 0,
+                            "value": 7500,
+                            "total": 15000,
+                            "sellerMerchantInstallments": [
+                              {
+                                "id": "LOJADOBRENO",
+                                "count": 2,
+                                "hasInterestRate": false,
+                                "interestRate": 0,
+                                "value": 7500,
+                                "total": 15000
+                              }
+                            ]
+                          }
+                        ]
+                      }
+                    ],
+                    "paymentSystems": [
+                      {
+                        "id": 2,
+                        "name": "Visa",
+                        "groupName": "creditCardPaymentGroup",
+                        "validator": {
+                          "regex": "^2[1-8]{17}$",
+                          "mask": "9999 9999 9999 9999",
+                          "cardCodeRegex": "^[0-3]{8}$",
+                          "cardCodeMask": "999",
+                          "weights": [
+                            2,
+                            1,
+                            2,
+                            1,
+                            2,
+                            1
+                          ],
+                          "useCvv": true,
+                          "useExpirationDate": true,
+                          "useCardHolderName": true,
+                          "useBillingAddress": true
+                        },
+                        "stringId": "2",
+                        "template": "creditCardPaymentGroup-template",
+                        "requiresDocument": false,
+                        "isCustom": false,
+                        "description": "Payment description",
+                        "requiresAuthentication": false,
+                        "dueDate": "2020-03-05T14:59:00.7879306Z",
+                        "availablePayments": null
+                      }
+                    ],
+                    "payments": [
+                      {
+                        "paymentSystem": 6,
+                        "bin": null,
+                        "accountId": "12",
+                        "tokenId": null,
+                        "value": 34390,
+                        "referenceValue": 34390,
+                        "giftCardRedemptionCode": null,
+                        "giftCardProvider": null,
+                        "giftCardId": null
+                      }
+                    ],
+                    "giftCards": [],
+                    "giftCardMessages": [],
+                    "availableAccounts": [],
+                    "availableTokens": []
+                  },
+                  "marketingData": {
+                    "coupon": "free-shipping",
+                    "utmSource": "app",
+                    "utmMedium": "CPC",
+                    "utmCampaign": "Black friday",
+                    "utmipage": null,
+                    "utmiPart": null,
+                    "utmiCampaign": null
+                  },
+                  "sellers": [
+                    {
+                      "id": "1",
+                      "name": "lojadobreno",
+                      "logo": "Logo"
+                    }
+                  ],
+                  "clientPreferencesData": {
+                    "locale": "pt-BR",
+                    "optinNewsLetter": false
+                  },
+                  "commercialConditionData": null,
+                  "storePreferencesData": {
+                    "countryCode": "BRA",
+                    "saveUserData": true,
+                    "timeZone": "E. South America Standard Time",
+                    "currencyCode": "BRL",
+                    "currencyLocale": 1046,
+                    "currencySymboupdate cartl": "R$",
+                    "currencyFormatInfo": {
+                      "currencyDecimalDigits": 2,
+                      "currencyDecimalSeparator": ",",
+                      "currencyGroupSeparator": ".",
+                      "currencyGroupSize": 3,
+                      "startsWithCurrencySymbol": true
+                    }
+                  },
+                  "giftRegistryData": null,
+                  "openTextField": null,
+                  "invoiceData": null,
+                  "customData": null,
+                  "itemMetadata": {
+                    "items": [
+                      {
+                        "id": "1",
+                        "seller": "1",
+                        "name": "Ração Royal Canin Feline Urinary 500g",
+                        "skuName": "Ração Royal Canin Feline Urinary 500g",
+                        "productId": "1",
+                        "refId": "0001",
+                        "ean": "123456789",
+                        "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
+                        "detailUrl": "/racao-royal-canin-feline-urinary/p",
+                        "assemblyOptions": []
+                      }
+                    ]
+                  },
+                  "hooksData": null,
+                  "ratesAndBenefitsData": {
+                    "rateAndBenefitsIdentifiers": [],
+                    "teaser": []
+                  },
+                  "subscriptionData": null,
+                  "itemsOrdination": {
+                    "criteria": "NAME",
+                    "ascending": true
+                  }
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "patch": {
+        "tags": [
+          "Shopping cart"
+        ],
+        "summary": "Handle cart items",
+        "description": "You can use this request to:\n\r\n\r1. Change the quantity or price of one or more items to the shopping cart.\n\r2. Add a new item to the shopping cart.\r\n\r\n**Important**: To add a new item to the shopping cart, do not send the string `index` in the request body.\r\n\r\nThe [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.\n\r\n\r> This request has a time out of 45 seconds.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "ItemsHandle",
+        "security": [],
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "orderFormId",
+            "in": "path",
+            "description": "ID of the orderForm corresponding to the cart in which items will be handled.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "ede846222cd44046ba6c638442c3505a"
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "orderItems": {
+                    "type": "array",
+                    "description": "Array containing the cart items. Each object inside this array corresponds to a different item.",
+                    "items": {
+                      "required": [
+                        "id",
+                        "quantity",
+                        "seller"
+                      ],
+                      "type": "object",
+                      "description": "Cart item information.",
+                      "properties": {
+                        "id": {
+                          "type": "string",
+                          "description": "The ID of the SKU in VTEX platform.",
+                          "example": "2005"
+                        },
+                        "quantity": {
+                          "type": "integer",
+                          "format": "int32",
+                          "description": "The quantity of the item (SKU) in the cart.",
+                          "example": 3
+                        },
+                        "seller": {
+                          "type": "string",
+                          "description": "The seller responsible for the SKU.",
+                          "example": "1"
+                        },
+                        "index": {
+                          "type": "integer",
+                          "description": "The position of the item in the array. This string should be sent only to modify price or quantity of an item. NOTE: This string should not be sent when you are adding a new item to the cart.",
+                          "example": 0
+                        },
+                        "price": {
+                          "type": "integer",
+                          "description": "Price of the item in cents. Send this value in case you want to make a bulk price change.",
+                          "example": 1099
+                        },
+                        "attachments": {
+                          "type": "array",
+                          "description": "Array containing information on attachments.",
+                          "items": {
+                            "type": "object",
+                            "description": "Attachment information.",
+                            "properties": {
+                              "name": {
+                                "type": "string",
+                                "description": "Attachment identification.",
+                                "example": "Packages"
+                              },
+                              "content": {
+                                "type": "object",
+                                "description": "Attachment content data. E.g. `\"Do you want to receive packages?\": \"Yes\"`.",
+                                "nullable": true,
+                                "properties": {
+                                  "content": {
+                                    "type": "string",
+                                    "description": "Content referring to the customization requested by the customer.",
+                                    "example": "content-example"
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "noSplitItem": {
+                          "type": "boolean",
+                          "description": "Indicates whether the item can be splitted.",
+                          "example": false
+                        },
+                        "allowedOutdatedData": {
+                          "type": "array",
+                          "description": "In order to optimize performance, this parameter allows some information to not be updated when there are changes in the minicart. For instance, if a shopper adds another unit of a given SKU to the cart, it may not be necessary to recalculate payment information, which could impact performance. This array accepts strings and currently the only possible value is `\"paymentData\"`.",
+                          "items": {
+                            "type": "string",
+                            "description": "String that allows some information to not be updated when there are changes in the minicart.",
+                            "example": "paymentData"
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              },
+              "example": {
+                "orderItems": [
+                  {
+                    "id": "2005",
+                    "quantity": 3,
+                    "seller": "1",
+                    "index": 0,
+                    "price": 1099,
+                    "attachments": [
+                      {
+                        "name": "Packages",
+                        "content": {
+                          "content": "content-example"
+                        }
+                      }
+                    ],
+                    "noSplitItem": false,
+                    "allowedOutdatedData": [
+                      "paymentData"
+                    ]
+                  }
+                ]
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "orderFormId": {
+                      "type": "string",
+                      "description": "ID of the orderForm corresponding to a specific cart."
+                    },
+                    "salesChannel": {
+                      "type": "string",
+                      "description": "Attribute created by the seller, in their VTEX store configuration."
+                    },
+                    "loggedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether the user is logged into the store."
+                    },
+                    "isCheckedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether order is checked in."
+                    },
+                    "storeId": {
+                      "type": "string",
+                      "description": "ID of the store.",
+                      "nullable": true
+                    },
+                    "allowManualPrice": {
+                      "type": "boolean",
+                      "description": "Permission to modify item price manually."
+                    },
+                    "canEditData": {
+                      "type": "boolean",
+                      "description": "Data can be edited."
+                    },
+                    "userProfileId": {
+                      "type": "string",
+                      "description": "Unique ID associated with the customer profile."
+                    },
+                    "profileProvider": {
+                      "type": "string",
+                      "description": "Profile provider."
+                    },
+                    "availableAccounts": {
+                      "type": "array",
+                      "description": "Available accounts.",
+                      "items": {
+                        "type": "string",
+                        "description": "Account."
+                      }
+                    },
+                    "availableAddresses": {
+                      "type": "array",
+                      "description": "Information on each available address.",
+                      "items": {
+                        "description": "Address information.",
+                        "type": "object",
+                        "properties": {
+                          "addressType": {
+                            "type": "string",
+                            "description": "Address type."
+                          },
+                          "receiverName": {
+                            "type": "string",
+                            "description": "Name of the receiver."
+                          },
+                          "addressId": {
+                            "type": "string",
+                            "description": "Address ID.",
+                            "nullable": true
+                          },
+                          "isDisposable": {
+                            "type": "boolean",
+                            "description": "Indicates whether address is disposable."
+                          },
+                          "city": {
+                            "type": "string",
+                            "description": "City of the address."
+                          },
+                          "state": {
+                            "type": "string",
+                            "description": "State of the address."
+                          },
+                          "country": {
+                            "type": "string",
+                            "description": "Country of the address. ISO three-letter code."
+                          },
+                          "street": {
+                            "type": "string",
+                            "description": "Street of the address."
+                          },
+                          "number": {
+                            "type": "string",
+                            "description": "Number of the address."
+                          },
+                          "neighborhood": {
+                            "type": "string",
+                            "description": "Neighborhood of the address."
+                          },
+                          "complement": {
+                            "description": "Complement to the shipping address, in case it applies.",
+                            "type": "string",
+                            "nullable": true
+                          },
+                          "reference": {
+                            "type": "string",
+                            "description": "Reference that may help in the location of the address.",
+                            "nullable": true
+                          },
+                          "geoCoordinates": {
+                            "type": "array",
+                            "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                            "items": {
+                              "type": "number",
+                              "description": "Geocoordinates."
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "userType": {
+                      "type": "string",
+                      "description": "User type.",
+                      "nullable": true
+                    },
+                    "ignoreProfileData": {
+                      "type": "boolean",
+                      "description": "Ignore customer profile data."
+                    },
+                    "value": {
+                      "type": "integer",
+                      "description": "Total value of the order without separating cents. For example, $24.99 is represented as `2499`."
+                    },
+                    "messages": {
+                      "type": "array",
+                      "description": "Array containing an object for each message generated by our servers while processing the request.",
+                      "items": {
+                        "type": "string",
+                        "description": "Message."
+                      }
+                    },
+                    "items": {
+                      "type": "array",
+                      "description": "Information on each item in the order.",
+                      "items": {
+                        "description": "Item information.",
+                        "type": "object",
+                        "properties": {
+                          "uniqueId": {
+                            "type": "string",
+                            "description": "Unique ID."
+                          },
+                          "id": {
+                            "type": "string",
+                            "description": "ID of the item."
+                          },
+                          "productId": {
+                            "type": "string",
+                            "description": "Product ID."
+                          },
+                          "productRefId": {
+                            "type": "string",
+                            "description": "Product Ref ID."
+                          },
+                          "refId": {
+                            "type": "string",
+                            "description": "Ref ID."
+                          },
+                          "ean": {
+                            "type": "string",
+                            "description": "European Article Number.",
+                            "nullable": true
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Product name."
+                          },
+                          "skuName": {
+                            "type": "string",
+                            "description": "SKU name."
+                          },
+                          "modalType": {
+                            "type": "string",
+                            "description": "Modal type.",
+                            "nullable": true
+                          },
+                          "parentItemIndex": {
+                            "type": "integer",
+                            "description": "Parent item index.",
+                            "nullable": true
+                          },
+                          "parentAssemblyBinding": {
+                            "type": "string",
+                            "description": "Parent assembly binding.",
+                            "nullable": true
+                          },
+                          "priceValidUntil": {
+                            "type": "string",
+                            "description": "Price expiration date and time."
+                          },
+                          "tax": {
+                            "type": "integer",
+                            "description": "Tax value in cents."
+                          },
+                          "taxCode": {
+                            "type": "string",
+                            "description": "A unique identifier code assigned to a tax within the VTEX Admin."
+                          },
+                          "price": {
+                            "type": "integer",
+                            "description": "Price in cents."
+                          },
+                          "listPrice": {
+                            "type": "integer",
+                            "description": "List price in cents."
+                          },
+                          "manualPrice": {
+                            "type": "integer",
+                            "description": "Manual price in cents.",
+                            "nullable": true
+                          },
+                          "manualPriceAppliedBy": {
+                            "type": "string",
+                            "description": "User that applied the manual price, if that is the case.",
+                            "nullable": true
+                          },
+                          "sellingPrice": {
+                            "type": "integer",
+                            "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
+                          },
+                          "rewardValue": {
+                            "type": "integer",
+                            "description": "Reward value in cents."
+                          },
+                          "isGift": {
+                            "type": "boolean",
+                            "description": "Indicates whether item is a gift."
+                          },
+                          "additionalInfo": {
+                            "type": "object",
+                            "description": "Additional information.",
+                            "properties": {
+                              "dimension": {
+                                "type": "string",
+                                "description": "Dimension.",
+                                "nullable": true
+                              },
+                              "brandName": {
+                                "type": "string",
+                                "description": "Brand name."
+                              },
+                              "brandId": {
+                                "type": "string",
+                                "description": "Brand ID."
+                              },
+                              "offeringInfo": {
+                                "type": "string",
+                                "description": "Offering information.",
+                                "nullable": true
+                              },
+                              "offeringType": {
+                                "type": "string",
+                                "description": "Offering type.",
+                                "nullable": true
+                              },
+                              "offeringTypeId": {
+                                "type": "string",
+                                "description": "Offering type ID.",
+                                "nullable": true
+                              }
+                            }
+                          },
+                          "preSaleDate": {
+                            "type": "string",
+                            "description": "Presale date.",
+                            "nullable": true
+                          },
+                          "productCategoryIds": {
+                            "type": "string",
+                            "description": "Product category IDs."
+                          },
+                          "productCategories": {
+                            "type": "object",
+                            "description": "Object, where each field is an ID from `productCategoryIds`.",
+                            "properties": {
+                              "{ID}": {
+                                "type": "string",
+                                "description": "Product category corresponding to the ID in the field key."
+                              }
+                            }
+                          },
+                          "quantity": {
+                            "type": "integer",
+                            "description": "Quantity."
+                          },
+                          "seller": {
+                            "type": "string",
+                            "description": "Seller."
+                          },
+                          "sellerChain": {
+                            "type": "array",
+                            "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
+                            "items": {
+                              "type": "string",
+                              "description": "Seller."
+                            }
+                          },
+                          "imageUrl": {
+                            "type": "string",
+                            "description": "Image URL."
+                          },
+                          "detailUrl": {
+                            "type": "string",
+                            "description": "Detail URL."
+                          },
+                          "bundleItems": {
+                            "type": "array",
+                            "description": "Information on services sold along with the SKU. Example: a gift package.",
+                            "items": {
+                              "description": "Service information.",
+                              "type": "object",
+                              "properties": {
+                                "type": {
+                                  "type": "string",
+                                  "description": "Service type."
+                                },
+                                "id": {
+                                  "type": "integer",
+                                  "description": "Service identifier."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Service name."
+                                },
+                                "price": {
+                                  "type": "integer",
+                                  "description": "Service price in cents."
+                                }
+                              }
+                            }
+                          },
+                          "attachments": {
+                            "type": "array",
+                            "description": "Array containing information on attachments.",
+                            "items": {
+                              "type": "string",
+                              "description": "Attachment."
+                            }
+                          },
+                          "priceTags": {
+                            "type": "array",
+                            "description": "Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.",
+                            "items": {
+                              "description": "Price tag information.",
+                              "type": "object",
+                              "properties": {
+                                "identifier": {
+                                  "type": "string",
+                                  "description": "Promotion unique identifier.",
+                                  "nullable": true
+                                },
+                                "isPercentual": {
+                                  "type": "boolean",
+                                  "description": "Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\r\n- `type` indicates whether the tag refers to a discount or tax.\r\n- `where` specifies the context, either price or shipping.\r\n- `identifier` is the promotion ID.\r\n- `calculationId` is a hash that may vary with each price calculation."
+                                },
+                                "rawValue": {
+                                  "type": "number",
+                                  "description": "Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations."
+                                },
+                                "value": {
+                                  "type": "integer",
+                                  "description": "Price tag value representing either a promotion (value decrease) or a tax (value increase)."
+                                }
+                              }
+                            }
+                          },
+                          "availability": {
+                            "type": "string",
+                            "description": "Availability."
+                          },
+                          "measurementUnit": {
+                            "type": "string",
+                            "description": "Measurement unit."
+                          },
+                          "unitMultiplier": {
+                            "type": "integer",
+                            "description": "Unit multiplier."
+                          },
+                          "manufacturerCode": {
+                            "type": "string",
+                            "description": "Manufacturer code.",
+                            "nullable": true
+                          },
+                          "priceDefinition": {
+                            "type": "object",
+                            "description": "Price information for all units of a specific item.",
+                            "properties": {
+                              "calculatedSellingPrice": {
+                                "type": "integer",
+                                "description": "Item's calculated unitary selling price in cents."
+                              },
+                              "total": {
+                                "type": "integer",
+                                "description": "Total value for all units of the item in cents."
+                              },
+                              "sellingPrices": {
+                                "type": "array",
+                                "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
+                                "items": {
+                                  "description": "Rounding information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value in cents for that specific rounding."
+                                    },
+                                    "quantity": {
+                                      "type": "integer",
+                                      "description": "Rounding quantity, meaning how many items are rounded to this value."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "selectableGifts": {
+                      "type": "array",
+                      "description": "Array containing the data of the item selected as a gift.",
+                      "items": {
+                        "type": "string",
+                        "description": "Gift."
+                      }
+                    },
+                    "totalizers": {
+                      "type": "array",
+                      "description": "Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).",
+                      "items": {
+                        "type": "object",
+                        "description": "Totalizer of purchases."
+                      }
+                    },
+                    "shippingData": {
+                      "type": "object",
+                      "description": "Shipping information pertinent to the order.",
+                      "nullable": true,
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Address information.",
+                          "nullable": true,
+                          "properties": {
+                            "addressType": {
+                              "type": "string",
+                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                            },
+                            "receiverName": {
+                              "type": "string",
+                              "description": "Name of the person who is going to receive the order."
+                            },
+                            "addressId": {
+                              "type": "string",
+                              "description": "Address ID.",
+                              "nullable": true
+                            },
+                            "isDisposable": {
+                              "type": "boolean",
+                              "description": "Indicates whether address is disposable."
+                            },
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City of the shipping address."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State of the shipping address."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Three letter ISO code of the country of the shipping address."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street of the shipping address."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Number of the building, house or apartment in the shipping address."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood of the shipping address."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Complement to the shipping address, in case it applies.",
+                              "nullable": true
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                              "nullable": true
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                              "items": {
+                                "type": "number",
+                                "description": "Geocoordinates."
+                              }
+                            }
+                          }
+                        },
+                        "logisticsInfo": {
+                          "type": "array",
+                          "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.",
+                          "items": {
+                            "description": "Logistics information.",
+                            "type": "object",
+                            "properties": {
+                              "itemIndex": {
+                                "type": "integer",
+                                "description": "Index corresponding to the position of the object in the `items` array."
+                              },
+                              "selectedSla": {
+                                "type": "string",
+                                "description": "SLA selected by the customer.",
+                                "nullable": true
+                              },
+                              "selectedDeliveryChannel": {
+                                "type": "string",
+                                "description": "Delivery channel selected by the customer.",
+                                "nullable": true
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "slas": {
+                                "type": "array",
+                                "description": "Information on available SLAs.",
+                                "items": {
+                                  "description": "SLA information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "SLA ID."
+                                    },
+                                    "deliveryChannel": {
+                                      "type": "string",
+                                      "description": "Delivery channel."
+                                    },
+                                    "name": {
+                                      "type": "string",
+                                      "description": "SLA name."
+                                    },
+                                    "deliveryIds": {
+                                      "type": "array",
+                                      "description": "Information on each delivery ID.",
+                                      "items": {
+                                        "description": "Delivery ID information.",
+                                        "type": "object",
+                                        "properties": {
+                                          "courierId": {
+                                            "type": "string",
+                                            "description": "Courier ID."
+                                          },
+                                          "warehouseId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "dockId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "courierName": {
+                                            "type": "string",
+                                            "description": "Courier name."
+                                          },
+                                          "quantity": {
+                                            "type": "integer",
+                                            "description": "Quantity."
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "attachmentOfferings": {
+                                      "type": "array",
+                                      "description": "List of attachments details.",
+                                      "nullable": true,
+                                      "items": {
+                                        "description": "Attachment details.",
+                                        "type": "object",
+                                        "required": [
+                                          "name",
+                                          "required",
+                                          "schema"
+                                        ],
+                                        "properties": {
+                                          "name": {
+                                            "type": "string",
+                                            "description": "Name of the attachment.",
+                                            "nullable": true
+                                          },
+                                          "required": {
+                                            "type": "boolean",
+                                            "description": "Defines if the attachment is required (`true`) or not (`false`).",
+                                            "nullable": true
+                                          },
+                                          "schema": {
+                                            "type": "object",
+                                            "description": "Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).",
+                                            "nullable": true
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "shippingEstimate": {
+                                      "type": "string",
+                                      "description": "Shipping estimate. For instance, \"three business days\" will be represented as `3bd`."
+                                    },
+                                    "shippingEstimateDate": {
+                                      "type": "string",
+                                      "description": "When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.",
+                                      "nullable": true
+                                    },
+                                    "useIndividualShippingEstimates": {
+                                      "type": "boolean",
+                                      "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`."
+                                    },
+                                    "lockTTL": {
+                                      "type": "string",
+                                      "description": "Estimate date of delivery.",
+                                      "nullable": true
+                                    },
+                                    "price": {
+                                      "type": "integer",
+                                      "description": "Price in cents."
+                                    },
+                                    "listPrice": {
+                                      "type": "integer",
+                                      "description": "List price in cents."
+                                    },
+                                    "tax": {
+                                      "type": "integer",
+                                      "description": "Tax in cents."
+                                    },
+                                    "pickupStoreInfo": {
+                                      "type": "object",
+                                      "description": "Information on the pickup store.",
+                                      "properties": {
+                                        "isPickupStore": {
+                                          "type": "boolean",
+                                          "description": "Indicates whether it is the pickup store."
+                                        },
+                                        "friendlyName": {
+                                          "type": "string",
+                                          "description": "Friendly name.",
+                                          "nullable": true
+                                        },
+                                        "address": {
+                                          "type": "object",
+                                          "description": "Address information.",
+                                          "nullable": true,
+                                          "properties": {
+                                            "addressType": {
+                                              "type": "string",
+                                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                                            },
+                                            "postalCode": {
+                                              "type": "string",
+                                              "description": "Postal code."
+                                            },
+                                            "city": {
+                                              "type": "string",
+                                              "description": "City of the shipping address."
+                                            },
+                                            "state": {
+                                              "type": "string",
+                                              "description": "State of the shipping address."
+                                            },
+                                            "country": {
+                                              "type": "string",
+                                              "description": "Three letter ISO code of the country of the shipping address."
+                                            },
+                                            "street": {
+                                              "type": "string",
+                                              "description": "Street of the shipping address."
+                                            },
+                                            "number": {
+                                              "type": "string",
+                                              "description": "Number of the building, house or apartment in the shipping address."
+                                            },
+                                            "neighborhood": {
+                                              "type": "string",
+                                              "description": "Neighborhood of the shipping address."
+                                            },
+                                            "complement": {
+                                              "type": "string",
+                                              "description": "Complement to the shipping address, in case it applies.",
+                                              "nullable": true
+                                            },
+                                            "reference": {
+                                              "type": "string",
+                                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                              "nullable": true
+                                            },
+                                            "geoCoordinates": {
+                                              "type": "array",
+                                              "description": "Array with two strings that repesent geocoordinates: first latitude, then longitude.",
+                                              "items": {
+                                                "type": "number",
+                                                "description": "Geocoordinates."
+                                              }
+                                            }
+                                          }
+                                        },
+                                        "additionalInfo": {
+                                          "type": "string",
+                                          "description": "Additional information.",
+                                          "nullable": true
+                                        },
+                                        "dockId": {
+                                          "type": "string",
+                                          "description": "Corresponding dock ID.",
+                                          "nullable": true
+                                        }
+                                      }
+                                    },
+                                    "pickupPointId": {
+                                      "type": "string",
+                                      "description": "Pickup point ID.",
+                                      "nullable": true
+                                    },
+                                    "pickupDistance": {
+                                      "type": "integer",
+                                      "description": "Pickup point distance."
+                                    },
+                                    "polygonName": {
+                                      "type": "string",
+                                      "description": "Polygon name.",
+                                      "nullable": true
+                                    },
+                                    "transitTime": {
+                                      "type": "string",
+                                      "description": "Transit time. For instance, \"three business days\" is represented as `3bd`."
+                                    }
+                                  }
+                                }
+                              },
+                              "shipsTo": {
+                                "type": "array",
+                                "description": "List of countries that the item may be shipped to.",
+                                "items": {
+                                  "type": "string",
+                                  "description": "Three letter country code."
+                                }
+                              },
+                              "itemId": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "deliveryChannels": {
+                                "type": "array",
+                                "description": "List of available delivery channels.",
+                                "items": {
+                                  "description": "Delivery channel information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "Delivery channel ID."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "selectedAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the selected addresses for the order.",
+                          "items": {
+                            "description": "Selected address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "availableAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the available addresses for the order.",
+                          "items": {
+                            "description": "Available address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "clientProfileData": {
+                      "type": "object",
+                      "description": "Customer's profile information.",
+                      "nullable": true,
+                      "properties": {
+                        "email": {
+                          "type": "string",
+                          "description": "Email address.",
+                          "nullable": true
+                        },
+                        "firstName": {
+                          "type": "string",
+                          "description": "First name.",
+                          "nullable": true
+                        },
+                        "lastName": {
+                          "type": "string",
+                          "description": "Last name."
+                        },
+                        "documentType": {
+                          "type": "string",
+                          "description": "Type of the document informed by the customer."
+                        },
+                        "document": {
+                          "type": "string",
+                          "description": "Document informed by the customer."
+                        },
+                        "phone": {
+                          "type": "string",
+                          "description": "Phone number."
+                        },
+                        "corporateName": {
+                          "type": "string",
+                          "description": "Company name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "tradeName": {
+                          "type": "string",
+                          "description": "Trade name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporateDocument": {
+                          "type": "string",
+                          "description": "Corporate document, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "stateInscription": {
+                          "type": "string",
+                          "description": "State inscription, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporatePhone": {
+                          "type": "string",
+                          "description": "Corporate phone number, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "isCorporate": {
+                          "type": "boolean",
+                          "description": "Indicates whether the customer is a legal entity."
+                        },
+                        "profileCompleteOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile is complete on loading."
+                        },
+                        "profileErrorOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile presents error on loading.",
+                          "nullable": true
+                        },
+                        "customerClass": {
+                          "type": "string",
+                          "description": "Customer class.",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "paymentData": {
+                      "type": "object",
+                      "description": "Information on the order's payment.",
+                      "properties": {
+                        "giftCards": {
+                          "type": "array",
+                          "description": "Gift card information, if it applies to the order.",
+                          "items": {
+                            "description": "Gift card information.",
+                            "type": "object",
+                            "properties": {
+                              "redemptionCode": {
+                                "type": "string",
+                                "description": "Gift card redemption code."
+                              },
+                              "value": {
+                                "type": "integer",
+                                "description": "Gift card value in cents."
+                              },
+                              "balance": {
+                                "type": "integer",
+                                "description": "Gift card balance in cents."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Gift card name."
+                              },
+                              "id": {
+                                "type": "string",
+                                "description": "Gift card ID."
+                              },
+                              "inUse": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is in use."
+                              },
+                              "isSpecialCard": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is special."
+                              }
+                            }
+                          }
+                        },
+                        "transactions": {
+                          "type": "array",
+                          "description": "Information on each transaction pertinent to the order.",
+                          "items": {
+                            "description": "Transaction information.",
+                            "nullable": true,
+                            "type": "object",
+                            "properties": {
+                              "isActive": {
+                                "type": "boolean",
+                                "description": "Indicates whether transaction is active."
+                              },
+                              "transactionId": {
+                                "type": "string",
+                                "description": "Transaction ID."
+                              },
+                              "merchantName": {
+                                "type": "string",
+                                "description": "Merchant name."
+                              },
+                              "payments": {
+                                "type": "array",
+                                "description": "Information on each payment.",
+                                "items": {
+                                  "description": "Payment information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "accountId": {
+                                      "type": "string",
+                                      "description": "Account ID."
+                                    },
+                                    "bin": {
+                                      "type": "string",
+                                      "description": "Bin.",
+                                      "nullable": true
+                                    },
+                                    "installments": {
+                                      "type": "integer",
+                                      "description": "Number of installments."
+                                    },
+                                    "paymentSystem": {
+                                      "type": "string",
+                                      "description": "Payment system."
+                                    },
+                                    "referenceValue": {
+                                      "type": "integer",
+                                      "description": "Reference value for calculating interest rates, in case it applies. Displayed in cents."
+                                    },
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value including interest, in case it applies. Displayed in cents."
+                                    }
+                                  }
+                                }
+                              },
+                              "sharedTransaction": {
+                                "type": "boolean",
+                                "description": "Indicates whather transaction is shared."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "marketingData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Object containing promotion data such as coupon tracking information and internal or external UTMs.",
+                      "properties": {
+                        "coupon": {
+                          "type": "string",
+                          "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.",
+                          "example": "free-shipping"
+                        },
+                        "utmSource": {
+                          "type": "string",
+                          "description": "UTM source.",
+                          "example": "Facebook"
+                        },
+                        "utmMedium": {
+                          "type": "string",
+                          "description": "UTM medium.",
+                          "example": "CPC"
+                        },
+                        "utmCampaign": {
+                          "type": "string",
+                          "description": "UTM campaign.",
+                          "example": "Black friday"
+                        },
+                        "utmiPage": {
+                          "type": "string",
+                          "description": "utmi_page (internal utm).",
+                          "example": "utmi_page-example",
+                          "nullable": true
+                        },
+                        "utmiPart": {
+                          "type": "string",
+                          "description": "utmi_part (internal utm).",
+                          "example": "utmi_part-example",
+                          "nullable": true
+                        },
+                        "utmiCampaign": {
+                          "type": "string",
+                          "description": "utmi_campaign (internal utm).",
+                          "example": "utmi_campaign-example",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "sellers": {
+                      "type": "array",
+                      "description": "Information on each seller.",
+                      "items": {
+                        "description": "Seller information.",
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "Seller ID."
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Seller name."
+                          },
+                          "logo": {
+                            "type": "string",
+                            "description": "Seller logo.",
+                            "nullable": true
+                          }
+                        }
+                      }
+                    },
+                    "clientPreferencesData": {
+                      "type": "object",
+                      "description": "Object containing preferences from the client who placed the order.",
+                      "properties": {
+                        "locale": {
+                          "type": "string",
+                          "description": "Client's locale. Examples: `pt-BR` and `en-US`."
+                        },
+                        "optinNewsLetter": {
+                          "type": "boolean",
+                          "description": "`true` if the client opted to receive newsletter from the store.",
+                          "example": false,
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "commercialConditionData": {
+                      "type": "object",
+                      "description": "Object containing commercial condition information.",
+                      "nullable": true
+                    },
+                    "storePreferencesData": {
+                      "type": "object",
+                      "description": "Object containing data from the store's configuration (stored in VTEX's License Manager)."
+                    },
+                    "giftRegistryData": {
+                      "type": "object",
+                      "description": "Gift registry list information.",
+                      "nullable": true
+                    },
+                    "openTextField": {
+                      "type": "string",
+                      "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).",
+                      "example": "open-text-example",
+                      "nullable": true
+                    },
+                    "invoiceData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Invoice data including billing address.",
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Billing address.",
+                          "properties": {
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City name."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State name."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Country."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street name."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Street number."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Address complement."
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Reference for location."
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Geographic coordinates (latitude, longitude).",
+                              "items": {
+                                "type": "number"
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "customData": {
+                      "type": "object",
+                      "description": "Customer additional information.",
+                      "nullable": true
+                    },
+                    "itemMetadata": {
+                      "type": "object",
+                      "description": "Item metadata.",
+                      "properties": {
+                        "items": {
+                          "type": "array",
+                          "description": "List of objects containing metadata on each item in the order.",
+                          "items": {
+                            "description": "Item metadata.",
+                            "type": "object",
+                            "properties": {
+                              "id": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "seller": {
+                                "type": "string",
+                                "description": "Seller."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Product name."
+                              },
+                              "skuName": {
+                                "type": "string",
+                                "description": "SKU name."
+                              },
+                              "productId": {
+                                "type": "string",
+                                "description": "Product ID."
+                              },
+                              "refId": {
+                                "type": "string",
+                                "description": "Ref ID."
+                              },
+                              "ean": {
+                                "type": "string",
+                                "description": "European Article Number.",
+                                "nullable": true
+                              },
+                              "imageUrl": {
+                                "type": "string",
+                                "description": "Image URL."
+                              },
+                              "detailUrl": {
+                                "type": "string",
+                                "description": "Detail URL."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "hooksData": {
+                      "type": "object",
+                      "description": "Hooks information.",
+                      "nullable": true
+                    },
+                    "ratesAndBenefitsData": {
+                      "type": "object",
+                      "description": "Information on rates and benefits that apply to the order.",
+                      "properties": {
+                        "rateAndBenefitsIdentifiers": {
+                          "type": "array",
+                          "description": "List with rates and benefits identifiers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit identifier."
+                          }
+                        },
+                        "teaser": {
+                          "type": "array",
+                          "description": "List with rates and benefits teasers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit teaser."
+                          }
+                        }
+                      }
+                    },
+                    "subscriptionData": {
+                      "type": "object",
+                      "description": "Subscription information.",
+                      "nullable": true
+                    },
+                    "itemsOrdination": {
+                      "type": "object",
+                      "description": "Object containing information about the ordering of items within the `orderForm`.",
+                      "properties": {
+                        "criteria": {
+                          "type": "string",
+                          "description": "Criteria adopted to order the items in the list."
+                        },
+                        "ascending": {
+                          "type": "boolean",
+                          "description": "Indicates whether the ordering is ascending."
+                        }
+                      }
+                    }
+                  }
+                },
+                "example": {
+                  "orderFormId": "ede846222cd44046ba6c638442c3505a",
+                  "salesChannel": "1",
+                  "loggedIn": false,
+                  "isCheckedIn": false,
+                  "storeId": "1",
+                  "allowManualPrice": false,
+                  "canEditData": true,
+                  "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
+                  "profileProvider": "VTEX",
+                  "availableAccounts": [],
+                  "availableAddresses": [
+                    {
+                      "addressType": "residential",
+                      "receiverName": "Clark Kent",
+                      "addressId": "666c2e830bd9474ab6f6cc53fb6dd2d2",
+                      "isDisposable": true,
+                      "postalCode": "70386000",
+                      "city": "Brasília",
+                      "state": "DF",
+                      "country": "BRA",
+                      "street": "Rua da minha casa",
+                      "number": "123",
+                      "neighborhood": "Copacabana",
+                      "complement": "15º andar",
+                      "reference": null,
+                      "geoCoordinates": [
+                        -47.924747467041016,
+                        -15.832582473754883
+                      ]
+                    }
+                  ],
+                  "userType": "User type",
+                  "ignoreProfileData": false,
+                  "value": 34390,
+                  "messages": [],
+                  "items": [
+                    {
+                      "uniqueId": "9D6E447B3FF64CEDA33B17C01379C119",
+                      "id": "2",
+                      "productId": "2005",
+                      "productRefId": "1",
+                      "refId": "CBC30L",
+                      "ean": null,
+                      "name": "Chopp Brahma Claro 30L",
+                      "skuName": "Chopp Brahma Claro 30L",
+                      "modalType": null,
+                      "parentItemIndex": null,
+                      "parentAssemblyBinding": null,
+                      "assemblies": [],
+                      "priceValidUntil": "2022-07-13T18:30:46Z",
+                      "tax": 0,
+                      "taxCode": "54WC8ZN6K8",
+                      "price": 32890,
+                      "listPrice": 49900,
+                      "manualPrice": null,
+                      "manualPriceAppliedBy": null,
+                      "sellingPrice": 32890,
+                      "rewardValue": 0,
+                      "isGift": false,
+                      "additionalInfo": {
+                        "dimension": null,
+                        "brandName": "Brahma",
+                        "brandId": "2000000",
+                        "offeringInfo": null,
+                        "offeringType": null,
+                        "offeringTypeId": null
+                      },
+                      "preSaleDate": null,
+                      "productCategoryIds": "/1/",
+                      "productCategories": {
+                        "1": "Bebidas"
+                      },
+                      "quantity": 3,
+                      "seller": "1",
+                      "sellerChain": [
+                        "1"
+                      ],
+                      "imageUrl": "http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000",
+                      "detailUrl": "/chopp-brahma-claro-30l/p",
+                      "components": [],
+                      "bundleItems": [],
+                      "attachments": [],
+                      "attachmentOfferings": [
+                        {
+                          "name": "vtex.subscription.weekly",
+                          "required": false,
+                          "schema": {
+                            "vtex.subscription.key.frequency": {
+                              "MaximumNumberOfCharacters": 7,
+                              "Domain": [
+                                "1 week",
+                                "2 week",
+                                "3 week",
+                                "4 week"
+                              ]
+                            }
+                          }
+                        },
+                        {
+                          "name": "vtex.subscription.daily",
+                          "required": false,
+                          "schema": {
+                            "vtex.subscription.key.frequency": {
+                              "MaximumNumberOfCharacters": 5,
+                              "Domain": [
+                                "1 day"
+                              ]
+                            }
+                          }
+                        }
+                      ],
+                      "offerings": [],
+                      "priceTags": [
+                        {
+                          "name": "DISCOUNT@MANUALPRICE",
+                          "value": -5000,
+                          "rawValue": -50,
+                          "isPercentual": false,
+                          "identifier": "1234abc-5678b-1234c"
+                        }
+                      ],
+                      "availability": "available",
+                      "measurementUnit": "un",
+                      "unitMultiplier": 1,
+                      "manufacturerCode": null,
+                      "priceDefinition": {
+                        "calculatedSellingPrice": 32890,
+                        "total": 32890,
+                        "sellingPrices": [
+                          {
+                            "value": 32890,
+                            "quantity": 1
+                          }
+                        ]
+                      }
+                    }
+                  ],
+                  "selectableGifts": [],
+                  "totalizers": [
+                    {
+                      "id": "Items",
+                      "name": "Total dos Itens",
+                      "value": 15000
+                    }
+                  ],
+                  "shippingData": {
+                    "address": {
+                      "addressType": "residential",
+                      "receiverName": "Clark Kent",
+                      "addressId": "teste",
+                      "isDisposable": true,
+                      "postalCode": "70386000",
+                      "city": "Brasília",
+                      "state": "DF",
+                      "country": "BRA",
+                      "street": "Rua da minha casa",
+                      "number": "123",
+                      "neighborhood": "Copacabana",
+                      "complement": "15º andar",
+                      "reference": null,
+                      "geoCoordinates": [
+                        -47.924747467041016,
+                        -15.832582473754883
+                      ]
+                    },
+                    "logisticsInfo": [
+                      {
+                        "itemIndex": 0,
+                        "selectedSla": "Normal",
+                        "selectedDeliveryChannel": "delivery",
+                        "addressId": "teste",
+                        "slas": [
+                          {
+                            "id": "Normal",
+                            "deliveryChannel": "delivery",
+                            "name": "Normal",
+                            "deliveryIds": [
+                              {
+                                "courierId": "1",
+                                "warehouseId": "1_1",
+                                "dockId": "1",
+                                "courierName": "Transportadora",
+                                "quantity": 1,
+                                "kitItemDetails": []
+                              }
+                            ],
+                            "shippingEstimate": "3bd",
+                            "shippingEstimateDate": null,
+                            "lockTTL": "10d",
+                            "availableDeliveryWindows": [],
+                            "deliveryWindow": null,
+                            "price": 1500,
+                            "listPrice": 1500,
+                            "tax": 0,
+                            "pickupStoreInfo": {
+                              "isPickupStore": false,
+                              "friendlyName": null,
+                              "address": null,
+                              "additionalInfo": null,
+                              "dockId": null
+                            },
+                            "pickupPointId": null,
+                            "pickupDistance": 0,
+                            "polygonName": null,
+                            "transitTime": "3bd"
+                          }
+                        ],
+                        "shipsTo": [
+                          "BRA",
+                          "COL",
+                          "USA"
+                        ],
+                        "itemId": "2",
+                        "deliveryChannels": [
+                          {
+                            "id": "delivery"
+                          },
+                          {
+                            "id": "pickup-in-point"
+                          }
+                        ]
+                      }
+                    ],
+                    "selectedAddresses": [
+                      {
+                        "addressType": "residential",
+                        "receiverName": "Clark Kent",
+                        "addressId": "teste",
+                        "isDisposable": true,
+                        "postalCode": "12345000",
+                        "city": "Rio de Janeiro",
+                        "state": "RJ",
+                        "country": "BRA",
+                        "street": "Rua da minha casa",
+                        "number": "123",
+                        "neighborhood": "Copacabana",
+                        "complement": "15º andar",
+                        "reference": null,
+                        "geoCoordinates": [
+                          -47.924747467041016,
+                          -15.832582473754883
+                        ]
+                      }
+                    ],
+                    "availableAddresses": [
+                      {
+                        "addressType": "residential",
+                        "receiverName": "Clark Kent",
+                        "addressId": "teste",
+                        "isDisposable": true,
+                        "postalCode": "12345000",
+                        "city": "Rio de Janeiro",
+                        "state": "RJ",
+                        "country": "BRA",
+                        "street": "Rua da minha casa",
+                        "number": "123",
+                        "neighborhood": "Copacabana",
+                        "complement": "15º andar",
+                        "reference": null,
+                        "geoCoordinates": [
+                          -47.924747467041016,
+                          -15.832582473754883
+                        ]
+                      }
+                    ],
+                    "pickupPoints": []
+                  },
+                  "clientProfileData": {
+                    "email": "clark.kent@example.com",
+                    "firstName": "Clark",
+                    "lastName": "Kent",
+                    "document": "12345678900",
+                    "documentType": "cpf",
+                    "phone": "+5521998765432",
+                    "corporateName": "company-name",
+                    "tradeName": "trade-name",
+                    "corporateDocument": "12345678000100",
+                    "stateInscription": "12345678",
+                    "corporatePhone": "551100988887777",
+                    "isCorporate": false,
+                    "profileCompleteOnLoading": false,
+                    "profileErrorOnLoading": false,
+                    "customerClass": null
+                  },
+                  "paymentData": {
+                    "installmentOptions": [
+                      {
+                        "paymentSystem": 2,
+                        "bin": null,
+                        "paymentName": null,
+                        "paymentGroupName": null,
+                        "value": 15000,
+                        "installments": [
+                          {
+                            "count": 1,
+                            "hasInterestRate": false,
+                            "interestRate": 0,
+                            "value": 15000,
+                            "total": 15000,
+                            "sellerMerchantInstallments": [
+                              {
+                                "id": "LOJADOBRENO",
+                                "count": 1,
+                                "hasInterestRate": false,
+                                "interestRate": 0,
+                                "value": 15000,
+                                "total": 15000
+                              }
+                            ]
+                          },
+                          {
+                            "count": 2,
+                            "hasInterestRate": false,
+                            "interestRate": 0,
+                            "value": 7500,
+                            "total": 15000,
+                            "sellerMerchantInstallments": [
+                              {
+                                "id": "LOJADOBRENO",
+                                "count": 2,
+                                "hasInterestRate": false,
+                                "interestRate": 0,
+                                "value": 7500,
+                                "total": 15000
+                              }
+                            ]
+                          }
+                        ]
+                      }
+                    ],
+                    "paymentSystems": [
+                      {
+                        "id": 2,
+                        "name": "Visa",
+                        "groupName": "creditCardPaymentGroup",
+                        "validator": {
+                          "regex": "^2[1-8]{17}$",
+                          "mask": "9999 9999 9999 9999",
+                          "cardCodeRegex": "^[0-3]{8}$",
+                          "cardCodeMask": "999",
+                          "weights": [
+                            2,
+                            1,
+                            2,
+                            1,
+                            2,
+                            1
+                          ],
+                          "useCvv": true,
+                          "useExpirationDate": true,
+                          "useCardHolderName": true,
+                          "useBillingAddress": true
+                        },
+                        "stringId": "2",
+                        "template": "creditCardPaymentGroup-template",
+                        "requiresDocument": false,
+                        "isCustom": false,
+                        "description": "Payment description",
+                        "requiresAuthentication": false,
+                        "dueDate": "2020-03-05T14:59:00.7879306Z",
+                        "availablePayments": null
+                      }
+                    ],
+                    "payments": [
+                      {
+                        "paymentSystem": 6,
+                        "bin": null,
+                        "accountId": "12",
+                        "tokenId": null,
+                        "value": 34390,
+                        "referenceValue": 34390,
+                        "giftCardRedemptionCode": null,
+                        "giftCardProvider": null,
+                        "giftCardId": null
+                      }
+                    ],
+                    "giftCards": [],
+                    "giftCardMessages": [],
+                    "availableAccounts": [],
+                    "availableTokens": []
+                  },
+                  "marketingData": {
+                    "coupon": "free-shipping",
+                    "utmSource": "app",
+                    "utmMedium": "CPC",
+                    "utmCampaign": "Black friday",
+                    "utmipage": null,
+                    "utmiPart": null,
+                    "utmiCampaign": null
+                  },
+                  "sellers": [
+                    {
+                      "id": "1",
+                      "name": "lojadobreno",
+                      "logo": "Logo"
+                    }
+                  ],
+                  "clientPreferencesData": {
+                    "locale": "pt-BR",
+                    "optinNewsLetter": false
+                  },
+                  "commercialConditionData": null,
+                  "storePreferencesData": {
+                    "countryCode": "BRA",
+                    "saveUserData": true,
+                    "timeZone": "E. South America Standard Time",
+                    "currencyCode": "BRL",
+                    "currencyLocale": 1046,
+                    "currencySymboupdate cartl": "R$",
+                    "currencyFormatInfo": {
+                      "currencyDecimalDigits": 2,
+                      "currencyDecimalSeparator": ",",
+                      "currencyGroupSeparator": ".",
+                      "currencyGroupSize": 3,
+                      "startsWithCurrencySymbol": true
+                    }
+                  },
+                  "giftRegistryData": null,
+                  "openTextField": null,
+                  "invoiceData": null,
+                  "customData": null,
+                  "itemMetadata": {
+                    "items": [
+                      {
+                        "id": "1",
+                        "seller": "1",
+                        "name": "Ração Royal Canin Feline Urinary 500g",
+                        "skuName": "Ração Royal Canin Feline Urinary 500g",
+                        "productId": "1",
+                        "refId": "0001",
+                        "ean": "123456789",
+                        "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
+                        "detailUrl": "/racao-royal-canin-feline-urinary/p",
+                        "assemblyOptions": []
+                      }
+                    ]
+                  },
+                  "hooksData": null,
+                  "ratesAndBenefitsData": {
+                    "rateAndBenefitsIdentifiers": [],
+                    "teaser": []
+                  },
+                  "subscriptionData": null,
+                  "itemsOrdination": {
+                    "criteria": "NAME",
+                    "ascending": true
+                  }
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/api/checkout/pub/orderForm/{orderFormId}/items/{itemIndex}/price": {
+      "put": {
+        "tags": [
+          "Shopping cart"
+        ],
+        "summary": "Change price of an SKU in a cart",
+        "description": "This request changes the price of an SKU in a cart.\r\n\r\nThe [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.\n\r\n\rYou need to inform which cart you are referring to, by sending its `orderFormId` and what is the item whose price you want to change, by sending its `itemIndex`.\n\r\n\rYou also need to pass the new price value in the body.\n\r\n\rRemember that, to use this endpoint, the feature of *manual price* must be active. To check if it's active, use the [Get orderForm configuration](https://developers.vtex.com/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`.\n\r\n\r> Whenever you use this request to change the price of an item, all items in that cart with the same SKU are affected by this change. This applies even to items that share the SKU but have been separated into different objects in the `items` array due to customizations or attachments, for example.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "PriceChange",
+        "parameters": [
+          {
+            "name": "orderFormId",
+            "in": "path",
+            "description": "ID of the orderForm corresponding to the cart whose items will have the price changed.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "ede846222cd44046ba6c638442c3505a"
+            }
+          },
+          {
+            "name": "itemIndex",
+            "in": "path",
+            "description": "The index of the item in the cart. Each cart item is identified by an index, starting in 0.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "0"
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "required": [
+                  "price"
+                ],
+                "type": "object",
+                "properties": {
+                  "price": {
+                    "type": "integer",
+                    "format": "int32",
+                    "description": "The new price of the item."
+                  }
+                },
+                "example": {
+                  "price": 10000
+                }
+              },
+              "example": {
+                "price": 10000
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "example": {
+                  "orderFormId": "ede846222cd44046ba6c638442c3505a",
+                  "salesChannel": "1",
+                  "loggedIn": true,
+                  "isCheckedIn": false,
+                  "storeId": "1",
+                  "checkedInPickupPointId": "21",
+                  "allowManualPrice": true,
+                  "canEditData": true,
+                  "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
+                  "userType": "User type",
+                  "ignoreProfileData": false,
+                  "value": 10000,
+                  "messages": [],
+                  "items": [
+                    {
+                      "uniqueId": "E0F2B7AF5CD74D668F1E27537206912C",
+                      "id": "1",
+                      "productId": "1",
+                      "productRefId": "1",
+                      "refId": "0001",
+                      "ean": "123456789",
+                      "name": "Ração Royal Canin Feline Urinary 500g",
+                      "skuName": "Ração Royal Canin Feline Urinary 500g",
+                      "modalType": null,
+                      "parentItemIndex": null,
+                      "parentAssemblyBinding": null,
+                      "assemblies": [],
+                      "priceValidUntil": "2021-02-27T14:59:00.8288784Z",
+                      "tax": 0,
+                      "taxCode": "54WC8ZN6K8",
+                      "price": 15000,
+                      "listPrice": 30000,
+                      "manualPrice": 10000,
+                      "sellingPrice": 10000,
+                      "rewardValue": 0,
+                      "isGift": false,
+                      "additionalInfo": {
+                        "brandName": "Royal Canin",
+                        "brandId": "2000000",
+                        "offeringInfo": null,
+                        "offeringType": null,
+                        "offeringTypeId": null
+                      },
+                      "preSaleDate": null,
+                      "productCategoryIds": "/1/10/",
+                      "productCategories": {
+                        "1": "Alimentação",
+                        "10": "Ração Seca"
+                      },
+                      "quantity": 1,
+                      "seller": "1",
+                      "sellerChain": [
+                        "1"
+                      ],
+                      "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
+                      "detailUrl": "/racao-royal-canin-feline-urinary/p",
+                      "components": [],
+                      "bundleItems": [],
+                      "attachments": [],
+                      "attachmentOfferings": [
+                        {
+                          "name": "vtex.subscription.weekly",
+                          "required": false,
+                          "schema": {
+                            "vtex.subscription.key.frequency": {
+                              "MaximumNumberOfCharacters": 7,
+                              "Domain": [
+                                "1 week",
+                                "2 week",
+                                "3 week",
+                                "4 week"
+                              ]
+                            }
+                          }
+                        },
+                        {
+                          "name": "vtex.subscription.daily",
+                          "required": false,
+                          "schema": {
+                            "vtex.subscription.key.frequency": {
+                              "MaximumNumberOfCharacters": 5,
+                              "Domain": [
+                                "1 day"
+                              ]
+                            }
+                          }
+                        }
+                      ],
+                      "offerings": [],
+                      "priceTags": [
+                        {
+                          "name": "DISCOUNT@MANUALPRICE",
+                          "value": -5000,
+                          "rawValue": -50,
+                          "isPercentual": false,
+                          "identifier": null
+                        }
+                      ],
+                      "availability": "available",
+                      "measurementUnit": "un",
+                      "unitMultiplier": 1,
+                      "manufacturerCode": null
+                    }
+                  ],
+                  "selectableGifts": [],
+                  "totalizers": [
+                    {
+                      "id": "Items",
+                      "name": "Total dos Itens",
+                      "value": 15000
+                    },
+                    {
+                      "id": "Discounts",
+                      "name": "Total dos Descontos",
+                      "value": -5000
+                    }
+                  ],
+                  "shippingData": {
+                    "address": null,
+                    "logisticsInfo": [
+                      {
+                        "itemIndex": 0,
+                        "selectedSla": "Normal",
+                        "selectedDeliveryChannel": "delivery",
+                        "addressId": "666c2e830bd9474ab6f6cc53fb6dd2d2",
+                        "slas": [],
+                        "shipsTo": [
+                          "BRA"
+                        ],
+                        "itemId": "1",
+                        "deliveryChannels": [
+                          {
+                            "id": "pickup-in-point"
+                          },
+                          {
+                            "id": "delivery"
+                          }
+                        ]
+                      }
+                    ],
+                    "selectedAddresses": [],
+                    "availableAddresses": [],
+                    "pickupPoints": []
+                  },
+                  "clientProfileData": null,
+                  "paymentData": {
+                    "installmentOptions": [
+                      {
+                        "paymentSystem": 2,
+                        "bin": null,
+                        "paymentName": null,
+                        "paymentGroupName": null,
+                        "value": 10000,
+                        "installments": [
+                          {
+                            "count": 1,
+                            "hasInterestRate": false,
+                            "interestRate": 0,
+                            "value": 10000,
+                            "total": 10000,
+                            "sellerMerchantInstallments": [
+                              {
+                                "id": "LOJADOBRENO",
+                                "count": 1,
+                                "hasInterestRate": false,
+                                "interestRate": 0,
+                                "value": 10000,
+                                "total": 10000
+                              }
+                            ]
+                          },
+                          {
+                            "count": 2,
+                            "hasInterestRate": false,
+                            "interestRate": 0,
+                            "value": 5000,
+                            "total": 10000,
+                            "sellerMerchantInstallments": [
+                              {
+                                "id": "LOJADOBRENO",
+                                "count": 2,
+                                "hasInterestRate": false,
+                                "interestRate": 0,
+                                "value": 5000,
+                                "total": 10000
+                              }
+                            ]
+                          }
+                        ]
+                      }
+                    ],
+                    "paymentSystems": [
+                      {
+                        "id": 2,
+                        "name": "Visa",
+                        "groupName": "creditCardPaymentGroup",
+                        "validator": {
+                          "regex": "^4[0-9]{15}$",
+                          "mask": "9999 9999 9999 9999",
+                          "cardCodeRegex": "^[0-9]{3}$",
+                          "cardCodeMask": "999",
+                          "weights": [
+                            2,
+                            1,
+                            2,
+                            1,
+                            2
+                          ],
+                          "useCvv": true,
+                          "useExpirationDate": true,
+                          "useCardHolderName": true,
+                          "useBillingAddress": true
+                        },
+                        "stringId": "2",
+                        "template": "creditCardPaymentGroup-template",
+                        "requiresDocument": false,
+                        "isCustom": false,
+                        "description": "Payment description",
+                        "requiresAuthentication": false,
+                        "dueDate": "2020-03-05T16:42:31.7836281Z",
+                        "availablePayments": null
+                      }
+                    ],
+                    "payments": [
+                      {
+                        "paymentSystem": 6,
+                        "bin": null,
+                        "accountId": "12",
+                        "tokenId": null,
+                        "value": 34390,
+                        "referenceValue": 34390,
+                        "giftCardRedemptionCode": null,
+                        "giftCardProvider": null,
+                        "giftCardId": null
+                      }
+                    ],
+                    "giftCards": [],
+                    "giftCardMessages": [],
+                    "availableAccounts": [],
+                    "availableTokens": []
+                  },
+                  "marketingData": null,
+                  "sellers": [
+                    {
+                      "id": "1",
+                      "name": "lojadobreno",
+                      "logo": "Logo"
+                    }
+                  ],
+                  "clientPreferencesData": {
+                    "locale": "pt-BR",
+                    "optinNewsLetter": null
+                  },
+                  "commercialConditionData": null,
+                  "storePreferencesData": {
+                    "countryCode": "BRA",
+                    "saveUserData": true,
+                    "timeZone": "E. South America Standard Time",
+                    "currencyCode": "BRL",
+                    "currencyLocale": 1046,
+                    "currencySymbol": "R$",
+                    "currencyFormatInfo": {
+                      "currencyDecimalDigits": 2,
+                      "currencyDecimalSeparator": ",",
+                      "currencyGroupSeparator": ".",
+                      "currencyGroupSize": 3,
+                      "startsWithCurrencySymbol": true
+                    }
+                  },
+                  "giftRegistryData": null,
+                  "openTextField": null,
+                  "invoiceData": null,
+                  "customData": null,
+                  "itemMetadata": {
+                    "items": [
+                      {
+                        "id": "1",
+                        "seller": "1",
+                        "name": "Ração Royal Canin Feline Urinary 500g",
+                        "skuName": "Ração Royal Canin Feline Urinary 500g",
+                        "productId": "1",
+                        "refId": "0001",
+                        "ean": "123456789",
+                        "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
+                        "detailUrl": "/racao-royal-canin-feline-urinary/p",
+                        "assemblyOptions": []
+                      }
+                    ]
+                  },
+                  "hooksData": null,
+                  "ratesAndBenefitsData": {
+                    "rateAndBenefitsIdentifiers": [],
+                    "teaser": []
+                  },
+                  "subscriptionData": null,
+                  "itemsOrdination": {
+                    "criteria": "NAME",
+                    "ascending": true
+                  }
+                },
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "orderFormId": {
+                      "type": "string",
+                      "description": "ID of the orderForm corresponding to a specific cart."
+                    },
+                    "salesChannel": {
+                      "type": "string",
+                      "description": "Attribute created by the seller, in their VTEX store configuration."
+                    },
+                    "loggedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether the user is logged into the store."
+                    },
+                    "isCheckedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether order is checked in."
+                    },
+                    "storeId": {
+                      "type": "string",
+                      "description": "ID of the store.",
+                      "nullable": true
+                    },
+                    "allowManualPrice": {
+                      "type": "boolean",
+                      "description": "Permission to modify item price manually."
+                    },
+                    "canEditData": {
+                      "type": "boolean",
+                      "description": "Data can be edited."
+                    },
+                    "userProfileId": {
+                      "type": "string",
+                      "description": "Unique ID associated with the customer profile."
+                    },
+                    "profileProvider": {
+                      "type": "string",
+                      "description": "Profile provider."
+                    },
+                    "availableAccounts": {
+                      "type": "array",
+                      "description": "Available accounts.",
+                      "items": {
+                        "type": "string",
+                        "description": "Account."
+                      }
+                    },
+                    "availableAddresses": {
+                      "type": "array",
+                      "description": "Information on each available address.",
+                      "items": {
+                        "description": "Address information.",
+                        "type": "object",
+                        "properties": {
+                          "addressType": {
+                            "type": "string",
+                            "description": "Address type."
+                          },
+                          "receiverName": {
+                            "type": "string",
+                            "description": "Name of the receiver."
+                          },
+                          "addressId": {
+                            "type": "string",
+                            "description": "Address ID.",
+                            "nullable": true
+                          },
+                          "isDisposable": {
+                            "type": "boolean",
+                            "description": "Indicates whether address is disposable."
+                          },
+                          "city": {
+                            "type": "string",
+                            "description": "City of the address."
+                          },
+                          "state": {
+                            "type": "string",
+                            "description": "State of the address."
+                          },
+                          "country": {
+                            "type": "string",
+                            "description": "Country of the address. ISO three-letter code."
+                          },
+                          "street": {
+                            "type": "string",
+                            "description": "Street of the address."
+                          },
+                          "number": {
+                            "type": "string",
+                            "description": "Number of the address."
+                          },
+                          "neighborhood": {
+                            "type": "string",
+                            "description": "Neighborhood of the address."
+                          },
+                          "complement": {
+                            "description": "Complement to the shipping address, in case it applies.",
+                            "type": "string",
+                            "nullable": true
+                          },
+                          "reference": {
+                            "type": "string",
+                            "description": "Reference that may help in the location of the address.",
+                            "nullable": true
+                          },
+                          "geoCoordinates": {
+                            "type": "array",
+                            "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                            "items": {
+                              "type": "number",
+                              "description": "Geocoordinates."
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "userType": {
+                      "type": "string",
+                      "description": "User type.",
+                      "nullable": true
+                    },
+                    "ignoreProfileData": {
+                      "type": "boolean",
+                      "description": "Ignore customer profile data."
+                    },
+                    "value": {
+                      "type": "integer",
+                      "description": "Total value of the order without separating cents. For example, $24.99 is represented as `2499`."
+                    },
+                    "messages": {
+                      "type": "array",
+                      "description": "Array containing an object for each message generated by our servers while processing the request.",
+                      "items": {
+                        "type": "string",
+                        "description": "Message."
+                      }
+                    },
+                    "items": {
+                      "type": "array",
+                      "description": "Information on each item in the order.",
+                      "items": {
+                        "description": "Item information.",
+                        "type": "object",
+                        "properties": {
+                          "uniqueId": {
+                            "type": "string",
+                            "description": "Unique ID."
+                          },
+                          "id": {
+                            "type": "string",
+                            "description": "ID of the item."
+                          },
+                          "productId": {
+                            "type": "string",
+                            "description": "Product ID."
+                          },
+                          "productRefId": {
+                            "type": "string",
+                            "description": "Product Ref ID."
+                          },
+                          "refId": {
+                            "type": "string",
+                            "description": "Ref ID."
+                          },
+                          "ean": {
+                            "type": "string",
+                            "description": "European Article Number.",
+                            "nullable": true
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Product name."
+                          },
+                          "skuName": {
+                            "type": "string",
+                            "description": "SKU name."
+                          },
+                          "modalType": {
+                            "type": "string",
+                            "description": "Modal type.",
+                            "nullable": true
+                          },
+                          "parentItemIndex": {
+                            "type": "integer",
+                            "description": "Parent item index.",
+                            "nullable": true
+                          },
+                          "parentAssemblyBinding": {
+                            "type": "string",
+                            "description": "Parent assembly binding.",
+                            "nullable": true
+                          },
+                          "priceValidUntil": {
+                            "type": "string",
+                            "description": "Price expiration date and time."
+                          },
+                          "tax": {
+                            "type": "integer",
+                            "description": "Tax value in cents."
+                          },
+                          "taxCode": {
+                            "type": "string",
+                            "description": "A unique identifier code assigned to a tax within the VTEX Admin."
+                          },
+                          "price": {
+                            "type": "integer",
+                            "description": "Price in cents."
+                          },
+                          "listPrice": {
+                            "type": "integer",
+                            "description": "List price in cents."
+                          },
+                          "manualPrice": {
+                            "type": "integer",
+                            "description": "Manual price in cents.",
+                            "nullable": true
+                          },
+                          "manualPriceAppliedBy": {
+                            "type": "string",
+                            "description": "User that applied the manual price, if that is the case.",
+                            "nullable": true
+                          },
+                          "sellingPrice": {
+                            "type": "integer",
+                            "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
+                          },
+                          "rewardValue": {
+                            "type": "integer",
+                            "description": "Reward value in cents."
+                          },
+                          "isGift": {
+                            "type": "boolean",
+                            "description": "Indicates whether item is a gift."
+                          },
+                          "additionalInfo": {
+                            "type": "object",
+                            "description": "Additional information.",
+                            "properties": {
+                              "dimension": {
+                                "type": "string",
+                                "description": "Dimension.",
+                                "nullable": true
+                              },
+                              "brandName": {
+                                "type": "string",
+                                "description": "Brand name."
+                              },
+                              "brandId": {
+                                "type": "string",
+                                "description": "Brand ID."
+                              },
+                              "offeringInfo": {
+                                "type": "string",
+                                "description": "Offering information.",
+                                "nullable": true
+                              },
+                              "offeringType": {
+                                "type": "string",
+                                "description": "Offering type.",
+                                "nullable": true
+                              },
+                              "offeringTypeId": {
+                                "type": "string",
+                                "description": "Offering type ID.",
+                                "nullable": true
+                              }
+                            }
+                          },
+                          "preSaleDate": {
+                            "type": "string",
+                            "description": "Presale date.",
+                            "nullable": true
+                          },
+                          "productCategoryIds": {
+                            "type": "string",
+                            "description": "Product category IDs."
+                          },
+                          "productCategories": {
+                            "type": "object",
+                            "description": "Object, where each field is an ID from `productCategoryIds`.",
+                            "properties": {
+                              "{ID}": {
+                                "type": "string",
+                                "description": "Product category corresponding to the ID in the field key."
+                              }
+                            }
+                          },
+                          "quantity": {
+                            "type": "integer",
+                            "description": "Quantity."
+                          },
+                          "seller": {
+                            "type": "string",
+                            "description": "Seller."
+                          },
+                          "sellerChain": {
+                            "type": "array",
+                            "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
+                            "items": {
+                              "type": "string",
+                              "description": "Seller."
+                            }
+                          },
+                          "imageUrl": {
+                            "type": "string",
+                            "description": "Image URL."
+                          },
+                          "detailUrl": {
+                            "type": "string",
+                            "description": "Detail URL."
+                          },
+                          "bundleItems": {
+                            "type": "array",
+                            "description": "Information on services sold along with the SKU. Example: a gift package.",
+                            "items": {
+                              "description": "Service information.",
+                              "type": "object",
+                              "properties": {
+                                "type": {
+                                  "type": "string",
+                                  "description": "Service type."
+                                },
+                                "id": {
+                                  "type": "integer",
+                                  "description": "Service identifier."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Service name."
+                                },
+                                "price": {
+                                  "type": "integer",
+                                  "description": "Service price in cents."
+                                }
+                              }
+                            }
+                          },
+                          "attachments": {
+                            "type": "array",
+                            "description": "Array containing information on attachments.",
+                            "items": {
+                              "type": "string",
+                              "description": "Attachment."
+                            }
+                          },
+                          "priceTags": {
+                            "type": "array",
+                            "description": "Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.",
+                            "items": {
+                              "description": "Price tag information.",
+                              "type": "object",
+                              "properties": {
+                                "identifier": {
+                                  "type": "string",
+                                  "description": "Promotion unique identifier.",
+                                  "nullable": true
+                                },
+                                "isPercentual": {
+                                  "type": "boolean",
+                                  "description": "Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\r\n- `type` indicates whether the tag refers to a discount or tax.\r\n- `where` specifies the context, either price or shipping.\r\n- `identifier` is the promotion ID.\r\n- `calculationId` is a hash that may vary with each price calculation."
+                                },
+                                "rawValue": {
+                                  "type": "number",
+                                  "description": "Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations."
+                                },
+                                "value": {
+                                  "type": "integer",
+                                  "description": "Price tag value representing either a promotion (value decrease) or a tax (value increase)."
+                                }
+                              }
+                            }
+                          },
+                          "availability": {
+                            "type": "string",
+                            "description": "Availability."
+                          },
+                          "measurementUnit": {
+                            "type": "string",
+                            "description": "Measurement unit."
+                          },
+                          "unitMultiplier": {
+                            "type": "integer",
+                            "description": "Unit multiplier."
+                          },
+                          "manufacturerCode": {
+                            "type": "string",
+                            "description": "Manufacturer code.",
+                            "nullable": true
+                          },
+                          "priceDefinition": {
+                            "type": "object",
+                            "description": "Price information for all units of a specific item.",
+                            "properties": {
+                              "calculatedSellingPrice": {
+                                "type": "integer",
+                                "description": "Item's calculated unitary selling price in cents."
+                              },
+                              "total": {
+                                "type": "integer",
+                                "description": "Total value for all units of the item in cents."
+                              },
+                              "sellingPrices": {
+                                "type": "array",
+                                "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
+                                "items": {
+                                  "description": "Rounding information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value in cents for that specific rounding."
+                                    },
+                                    "quantity": {
+                                      "type": "integer",
+                                      "description": "Rounding quantity, meaning how many items are rounded to this value."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "selectableGifts": {
+                      "type": "array",
+                      "description": "Array containing the data of the item selected as a gift.",
+                      "items": {
+                        "type": "string",
+                        "description": "Gift."
+                      }
+                    },
+                    "totalizers": {
+                      "type": "array",
+                      "description": "Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).",
+                      "items": {
+                        "type": "object",
+                        "description": "Totalizer of purchases."
+                      }
+                    },
+                    "shippingData": {
+                      "type": "object",
+                      "description": "Shipping information pertinent to the order.",
+                      "nullable": true,
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Address information.",
+                          "nullable": true,
+                          "properties": {
+                            "addressType": {
+                              "type": "string",
+                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                            },
+                            "receiverName": {
+                              "type": "string",
+                              "description": "Name of the person who is going to receive the order."
+                            },
+                            "addressId": {
+                              "type": "string",
+                              "description": "Address ID.",
+                              "nullable": true
+                            },
+                            "isDisposable": {
+                              "type": "boolean",
+                              "description": "Indicates whether address is disposable."
+                            },
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City of the shipping address."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State of the shipping address."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Three letter ISO code of the country of the shipping address."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street of the shipping address."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Number of the building, house or apartment in the shipping address."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood of the shipping address."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Complement to the shipping address, in case it applies.",
+                              "nullable": true
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                              "nullable": true
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                              "items": {
+                                "type": "number",
+                                "description": "Geocoordinates."
+                              }
+                            }
+                          }
+                        },
+                        "logisticsInfo": {
+                          "type": "array",
+                          "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.",
+                          "items": {
+                            "description": "Logistics information.",
+                            "type": "object",
+                            "properties": {
+                              "itemIndex": {
+                                "type": "integer",
+                                "description": "Index corresponding to the position of the object in the `items` array."
+                              },
+                              "selectedSla": {
+                                "type": "string",
+                                "description": "SLA selected by the customer.",
+                                "nullable": true
+                              },
+                              "selectedDeliveryChannel": {
+                                "type": "string",
+                                "description": "Delivery channel selected by the customer.",
+                                "nullable": true
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "slas": {
+                                "type": "array",
+                                "description": "Information on available SLAs.",
+                                "items": {
+                                  "description": "SLA information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "SLA ID."
+                                    },
+                                    "deliveryChannel": {
+                                      "type": "string",
+                                      "description": "Delivery channel."
+                                    },
+                                    "name": {
+                                      "type": "string",
+                                      "description": "SLA name."
+                                    },
+                                    "deliveryIds": {
+                                      "type": "array",
+                                      "description": "Information on each delivery ID.",
+                                      "items": {
+                                        "description": "Delivery ID information.",
+                                        "type": "object",
+                                        "properties": {
+                                          "courierId": {
+                                            "type": "string",
+                                            "description": "Courier ID."
+                                          },
+                                          "warehouseId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "dockId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "courierName": {
+                                            "type": "string",
+                                            "description": "Courier name."
+                                          },
+                                          "quantity": {
+                                            "type": "integer",
+                                            "description": "Quantity."
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "attachmentOfferings": {
+                                      "type": "array",
+                                      "description": "List of attachments details.",
+                                      "nullable": true,
+                                      "items": {
+                                        "description": "Attachment details.",
+                                        "type": "object",
+                                        "required": [
+                                          "name",
+                                          "required",
+                                          "schema"
+                                        ],
+                                        "properties": {
+                                          "name": {
+                                            "type": "string",
+                                            "description": "Name of the attachment.",
+                                            "nullable": true
+                                          },
+                                          "required": {
+                                            "type": "boolean",
+                                            "description": "Defines if the attachment is required (`true`) or not (`false`).",
+                                            "nullable": true
+                                          },
+                                          "schema": {
+                                            "type": "object",
+                                            "description": "Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).",
+                                            "nullable": true
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "shippingEstimate": {
+                                      "type": "string",
+                                      "description": "Shipping estimate. For instance, \"three business days\" will be represented as `3bd`."
+                                    },
+                                    "shippingEstimateDate": {
+                                      "type": "string",
+                                      "description": "When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.",
+                                      "nullable": true
+                                    },
+                                    "useIndividualShippingEstimates": {
+                                      "type": "boolean",
+                                      "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`."
+                                    },
+                                    "lockTTL": {
+                                      "type": "string",
+                                      "description": "Estimate date of delivery.",
+                                      "nullable": true
+                                    },
+                                    "price": {
+                                      "type": "integer",
+                                      "description": "Price in cents."
+                                    },
+                                    "listPrice": {
+                                      "type": "integer",
+                                      "description": "List price in cents."
+                                    },
+                                    "tax": {
+                                      "type": "integer",
+                                      "description": "Tax in cents."
+                                    },
+                                    "pickupStoreInfo": {
+                                      "type": "object",
+                                      "description": "Information on the pickup store.",
+                                      "properties": {
+                                        "isPickupStore": {
+                                          "type": "boolean",
+                                          "description": "Indicates whether it is the pickup store."
+                                        },
+                                        "friendlyName": {
+                                          "type": "string",
+                                          "description": "Friendly name.",
+                                          "nullable": true
+                                        },
+                                        "address": {
+                                          "type": "object",
+                                          "description": "Address information.",
+                                          "nullable": true,
+                                          "properties": {
+                                            "addressType": {
+                                              "type": "string",
+                                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                                            },
+                                            "postalCode": {
+                                              "type": "string",
+                                              "description": "Postal code."
+                                            },
+                                            "city": {
+                                              "type": "string",
+                                              "description": "City of the shipping address."
+                                            },
+                                            "state": {
+                                              "type": "string",
+                                              "description": "State of the shipping address."
+                                            },
+                                            "country": {
+                                              "type": "string",
+                                              "description": "Three letter ISO code of the country of the shipping address."
+                                            },
+                                            "street": {
+                                              "type": "string",
+                                              "description": "Street of the shipping address."
+                                            },
+                                            "number": {
+                                              "type": "string",
+                                              "description": "Number of the building, house or apartment in the shipping address."
+                                            },
+                                            "neighborhood": {
+                                              "type": "string",
+                                              "description": "Neighborhood of the shipping address."
+                                            },
+                                            "complement": {
+                                              "type": "string",
+                                              "description": "Complement to the shipping address, in case it applies.",
+                                              "nullable": true
+                                            },
+                                            "reference": {
+                                              "type": "string",
+                                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                              "nullable": true
+                                            },
+                                            "geoCoordinates": {
+                                              "type": "array",
+                                              "description": "Array with two strings that repesent geocoordinates: first latitude, then longitude.",
+                                              "items": {
+                                                "type": "number",
+                                                "description": "Geocoordinates."
+                                              }
+                                            }
+                                          }
+                                        },
+                                        "additionalInfo": {
+                                          "type": "string",
+                                          "description": "Additional information.",
+                                          "nullable": true
+                                        },
+                                        "dockId": {
+                                          "type": "string",
+                                          "description": "Corresponding dock ID.",
+                                          "nullable": true
+                                        }
+                                      }
+                                    },
+                                    "pickupPointId": {
+                                      "type": "string",
+                                      "description": "Pickup point ID.",
+                                      "nullable": true
+                                    },
+                                    "pickupDistance": {
+                                      "type": "integer",
+                                      "description": "Pickup point distance."
+                                    },
+                                    "polygonName": {
+                                      "type": "string",
+                                      "description": "Polygon name.",
+                                      "nullable": true
+                                    },
+                                    "transitTime": {
+                                      "type": "string",
+                                      "description": "Transit time. For instance, \"three business days\" is represented as `3bd`."
+                                    }
+                                  }
+                                }
+                              },
+                              "shipsTo": {
+                                "type": "array",
+                                "description": "List of countries that the item may be shipped to.",
+                                "items": {
+                                  "type": "string",
+                                  "description": "Three letter country code."
+                                }
+                              },
+                              "itemId": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "deliveryChannels": {
+                                "type": "array",
+                                "description": "List of available delivery channels.",
+                                "items": {
+                                  "description": "Delivery channel information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "Delivery channel ID."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "selectedAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the selected addresses for the order.",
+                          "items": {
+                            "description": "Selected address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "availableAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the available addresses for the order.",
+                          "items": {
+                            "description": "Available address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "clientProfileData": {
+                      "type": "object",
+                      "description": "Customer's profile information.",
+                      "nullable": true,
+                      "properties": {
+                        "email": {
+                          "type": "string",
+                          "description": "Email address.",
+                          "nullable": true
+                        },
+                        "firstName": {
+                          "type": "string",
+                          "description": "First name.",
+                          "nullable": true
+                        },
+                        "lastName": {
+                          "type": "string",
+                          "description": "Last name."
+                        },
+                        "documentType": {
+                          "type": "string",
+                          "description": "Type of the document informed by the customer."
+                        },
+                        "document": {
+                          "type": "string",
+                          "description": "Document informed by the customer."
+                        },
+                        "phone": {
+                          "type": "string",
+                          "description": "Phone number."
+                        },
+                        "corporateName": {
+                          "type": "string",
+                          "description": "Company name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "tradeName": {
+                          "type": "string",
+                          "description": "Trade name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporateDocument": {
+                          "type": "string",
+                          "description": "Corporate document, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "stateInscription": {
+                          "type": "string",
+                          "description": "State inscription, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporatePhone": {
+                          "type": "string",
+                          "description": "Corporate phone number, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "isCorporate": {
+                          "type": "boolean",
+                          "description": "Indicates whether the customer is a legal entity."
+                        },
+                        "profileCompleteOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile is complete on loading."
+                        },
+                        "profileErrorOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile presents error on loading.",
+                          "nullable": true
+                        },
+                        "customerClass": {
+                          "type": "string",
+                          "description": "Customer class.",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "paymentData": {
+                      "type": "object",
+                      "description": "Information on the order's payment.",
+                      "properties": {
+                        "giftCards": {
+                          "type": "array",
+                          "description": "Gift card information, if it applies to the order.",
+                          "items": {
+                            "description": "Gift card information.",
+                            "type": "object",
+                            "properties": {
+                              "redemptionCode": {
+                                "type": "string",
+                                "description": "Gift card redemption code."
+                              },
+                              "value": {
+                                "type": "integer",
+                                "description": "Gift card value in cents."
+                              },
+                              "balance": {
+                                "type": "integer",
+                                "description": "Gift card balance in cents."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Gift card name."
+                              },
+                              "id": {
+                                "type": "string",
+                                "description": "Gift card ID."
+                              },
+                              "inUse": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is in use."
+                              },
+                              "isSpecialCard": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is special."
+                              }
+                            }
+                          }
+                        },
+                        "transactions": {
+                          "type": "array",
+                          "description": "Information on each transaction pertinent to the order.",
+                          "items": {
+                            "description": "Transaction information.",
+                            "nullable": true,
+                            "type": "object",
+                            "properties": {
+                              "isActive": {
+                                "type": "boolean",
+                                "description": "Indicates whether transaction is active."
+                              },
+                              "transactionId": {
+                                "type": "string",
+                                "description": "Transaction ID."
+                              },
+                              "merchantName": {
+                                "type": "string",
+                                "description": "Merchant name."
+                              },
+                              "payments": {
+                                "type": "array",
+                                "description": "Information on each payment.",
+                                "items": {
+                                  "description": "Payment information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "accountId": {
+                                      "type": "string",
+                                      "description": "Account ID."
+                                    },
+                                    "bin": {
+                                      "type": "string",
+                                      "description": "Bin.",
+                                      "nullable": true
+                                    },
+                                    "installments": {
+                                      "type": "integer",
+                                      "description": "Number of installments."
+                                    },
+                                    "paymentSystem": {
+                                      "type": "string",
+                                      "description": "Payment system."
+                                    },
+                                    "referenceValue": {
+                                      "type": "integer",
+                                      "description": "Reference value for calculating interest rates, in case it applies. Displayed in cents."
+                                    },
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value including interest, in case it applies. Displayed in cents."
+                                    }
+                                  }
+                                }
+                              },
+                              "sharedTransaction": {
+                                "type": "boolean",
+                                "description": "Indicates whather transaction is shared."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "marketingData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Object containing promotion data such as coupon tracking information and internal or external UTMs.",
+                      "properties": {
+                        "coupon": {
+                          "type": "string",
+                          "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.",
+                          "example": "free-shipping"
+                        },
+                        "utmSource": {
+                          "type": "string",
+                          "description": "UTM source.",
+                          "example": "Facebook"
+                        },
+                        "utmMedium": {
+                          "type": "string",
+                          "description": "UTM medium.",
+                          "example": "CPC"
+                        },
+                        "utmCampaign": {
+                          "type": "string",
+                          "description": "UTM campaign.",
+                          "example": "Black friday"
+                        },
+                        "utmiPage": {
+                          "type": "string",
+                          "description": "utmi_page (internal utm).",
+                          "example": "utmi_page-example",
+                          "nullable": true
+                        },
+                        "utmiPart": {
+                          "type": "string",
+                          "description": "utmi_part (internal utm).",
+                          "example": "utmi_part-example",
+                          "nullable": true
+                        },
+                        "utmiCampaign": {
+                          "type": "string",
+                          "description": "utmi_campaign (internal utm).",
+                          "example": "utmi_campaign-example",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "sellers": {
+                      "type": "array",
+                      "description": "Information on each seller.",
+                      "items": {
+                        "description": "Seller information.",
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "Seller ID."
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Seller name."
+                          },
+                          "logo": {
+                            "type": "string",
+                            "description": "Seller logo.",
+                            "nullable": true
+                          }
+                        }
+                      }
+                    },
+                    "clientPreferencesData": {
+                      "type": "object",
+                      "description": "Object containing preferences from the client who placed the order.",
+                      "properties": {
+                        "locale": {
+                          "type": "string",
+                          "description": "Client's locale. Examples: `pt-BR` and `en-US`."
+                        },
+                        "optinNewsLetter": {
+                          "type": "boolean",
+                          "description": "`true` if the client opted to receive newsletter from the store.",
+                          "example": false,
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "commercialConditionData": {
+                      "type": "object",
+                      "description": "Object containing commercial condition information.",
+                      "nullable": true
+                    },
+                    "storePreferencesData": {
+                      "type": "object",
+                      "description": "Object containing data from the store's configuration (stored in VTEX's License Manager)."
+                    },
+                    "giftRegistryData": {
+                      "type": "object",
+                      "description": "Gift registry list information.",
+                      "nullable": true
+                    },
+                    "openTextField": {
+                      "type": "string",
+                      "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).",
+                      "example": "open-text-example",
+                      "nullable": true
+                    },
+                    "invoiceData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Invoice data including billing address.",
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Billing address.",
+                          "properties": {
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City name."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State name."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Country."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street name."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Street number."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Address complement."
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Reference for location."
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Geographic coordinates (latitude, longitude).",
+                              "items": {
+                                "type": "number"
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "customData": {
+                      "type": "object",
+                      "description": "Customer additional information.",
+                      "nullable": true
+                    },
+                    "itemMetadata": {
+                      "type": "object",
+                      "description": "Item metadata.",
+                      "properties": {
+                        "items": {
+                          "type": "array",
+                          "description": "List of objects containing metadata on each item in the order.",
+                          "items": {
+                            "description": "Item metadata.",
+                            "type": "object",
+                            "properties": {
+                              "id": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "seller": {
+                                "type": "string",
+                                "description": "Seller."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Product name."
+                              },
+                              "skuName": {
+                                "type": "string",
+                                "description": "SKU name."
+                              },
+                              "productId": {
+                                "type": "string",
+                                "description": "Product ID."
+                              },
+                              "refId": {
+                                "type": "string",
+                                "description": "Ref ID."
+                              },
+                              "ean": {
+                                "type": "string",
+                                "description": "European Article Number.",
+                                "nullable": true
+                              },
+                              "imageUrl": {
+                                "type": "string",
+                                "description": "Image URL."
+                              },
+                              "detailUrl": {
+                                "type": "string",
+                                "description": "Detail URL."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "hooksData": {
+                      "type": "object",
+                      "description": "Hooks information.",
+                      "nullable": true
+                    },
+                    "ratesAndBenefitsData": {
+                      "type": "object",
+                      "description": "Information on rates and benefits that apply to the order.",
+                      "properties": {
+                        "rateAndBenefitsIdentifiers": {
+                          "type": "array",
+                          "description": "List with rates and benefits identifiers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit identifier."
+                          }
+                        },
+                        "teaser": {
+                          "type": "array",
+                          "description": "List with rates and benefits teasers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit teaser."
+                          }
+                        }
+                      }
+                    },
+                    "subscriptionData": {
+                      "type": "object",
+                      "description": "Subscription information.",
+                      "nullable": true
+                    },
+                    "itemsOrdination": {
+                      "type": "object",
+                      "description": "Object containing information about the ordering of items within the `orderForm`.",
+                      "properties": {
+                        "criteria": {
+                          "type": "string",
+                          "description": "Criteria adopted to order the items in the list."
+                        },
+                        "ascending": {
+                          "type": "boolean",
+                          "description": "Indicates whether the ordering is ascending."
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/api/checkout/pub/orderForm/{orderFormId}/profile": {
+      "patch": {
+        "tags": [
+          "Shopping cart"
+        ],
+        "summary": "Ignore profile data on checkout",
+        "description": "When a shopper provides an email address at Checkout, the platform tries to retrieve existing profile information for that email and add it to the shopping cart information. Use this request if you want to change this behavior for a given cart, meaning profile information will not be included in the order automatically.\r\n\r\nThe [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.\r\n\r\nNote that this request will only work if you have not sent the `clientProfileData` to the cart yet. Sending it to a cart that already has a `clientProfileData` should return a status `403 Forbidden` error, with an `Access denied` message.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "IgnoreProfileData",
+        "security": [],
+        "parameters": [
+          {
+            "name": "orderFormId",
+            "in": "path",
+            "description": "ID of the orderForm corresponding to the cart whose items will have the price changed.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "ede846222cd44046ba6c638442c3505a"
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "ignoreProfileData": {
+                    "type": "boolean",
+                    "description": "Indicates whether profile data should be ignored.",
+                    "example": false
+                  }
+                }
+              },
+              "example": {
+                "ignoreProfileData": true
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "example": {
+                  "orderFormId": "68b287ae65534704b1a1e42e47c82abc",
+                  "salesChannel": "1",
+                  "loggedIn": true,
+                  "isCheckedIn": false,
+                  "storeId": "1",
+                  "checkedInPickupPointId": "21",
+                  "allowManualPrice": false,
+                  "canEditData": true,
+                  "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
+                  "userType": "User type",
+                  "ignoreProfileData": true,
+                  "value": 0,
+                  "messages": [],
+                  "items": [],
+                  "selectableGifts": [],
+                  "totalizers": [],
+                  "shippingData": null,
+                  "clientProfileData": {
+                    "email": "clark.kent@examplemail.com",
+                    "firstName": "Clark",
+                    "lastName": "Kent",
+                    "document": "12345678900",
+                    "documentType": "cpf",
+                    "phone": "+5500123456789",
+                    "corporateName": "company-name",
+                    "tradeName": "trade-name",
+                    "corporateDocument": "12345678000100",
+                    "stateInscription": "12345678",
+                    "corporatePhone": "551100988887777",
+                    "isCorporate": false,
+                    "profileCompleteOnLoading": false,
+                    "profileErrorOnLoading": false,
+                    "customerClass": null
+                  },
+                  "paymentData": {
+                    "updateStatus": "updated",
+                    "installmentOptions": [],
+                    "paymentSystems": [],
+                    "payments": [
+                      {
+                        "paymentSystem": 6,
+                        "bin": null,
+                        "accountId": "12",
+                        "tokenId": null,
+                        "value": 34390,
+                        "referenceValue": 34390,
+                        "giftCardRedemptionCode": null,
+                        "giftCardProvider": null,
+                        "giftCardId": null
+                      }
+                    ],
+                    "giftCards": [],
+                    "giftCardMessages": [],
+                    "availableAccounts": [],
+                    "availableTokens": []
+                  },
+                  "marketingData": null,
+                  "sellers": [],
+                  "clientPreferencesData": {
+                    "locale": "pt-BR",
+                    "optinNewsLetter": null
+                  },
+                  "commercialConditionData": null,
+                  "storePreferencesData": {
+                    "countryCode": "BRA",
+                    "saveUserData": true,
+                    "timeZone": "E. South America Standard Time",
+                    "currencyCode": "BRL",
+                    "currencyLocale": 1046,
+                    "currencySymbol": "R$",
+                    "currencyFormatInfo": {
+                      "currencyDecimalDigits": 2,
+                      "currencyDecimalSeparator": ",",
+                      "currencyGroupSeparator": ".",
+                      "currencyGroupSize": 3,
+                      "startsWithCurrencySymbol": true
+                    }
+                  },
+                  "giftRegistryData": null,
+                  "openTextField": null,
+                  "invoiceData": null,
+                  "customData": null,
+                  "itemMetadata": {
+                    "items": [
+                      {
+                        "id": "1",
+                        "seller": "1",
+                        "name": "Ração Royal Canin Feline Urinary 500g",
+                        "skuName": "Ração Royal Canin Feline Urinary 500g",
+                        "productId": "1",
+                        "refId": "0001",
+                        "ean": "123456789",
+                        "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
+                        "detailUrl": "/racao-royal-canin-feline-urinary/p",
+                        "assemblyOptions": []
+                      }
+                    ]
+                  },
+                  "hooksData": null,
+                  "ratesAndBenefitsData": {
+                    "rateAndBenefitsIdentifiers": [],
+                    "teaser": []
+                  },
+                  "subscriptionData": null,
+                  "itemsOrdination": {
+                    "criteria": "NAME",
+                    "ascending": true
+                  }
+                },
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "orderFormId": {
+                      "type": "string",
+                      "description": "ID of the orderForm corresponding to a specific cart."
+                    },
+                    "salesChannel": {
+                      "type": "string",
+                      "description": "Attribute created by the seller, in their VTEX store configuration."
+                    },
+                    "loggedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether the user is logged into the store."
+                    },
+                    "isCheckedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether order is checked in."
+                    },
+                    "storeId": {
+                      "type": "string",
+                      "description": "ID of the store.",
+                      "nullable": true
+                    },
+                    "allowManualPrice": {
+                      "type": "boolean",
+                      "description": "Permission to modify item price manually."
+                    },
+                    "canEditData": {
+                      "type": "boolean",
+                      "description": "Data can be edited."
+                    },
+                    "userProfileId": {
+                      "type": "string",
+                      "description": "Unique ID associated with the customer profile."
+                    },
+                    "profileProvider": {
+                      "type": "string",
+                      "description": "Profile provider."
+                    },
+                    "availableAccounts": {
+                      "type": "array",
+                      "description": "Available accounts.",
+                      "items": {
+                        "type": "string",
+                        "description": "Account."
+                      }
+                    },
+                    "availableAddresses": {
+                      "type": "array",
+                      "description": "Information on each available address.",
+                      "items": {
+                        "description": "Address information.",
+                        "type": "object",
+                        "properties": {
+                          "addressType": {
+                            "type": "string",
+                            "description": "Address type."
+                          },
+                          "receiverName": {
+                            "type": "string",
+                            "description": "Name of the receiver."
+                          },
+                          "addressId": {
+                            "type": "string",
+                            "description": "Address ID.",
+                            "nullable": true
+                          },
+                          "isDisposable": {
+                            "type": "boolean",
+                            "description": "Indicates whether address is disposable."
+                          },
+                          "city": {
+                            "type": "string",
+                            "description": "City of the address."
+                          },
+                          "state": {
+                            "type": "string",
+                            "description": "State of the address."
+                          },
+                          "country": {
+                            "type": "string",
+                            "description": "Country of the address. ISO three-letter code."
+                          },
+                          "street": {
+                            "type": "string",
+                            "description": "Street of the address."
+                          },
+                          "number": {
+                            "type": "string",
+                            "description": "Number of the address."
+                          },
+                          "neighborhood": {
+                            "type": "string",
+                            "description": "Neighborhood of the address."
+                          },
+                          "complement": {
+                            "description": "Complement to the shipping address, in case it applies.",
+                            "type": "string",
+                            "nullable": true
+                          },
+                          "reference": {
+                            "type": "string",
+                            "description": "Reference that may help in the location of the address.",
+                            "nullable": true
+                          },
+                          "geoCoordinates": {
+                            "type": "array",
+                            "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                            "items": {
+                              "type": "number",
+                              "description": "Geocoordinates."
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "userType": {
+                      "type": "string",
+                      "description": "User type.",
+                      "nullable": true
+                    },
+                    "ignoreProfileData": {
+                      "type": "boolean",
+                      "description": "Ignore customer profile data."
+                    },
+                    "value": {
+                      "type": "integer",
+                      "description": "Total value of the order without separating cents. For example, $24.99 is represented as `2499`."
+                    },
+                    "messages": {
+                      "type": "array",
+                      "description": "Array containing an object for each message generated by our servers while processing the request.",
+                      "items": {
+                        "type": "string",
+                        "description": "Message."
+                      }
+                    },
+                    "items": {
+                      "type": "array",
+                      "description": "Information on each item in the order.",
+                      "items": {
+                        "description": "Item information.",
+                        "type": "object",
+                        "properties": {
+                          "uniqueId": {
+                            "type": "string",
+                            "description": "Unique ID."
+                          },
+                          "id": {
+                            "type": "string",
+                            "description": "ID of the item."
+                          },
+                          "productId": {
+                            "type": "string",
+                            "description": "Product ID."
+                          },
+                          "productRefId": {
+                            "type": "string",
+                            "description": "Product Ref ID."
+                          },
+                          "refId": {
+                            "type": "string",
+                            "description": "Ref ID."
+                          },
+                          "ean": {
+                            "type": "string",
+                            "description": "European Article Number.",
+                            "nullable": true
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Product name."
+                          },
+                          "skuName": {
+                            "type": "string",
+                            "description": "SKU name."
+                          },
+                          "modalType": {
+                            "type": "string",
+                            "description": "Modal type.",
+                            "nullable": true
+                          },
+                          "parentItemIndex": {
+                            "type": "integer",
+                            "description": "Parent item index.",
+                            "nullable": true
+                          },
+                          "parentAssemblyBinding": {
+                            "type": "string",
+                            "description": "Parent assembly binding.",
+                            "nullable": true
+                          },
+                          "priceValidUntil": {
+                            "type": "string",
+                            "description": "Price expiration date and time."
+                          },
+                          "tax": {
+                            "type": "integer",
+                            "description": "Tax value in cents."
+                          },
+                          "taxCode": {
+                            "type": "string",
+                            "description": "A unique identifier code assigned to a tax within the VTEX Admin."
+                          },
+                          "price": {
+                            "type": "integer",
+                            "description": "Price in cents."
+                          },
+                          "listPrice": {
+                            "type": "integer",
+                            "description": "List price in cents."
+                          },
+                          "manualPrice": {
+                            "type": "integer",
+                            "description": "Manual price in cents.",
+                            "nullable": true
+                          },
+                          "manualPriceAppliedBy": {
+                            "type": "string",
+                            "description": "User that applied the manual price, if that is the case.",
+                            "nullable": true
+                          },
+                          "sellingPrice": {
+                            "type": "integer",
+                            "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
+                          },
+                          "rewardValue": {
+                            "type": "integer",
+                            "description": "Reward value in cents."
+                          },
+                          "isGift": {
+                            "type": "boolean",
+                            "description": "Indicates whether item is a gift."
+                          },
+                          "additionalInfo": {
+                            "type": "object",
+                            "description": "Additional information.",
+                            "properties": {
+                              "dimension": {
+                                "type": "string",
+                                "description": "Dimension.",
+                                "nullable": true
+                              },
+                              "brandName": {
+                                "type": "string",
+                                "description": "Brand name."
+                              },
+                              "brandId": {
+                                "type": "string",
+                                "description": "Brand ID."
+                              },
+                              "offeringInfo": {
+                                "type": "string",
+                                "description": "Offering information.",
+                                "nullable": true
+                              },
+                              "offeringType": {
+                                "type": "string",
+                                "description": "Offering type.",
+                                "nullable": true
+                              },
+                              "offeringTypeId": {
+                                "type": "string",
+                                "description": "Offering type ID.",
+                                "nullable": true
+                              }
+                            }
+                          },
+                          "preSaleDate": {
+                            "type": "string",
+                            "description": "Presale date.",
+                            "nullable": true
+                          },
+                          "productCategoryIds": {
+                            "type": "string",
+                            "description": "Product category IDs."
+                          },
+                          "productCategories": {
+                            "type": "object",
+                            "description": "Object, where each field is an ID from `productCategoryIds`.",
+                            "properties": {
+                              "{ID}": {
+                                "type": "string",
+                                "description": "Product category corresponding to the ID in the field key."
+                              }
+                            }
+                          },
+                          "quantity": {
+                            "type": "integer",
+                            "description": "Quantity."
+                          },
+                          "seller": {
+                            "type": "string",
+                            "description": "Seller."
+                          },
+                          "sellerChain": {
+                            "type": "array",
+                            "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
+                            "items": {
+                              "type": "string",
+                              "description": "Seller."
+                            }
+                          },
+                          "imageUrl": {
+                            "type": "string",
+                            "description": "Image URL."
+                          },
+                          "detailUrl": {
+                            "type": "string",
+                            "description": "Detail URL."
+                          },
+                          "bundleItems": {
+                            "type": "array",
+                            "description": "Information on services sold along with the SKU. Example: a gift package.",
+                            "items": {
+                              "description": "Service information.",
+                              "type": "object",
+                              "properties": {
+                                "type": {
+                                  "type": "string",
+                                  "description": "Service type."
+                                },
+                                "id": {
+                                  "type": "integer",
+                                  "description": "Service identifier."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Service name."
+                                },
+                                "price": {
+                                  "type": "integer",
+                                  "description": "Service price in cents."
+                                }
+                              }
+                            }
+                          },
+                          "attachments": {
+                            "type": "array",
+                            "description": "Array containing information on attachments.",
+                            "items": {
+                              "type": "string",
+                              "description": "Attachment."
+                            }
+                          },
+                          "priceTags": {
+                            "type": "array",
+                            "description": "Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.",
+                            "items": {
+                              "description": "Price tag information.",
+                              "type": "object",
+                              "properties": {
+                                "identifier": {
+                                  "type": "string",
+                                  "description": "Promotion unique identifier.",
+                                  "nullable": true
+                                },
+                                "isPercentual": {
+                                  "type": "boolean",
+                                  "description": "Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\r\n- `type` indicates whether the tag refers to a discount or tax.\r\n- `where` specifies the context, either price or shipping.\r\n- `identifier` is the promotion ID.\r\n- `calculationId` is a hash that may vary with each price calculation."
+                                },
+                                "rawValue": {
+                                  "type": "number",
+                                  "description": "Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations."
+                                },
+                                "value": {
+                                  "type": "integer",
+                                  "description": "Price tag value representing either a promotion (value decrease) or a tax (value increase)."
+                                }
+                              }
+                            }
+                          },
+                          "availability": {
+                            "type": "string",
+                            "description": "Availability."
+                          },
+                          "measurementUnit": {
+                            "type": "string",
+                            "description": "Measurement unit."
+                          },
+                          "unitMultiplier": {
+                            "type": "integer",
+                            "description": "Unit multiplier."
+                          },
+                          "manufacturerCode": {
+                            "type": "string",
+                            "description": "Manufacturer code.",
+                            "nullable": true
+                          },
+                          "priceDefinition": {
+                            "type": "object",
+                            "description": "Price information for all units of a specific item.",
+                            "properties": {
+                              "calculatedSellingPrice": {
+                                "type": "integer",
+                                "description": "Item's calculated unitary selling price in cents."
+                              },
+                              "total": {
+                                "type": "integer",
+                                "description": "Total value for all units of the item in cents."
+                              },
+                              "sellingPrices": {
+                                "type": "array",
+                                "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
+                                "items": {
+                                  "description": "Rounding information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value in cents for that specific rounding."
+                                    },
+                                    "quantity": {
+                                      "type": "integer",
+                                      "description": "Rounding quantity, meaning how many items are rounded to this value."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "selectableGifts": {
+                      "type": "array",
+                      "description": "Array containing the data of the item selected as a gift.",
+                      "items": {
+                        "type": "string",
+                        "description": "Gift."
+                      }
+                    },
+                    "totalizers": {
+                      "type": "array",
+                      "description": "Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).",
+                      "items": {
+                        "type": "object",
+                        "description": "Totalizer of purchases."
+                      }
+                    },
+                    "shippingData": {
+                      "type": "object",
+                      "description": "Shipping information pertinent to the order.",
+                      "nullable": true,
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Address information.",
+                          "nullable": true,
+                          "properties": {
+                            "addressType": {
+                              "type": "string",
+                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                            },
+                            "receiverName": {
+                              "type": "string",
+                              "description": "Name of the person who is going to receive the order."
+                            },
+                            "addressId": {
+                              "type": "string",
+                              "description": "Address ID.",
+                              "nullable": true
+                            },
+                            "isDisposable": {
+                              "type": "boolean",
+                              "description": "Indicates whether address is disposable."
+                            },
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City of the shipping address."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State of the shipping address."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Three letter ISO code of the country of the shipping address."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street of the shipping address."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Number of the building, house or apartment in the shipping address."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood of the shipping address."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Complement to the shipping address, in case it applies.",
+                              "nullable": true
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                              "nullable": true
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                              "items": {
+                                "type": "number",
+                                "description": "Geocoordinates."
+                              }
+                            }
+                          }
+                        },
+                        "logisticsInfo": {
+                          "type": "array",
+                          "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.",
+                          "items": {
+                            "description": "Logistics information.",
+                            "type": "object",
+                            "properties": {
+                              "itemIndex": {
+                                "type": "integer",
+                                "description": "Index corresponding to the position of the object in the `items` array."
+                              },
+                              "selectedSla": {
+                                "type": "string",
+                                "description": "SLA selected by the customer.",
+                                "nullable": true
+                              },
+                              "selectedDeliveryChannel": {
+                                "type": "string",
+                                "description": "Delivery channel selected by the customer.",
+                                "nullable": true
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "slas": {
+                                "type": "array",
+                                "description": "Information on available SLAs.",
+                                "items": {
+                                  "description": "SLA information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "SLA ID."
+                                    },
+                                    "deliveryChannel": {
+                                      "type": "string",
+                                      "description": "Delivery channel."
+                                    },
+                                    "name": {
+                                      "type": "string",
+                                      "description": "SLA name."
+                                    },
+                                    "deliveryIds": {
+                                      "type": "array",
+                                      "description": "Information on each delivery ID.",
+                                      "items": {
+                                        "description": "Delivery ID information.",
+                                        "type": "object",
+                                        "properties": {
+                                          "courierId": {
+                                            "type": "string",
+                                            "description": "Courier ID."
+                                          },
+                                          "warehouseId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "dockId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "courierName": {
+                                            "type": "string",
+                                            "description": "Courier name."
+                                          },
+                                          "quantity": {
+                                            "type": "integer",
+                                            "description": "Quantity."
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "attachmentOfferings": {
+                                      "type": "array",
+                                      "description": "List of attachments details.",
+                                      "nullable": true,
+                                      "items": {
+                                        "description": "Attachment details.",
+                                        "type": "object",
+                                        "required": [
+                                          "name",
+                                          "required",
+                                          "schema"
+                                        ],
+                                        "properties": {
+                                          "name": {
+                                            "type": "string",
+                                            "description": "Name of the attachment.",
+                                            "nullable": true
+                                          },
+                                          "required": {
+                                            "type": "boolean",
+                                            "description": "Defines if the attachment is required (`true`) or not (`false`).",
+                                            "nullable": true
+                                          },
+                                          "schema": {
+                                            "type": "object",
+                                            "description": "Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).",
+                                            "nullable": true
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "shippingEstimate": {
+                                      "type": "string",
+                                      "description": "Shipping estimate. For instance, \"three business days\" will be represented as `3bd`."
+                                    },
+                                    "shippingEstimateDate": {
+                                      "type": "string",
+                                      "description": "When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.",
+                                      "nullable": true
+                                    },
+                                    "useIndividualShippingEstimates": {
+                                      "type": "boolean",
+                                      "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`."
+                                    },
+                                    "lockTTL": {
+                                      "type": "string",
+                                      "description": "Estimate date of delivery.",
+                                      "nullable": true
+                                    },
+                                    "price": {
+                                      "type": "integer",
+                                      "description": "Price in cents."
+                                    },
+                                    "listPrice": {
+                                      "type": "integer",
+                                      "description": "List price in cents."
+                                    },
+                                    "tax": {
+                                      "type": "integer",
+                                      "description": "Tax in cents."
+                                    },
+                                    "pickupStoreInfo": {
+                                      "type": "object",
+                                      "description": "Information on the pickup store.",
+                                      "properties": {
+                                        "isPickupStore": {
+                                          "type": "boolean",
+                                          "description": "Indicates whether it is the pickup store."
+                                        },
+                                        "friendlyName": {
+                                          "type": "string",
+                                          "description": "Friendly name.",
+                                          "nullable": true
+                                        },
+                                        "address": {
+                                          "type": "object",
+                                          "description": "Address information.",
+                                          "nullable": true,
+                                          "properties": {
+                                            "addressType": {
+                                              "type": "string",
+                                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                                            },
+                                            "postalCode": {
+                                              "type": "string",
+                                              "description": "Postal code."
+                                            },
+                                            "city": {
+                                              "type": "string",
+                                              "description": "City of the shipping address."
+                                            },
+                                            "state": {
+                                              "type": "string",
+                                              "description": "State of the shipping address."
+                                            },
+                                            "country": {
+                                              "type": "string",
+                                              "description": "Three letter ISO code of the country of the shipping address."
+                                            },
+                                            "street": {
+                                              "type": "string",
+                                              "description": "Street of the shipping address."
+                                            },
+                                            "number": {
+                                              "type": "string",
+                                              "description": "Number of the building, house or apartment in the shipping address."
+                                            },
+                                            "neighborhood": {
+                                              "type": "string",
+                                              "description": "Neighborhood of the shipping address."
+                                            },
+                                            "complement": {
+                                              "type": "string",
+                                              "description": "Complement to the shipping address, in case it applies.",
+                                              "nullable": true
+                                            },
+                                            "reference": {
+                                              "type": "string",
+                                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                              "nullable": true
+                                            },
+                                            "geoCoordinates": {
+                                              "type": "array",
+                                              "description": "Array with two strings that repesent geocoordinates: first latitude, then longitude.",
+                                              "items": {
+                                                "type": "number",
+                                                "description": "Geocoordinates."
+                                              }
+                                            }
+                                          }
+                                        },
+                                        "additionalInfo": {
+                                          "type": "string",
+                                          "description": "Additional information.",
+                                          "nullable": true
+                                        },
+                                        "dockId": {
+                                          "type": "string",
+                                          "description": "Corresponding dock ID.",
+                                          "nullable": true
+                                        }
+                                      }
+                                    },
+                                    "pickupPointId": {
+                                      "type": "string",
+                                      "description": "Pickup point ID.",
+                                      "nullable": true
+                                    },
+                                    "pickupDistance": {
+                                      "type": "integer",
+                                      "description": "Pickup point distance."
+                                    },
+                                    "polygonName": {
+                                      "type": "string",
+                                      "description": "Polygon name.",
+                                      "nullable": true
+                                    },
+                                    "transitTime": {
+                                      "type": "string",
+                                      "description": "Transit time. For instance, \"three business days\" is represented as `3bd`."
+                                    }
+                                  }
+                                }
+                              },
+                              "shipsTo": {
+                                "type": "array",
+                                "description": "List of countries that the item may be shipped to.",
+                                "items": {
+                                  "type": "string",
+                                  "description": "Three letter country code."
+                                }
+                              },
+                              "itemId": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "deliveryChannels": {
+                                "type": "array",
+                                "description": "List of available delivery channels.",
+                                "items": {
+                                  "description": "Delivery channel information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "Delivery channel ID."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "selectedAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the selected addresses for the order.",
+                          "items": {
+                            "description": "Selected address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "availableAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the available addresses for the order.",
+                          "items": {
+                            "description": "Available address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "clientProfileData": {
+                      "type": "object",
+                      "description": "Customer's profile information.",
+                      "nullable": true,
+                      "properties": {
+                        "email": {
+                          "type": "string",
+                          "description": "Email address.",
+                          "nullable": true
+                        },
+                        "firstName": {
+                          "type": "string",
+                          "description": "First name.",
+                          "nullable": true
+                        },
+                        "lastName": {
+                          "type": "string",
+                          "description": "Last name."
+                        },
+                        "documentType": {
+                          "type": "string",
+                          "description": "Type of the document informed by the customer."
+                        },
+                        "document": {
+                          "type": "string",
+                          "description": "Document informed by the customer."
+                        },
+                        "phone": {
+                          "type": "string",
+                          "description": "Phone number."
+                        },
+                        "corporateName": {
+                          "type": "string",
+                          "description": "Company name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "tradeName": {
+                          "type": "string",
+                          "description": "Trade name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporateDocument": {
+                          "type": "string",
+                          "description": "Corporate document, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "stateInscription": {
+                          "type": "string",
+                          "description": "State inscription, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporatePhone": {
+                          "type": "string",
+                          "description": "Corporate phone number, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "isCorporate": {
+                          "type": "boolean",
+                          "description": "Indicates whether the customer is a legal entity."
+                        },
+                        "profileCompleteOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile is complete on loading."
+                        },
+                        "profileErrorOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile presents error on loading.",
+                          "nullable": true
+                        },
+                        "customerClass": {
+                          "type": "string",
+                          "description": "Customer class.",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "paymentData": {
+                      "type": "object",
+                      "description": "Information on the order's payment.",
+                      "properties": {
+                        "giftCards": {
+                          "type": "array",
+                          "description": "Gift card information, if it applies to the order.",
+                          "items": {
+                            "description": "Gift card information.",
+                            "type": "object",
+                            "properties": {
+                              "redemptionCode": {
+                                "type": "string",
+                                "description": "Gift card redemption code."
+                              },
+                              "value": {
+                                "type": "integer",
+                                "description": "Gift card value in cents."
+                              },
+                              "balance": {
+                                "type": "integer",
+                                "description": "Gift card balance in cents."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Gift card name."
+                              },
+                              "id": {
+                                "type": "string",
+                                "description": "Gift card ID."
+                              },
+                              "inUse": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is in use."
+                              },
+                              "isSpecialCard": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is special."
+                              }
+                            }
+                          }
+                        },
+                        "transactions": {
+                          "type": "array",
+                          "description": "Information on each transaction pertinent to the order.",
+                          "items": {
+                            "description": "Transaction information.",
+                            "nullable": true,
+                            "type": "object",
+                            "properties": {
+                              "isActive": {
+                                "type": "boolean",
+                                "description": "Indicates whether transaction is active."
+                              },
+                              "transactionId": {
+                                "type": "string",
+                                "description": "Transaction ID."
+                              },
+                              "merchantName": {
+                                "type": "string",
+                                "description": "Merchant name."
+                              },
+                              "payments": {
+                                "type": "array",
+                                "description": "Information on each payment.",
+                                "items": {
+                                  "description": "Payment information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "accountId": {
+                                      "type": "string",
+                                      "description": "Account ID."
+                                    },
+                                    "bin": {
+                                      "type": "string",
+                                      "description": "Bin.",
+                                      "nullable": true
+                                    },
+                                    "installments": {
+                                      "type": "integer",
+                                      "description": "Number of installments."
+                                    },
+                                    "paymentSystem": {
+                                      "type": "string",
+                                      "description": "Payment system."
+                                    },
+                                    "referenceValue": {
+                                      "type": "integer",
+                                      "description": "Reference value for calculating interest rates, in case it applies. Displayed in cents."
+                                    },
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value including interest, in case it applies. Displayed in cents."
+                                    }
+                                  }
+                                }
+                              },
+                              "sharedTransaction": {
+                                "type": "boolean",
+                                "description": "Indicates whather transaction is shared."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "marketingData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Object containing promotion data such as coupon tracking information and internal or external UTMs.",
+                      "properties": {
+                        "coupon": {
+                          "type": "string",
+                          "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.",
+                          "example": "free-shipping"
+                        },
+                        "utmSource": {
+                          "type": "string",
+                          "description": "UTM source.",
+                          "example": "Facebook"
+                        },
+                        "utmMedium": {
+                          "type": "string",
+                          "description": "UTM medium.",
+                          "example": "CPC"
+                        },
+                        "utmCampaign": {
+                          "type": "string",
+                          "description": "UTM campaign.",
+                          "example": "Black friday"
+                        },
+                        "utmiPage": {
+                          "type": "string",
+                          "description": "utmi_page (internal utm).",
+                          "example": "utmi_page-example",
+                          "nullable": true
+                        },
+                        "utmiPart": {
+                          "type": "string",
+                          "description": "utmi_part (internal utm).",
+                          "example": "utmi_part-example",
+                          "nullable": true
+                        },
+                        "utmiCampaign": {
+                          "type": "string",
+                          "description": "utmi_campaign (internal utm).",
+                          "example": "utmi_campaign-example",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "sellers": {
+                      "type": "array",
+                      "description": "Information on each seller.",
+                      "items": {
+                        "description": "Seller information.",
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "Seller ID."
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Seller name."
+                          },
+                          "logo": {
+                            "type": "string",
+                            "description": "Seller logo.",
+                            "nullable": true
+                          }
+                        }
+                      }
+                    },
+                    "clientPreferencesData": {
+                      "type": "object",
+                      "description": "Object containing preferences from the client who placed the order.",
+                      "properties": {
+                        "locale": {
+                          "type": "string",
+                          "description": "Client's locale. Examples: `pt-BR` and `en-US`."
+                        },
+                        "optinNewsLetter": {
+                          "type": "boolean",
+                          "description": "`true` if the client opted to receive newsletter from the store.",
+                          "example": false,
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "commercialConditionData": {
+                      "type": "object",
+                      "description": "Object containing commercial condition information.",
+                      "nullable": true
+                    },
+                    "storePreferencesData": {
+                      "type": "object",
+                      "description": "Object containing data from the store's configuration (stored in VTEX's License Manager)."
+                    },
+                    "giftRegistryData": {
+                      "type": "object",
+                      "description": "Gift registry list information.",
+                      "nullable": true
+                    },
+                    "openTextField": {
+                      "type": "string",
+                      "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).",
+                      "example": "open-text-example",
+                      "nullable": true
+                    },
+                    "invoiceData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Invoice data including billing address.",
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Billing address.",
+                          "properties": {
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City name."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State name."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Country."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street name."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Street number."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Address complement."
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Reference for location."
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Geographic coordinates (latitude, longitude).",
+                              "items": {
+                                "type": "number"
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "customData": {
+                      "type": "object",
+                      "description": "Customer additional information.",
+                      "nullable": true
+                    },
+                    "itemMetadata": {
+                      "type": "object",
+                      "description": "Item metadata.",
+                      "properties": {
+                        "items": {
+                          "type": "array",
+                          "description": "List of objects containing metadata on each item in the order.",
+                          "items": {
+                            "description": "Item metadata.",
+                            "type": "object",
+                            "properties": {
+                              "id": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "seller": {
+                                "type": "string",
+                                "description": "Seller."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Product name."
+                              },
+                              "skuName": {
+                                "type": "string",
+                                "description": "SKU name."
+                              },
+                              "productId": {
+                                "type": "string",
+                                "description": "Product ID."
+                              },
+                              "refId": {
+                                "type": "string",
+                                "description": "Ref ID."
+                              },
+                              "ean": {
+                                "type": "string",
+                                "description": "European Article Number.",
+                                "nullable": true
+                              },
+                              "imageUrl": {
+                                "type": "string",
+                                "description": "Image URL."
+                              },
+                              "detailUrl": {
+                                "type": "string",
+                                "description": "Detail URL."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "hooksData": {
+                      "type": "object",
+                      "description": "Hooks information.",
+                      "nullable": true
+                    },
+                    "ratesAndBenefitsData": {
+                      "type": "object",
+                      "description": "Information on rates and benefits that apply to the order.",
+                      "properties": {
+                        "rateAndBenefitsIdentifiers": {
+                          "type": "array",
+                          "description": "List with rates and benefits identifiers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit identifier."
+                          }
+                        },
+                        "teaser": {
+                          "type": "array",
+                          "description": "List with rates and benefits teasers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit teaser."
+                          }
+                        }
+                      }
+                    },
+                    "subscriptionData": {
+                      "type": "object",
+                      "description": "Subscription information.",
+                      "nullable": true
+                    },
+                    "itemsOrdination": {
+                      "type": "object",
+                      "description": "Object containing information about the ordering of items within the `orderForm`.",
+                      "properties": {
+                        "criteria": {
+                          "type": "string",
+                          "description": "Criteria adopted to order the items in the list."
+                        },
+                        "ascending": {
+                          "type": "boolean",
+                          "description": "Indicates whether the ordering is ascending."
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/api/checkout/pub/profiles": {
+      "get": {
+        "tags": [
+          "Cart attachments"
+        ],
+        "summary": "Get client profile by email",
+        "description": "Retrieves a client's profile information by providing an email address.\n\r\n\rIf the response body fields are empty, the following situations may have occurred:\n\r\n\r1. There is no client registered with the email address provided in your store, or;\n\r2. 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).\r\n\r\n>⚠️ 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.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Shopping Cart Full Access** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Checkout Admin | Shopping Cart Full Access |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "GetClientProfileByEmail",
+        "security": [],
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "email",
+            "in": "query",
+            "description": "Client's email address to be searched.",
+            "required": true,
+            "style": "form",
+            "schema": {
+              "type": "string",
+              "example": "clark.kent@examplemail.com"
+            }
+          },
+          {
+            "name": "ensureComplete",
+            "in": "query",
+            "description": "Indicates whether the returned profiles must be complete or not.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": false
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "userProfileId": {
+                      "type": "string",
+                      "description": "Unique ID associated with the customer profile."
+                    },
+                    "profileProvider": {
+                      "type": "string",
+                      "description": "Profile provider."
+                    },
+                    "availableAccounts": {
+                      "type": "array",
+                      "description": "Available accounts.",
+                      "items": {
+                        "type": "string",
+                        "description": "Account name."
+                      }
+                    },
+                    "availableAddresses": {
+                      "type": "array",
+                      "description": "Information on each available address.",
+                      "items": {
+                        "type": "object",
+                        "description": "Address information.",
+                        "properties": {
+                          "addressType": {
+                            "type": "string",
+                            "description": "Address type."
+                          },
+                          "receiverName": {
+                            "type": "string",
+                            "description": "Name of the receiver."
+                          },
+                          "addressId": {
+                            "type": "string",
+                            "description": "Address ID.",
+                            "nullable": true
+                          },
+                          "isDisposable": {
+                            "type": "boolean",
+                            "description": "Indicates whether address is disposable."
+                          },
+                          "city": {
+                            "type": "string",
+                            "description": "City of the address."
+                          },
+                          "state": {
+                            "type": "string",
+                            "description": "State of the address."
+                          },
+                          "country": {
+                            "type": "string",
+                            "description": "Country of the address. ISO three-letter code."
+                          },
+                          "street": {
+                            "type": "string",
+                            "description": "Street of the address."
+                          },
+                          "number": {
+                            "type": "string",
+                            "description": "Number of the address."
+                          },
+                          "neighborhood": {
+                            "type": "string",
+                            "description": "Neighborhood of the address."
+                          },
+                          "complement": {
+                            "type": "string",
+                            "description": "Complement to the address.",
+                            "nullable": true
+                          },
+                          "reference": {
+                            "type": "string",
+                            "description": "Reference that may help in the location of the address.",
+                            "nullable": true
+                          },
+                          "geoCoordinates": {
+                            "type": "array",
+                            "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
+                            "items": {
+                              "type": "number",
+                              "description": "Geocoordinates numbers."
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "userProfile": {
+                      "type": "object",
+                      "description": "Customer profile information.",
+                      "properties": {
+                        "email": {
+                          "type": "string",
+                          "description": "Email address.",
+                          "nullable": true
+                        },
+                        "firstName": {
+                          "type": "string",
+                          "description": "First name.",
+                          "nullable": true
+                        },
+                        "lastName": {
+                          "type": "string",
+                          "description": "Last name."
+                        },
+                        "document": {
+                          "type": "string",
+                          "description": "Document."
+                        },
+                        "documentType": {
+                          "type": "string",
+                          "description": "Document type."
+                        },
+                        "phone": {
+                          "type": "string",
+                          "description": "Telephone number."
+                        },
+                        "corporateName": {
+                          "type": "string",
+                          "description": "Name of the company. Used for corporate clients.",
+                          "nullable": true
+                        },
+                        "tradeName": {
+                          "type": "string",
+                          "description": "Trade name. Used for corporate clients.",
+                          "nullable": true
+                        },
+                        "corporateDocument": {
+                          "type": "string",
+                          "description": "Document. Used for corporate clients.",
+                          "nullable": true
+                        },
+                        "stateInscription": {
+                          "type": "string",
+                          "description": "State inscription. Used for corporate clients.",
+                          "nullable": true
+                        },
+                        "corporatePhone": {
+                          "type": "string",
+                          "description": "Telephone number. Used for corporate clients.",
+                          "nullable": true
+                        },
+                        "isCorporate": {
+                          "type": "boolean",
+                          "description": "Indicates whether the client is corporate."
+                        },
+                        "profileCompleteOnLoading": {
+                          "type": "boolean",
+                          "description": "Profile complete when loading.",
+                          "nullable": true
+                        },
+                        "profileErrorOnLoading": {
+                          "type": "boolean",
+                          "description": "Profile error when loading.",
+                          "nullable": true
+                        },
+                        "customerClass": {
+                          "type": "string",
+                          "description": "Customer class.",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "isComplete": {
+                      "type": "boolean",
+                      "description": "Indicates whether customer profile is complete."
+                    }
+                  }
+                },
+                "example": {
+                  "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
+                  "profileProvider": "VTEX",
+                  "availableAccounts": [],
+                  "availableAddresses": [
+                    {
+                      "addressType": "residential",
+                      "receiverName": "Clark Kent",
+                      "addressId": "666c2e830bd9474ab6f6cc53fb6dd2d2",
+                      "isDisposable": false,
+                      "postalCode": "12345-000",
+                      "city": "Metropolis",
+                      "state": "NY",
+                      "country": "USA",
+                      "street": "My street",
+                      "number": "123",
+                      "neighborhood": "My neighborhood",
+                      "complement": "Complement",
+                      "reference": "Reference",
+                      "geoCoordinates": [
+                        -47.924747467041016,
+                        -15.832582473754883
+                      ]
+                    }
+                  ],
+                  "userProfile": {
+                    "email": "clark.kent@example.com",
+                    "firstName": "Clark",
+                    "lastName": "Kent",
+                    "document": "12345678900",
+                    "documentType": "cpf",
+                    "phone": "+556199999999",
+                    "corporateName": "company-name",
+                    "tradeName": "trade-name",
+                    "corporateDocument": "12345678000100",
+                    "stateInscription": "12345678",
+                    "corporatePhone": "551100988887777",
+                    "isCorporate": false,
+                    "profileCompleteOnLoading": false,
+                    "profileErrorOnLoading": false,
+                    "customerClass": null
+                  },
+                  "isComplete": true
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/api/checkout/pub/orderForm/{orderFormId}/attachments/clientProfileData": {
+      "post": {
+        "tags": [
+          "Cart attachments"
+        ],
+        "summary": "Add client profile",
+        "description": "Use this request to include client profile information to a given shopping cart.\r\n\r\nThe [orderForm](https://developers.vtex.com/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.\n\r\n\r> This request has a time out of 12 seconds.\r\n\r\n>⚠️ 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.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "AddClientProfile",
+        "security": [],
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "orderFormId",
+            "in": "path",
+            "description": "ID of the orderForm that will receive client profile information.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "ede846222cd44046ba6c638442c3505a"
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "description": "Customer's profile information.",
+                "required": [
+                  "email",
+                  "firstName",
+                  "lastName",
+                  "documentType",
+                  "document"
+                ],
+                "properties": {
+                  "email": {
+                    "type": "string",
+                    "description": "Customer's email address.",
+                    "example": "customer@examplemail.com",
+                    "nullable": true
+                  },
+                  "firstName": {
+                    "type": "string",
+                    "description": "Customer's first name.",
+                    "example": "first-name",
+                    "nullable": true
+                  },
+                  "lastName": {
+                    "type": "string",
+                    "description": "Customer's last name.",
+                    "example": "last-name"
+                  },
+                  "documentType": {
+                    "type": "string",
+                    "description": "Type of the document informed by the customer.",
+                    "example": "cpf"
+                  },
+                  "document": {
+                    "type": "string",
+                    "description": "Document number informed by the customer.",
+                    "example": "123456789"
+                  },
+                  "phone": {
+                    "type": "string",
+                    "description": "Customer's phone number.",
+                    "example": "+55110988887777"
+                  },
+                  "corporateName": {
+                    "type": "string",
+                    "description": "Company name, if the customer is a legal entity.",
+                    "example": "company-name"
+                  },
+                  "tradeName": {
+                    "type": "string",
+                    "description": "Trade name, if the customer is a legal entity.",
+                    "example": "trade-name"
+                  },
+                  "corporateDocument": {
+                    "type": "string",
+                    "description": "Corporate document, if the customer is a legal entity.",
+                    "example": "12345678000100"
+                  },
+                  "stateInscription": {
+                    "type": "string",
+                    "description": "State inscription, if the customer is a legal entity.",
+                    "example": "12345678"
+                  },
+                  "corporatePhone": {
+                    "type": "string",
+                    "description": "Corporate phone number, if the customer is a legal entity.",
+                    "example": "+551100988887777"
+                  },
+                  "isCorporate": {
+                    "type": "boolean",
+                    "description": "Set `true` if the customer is a legal entity.",
+                    "example": false
+                  }
+                }
+              },
+              "example": {
+                "email": "orders@acmecorp.com",
+                "firstName": "Jane",
+                "lastName": "Smith",
+                "documentType": "cnpj",
+                "document": "12345678000199",
+                "phone": "+5511987654321",
+                "corporateName": "Acme Corporation Ltda",
+                "tradeName": "Acme Corp",
+                "corporateDocument": "12345678000199",
+                "stateInscription": "123456789",
+                "corporatePhone": "+551122334455",
+                "isCorporate": true
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "example": {
+                  "orderFormId": "9ceee0fde6db489fbc809a0e2ab13a86",
+                  "salesChannel": "1",
+                  "loggedIn": false,
+                  "isCheckedIn": false,
+                  "storeId": "1",
+                  "checkedInPickupPointId": "21",
+                  "allowManualPrice": false,
+                  "canEditData": true,
+                  "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
+                  "userType": "User type",
+                  "ignoreProfileData": false,
+                  "value": 0,
+                  "messages": [],
+                  "items": [],
+                  "selectableGifts": [],
+                  "totalizers": [],
+                  "shippingData": null,
+                  "clientProfileData": {
+                    "email": "clark.kent@examplemail.com",
+                    "firstName": "Clark",
+                    "lastName": "Kent",
+                    "document": "44444444444",
+                    "documentType": "cpf",
+                    "phone": "+5511123456789",
+                    "corporateName": "company-name",
+                    "tradeName": "trade-name",
+                    "corporateDocument": "12345678000100",
+                    "stateInscription": "12345678",
+                    "corporatePhone": "551100988887777",
+                    "isCorporate": false,
+                    "profileCompleteOnLoading": false,
+                    "profileErrorOnLoading": false,
+                    "customerClass": null
+                  },
+                  "paymentData": {
+                    "updateStatus": "updated",
+                    "installmentOptions": [],
+                    "paymentSystems": [],
+                    "payments": [
+                      {
+                        "paymentSystem": 6,
+                        "bin": null,
+                        "accountId": "12",
+                        "tokenId": null,
+                        "value": 34390,
+                        "referenceValue": 34390,
+                        "giftCardRedemptionCode": null,
+                        "giftCardProvider": null,
+                        "giftCardId": null
+                      }
+                    ],
+                    "giftCards": [],
+                    "giftCardMessages": [],
+                    "availableAccounts": [],
+                    "availableTokens": []
+                  },
+                  "marketingData": null,
+                  "sellers": [],
+                  "clientPreferencesData": {
+                    "locale": "pt-BR",
+                    "optinNewsLetter": null
+                  },
+                  "commercialConditionData": null,
+                  "storePreferencesData": {
+                    "countryCode": "BRA",
+                    "saveUserData": true,
+                    "timeZone": "E. South America Standard Time",
+                    "currencyCode": "BRL",
+                    "currencyLocale": 1046,
+                    "currencySymbol": "R$",
+                    "currencyFormatInfo": {
+                      "currencyDecimalDigits": 2,
+                      "currencyDecimalSeparator": ",",
+                      "currencyGroupSeparator": ".",
+                      "currencyGroupSize": 3,
+                      "startsWithCurrencySymbol": true
+                    }
+                  },
+                  "giftRegistryData": null,
+                  "openTextField": null,
+                  "invoiceData": null,
+                  "customData": null,
+                  "itemMetadata": {
+                    "items": [
+                      {
+                        "id": "1",
+                        "seller": "1",
+                        "name": "Ração Royal Canin Feline Urinary 500g",
+                        "skuName": "Ração Royal Canin Feline Urinary 500g",
+                        "productId": "1",
+                        "refId": "0001",
+                        "ean": "123456789",
+                        "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
+                        "detailUrl": "/racao-royal-canin-feline-urinary/p",
+                        "assemblyOptions": []
+                      }
+                    ]
+                  },
+                  "hooksData": null,
+                  "ratesAndBenefitsData": {
+                    "rateAndBenefitsIdentifiers": [],
+                    "teaser": []
+                  },
+                  "subscriptionData": null,
+                  "itemsOrdination": {
+                    "criteria": "NAME",
+                    "ascending": true
+                  }
+                },
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "orderFormId": {
+                      "type": "string",
+                      "description": "ID of the orderForm corresponding to a specific cart."
+                    },
+                    "salesChannel": {
+                      "type": "string",
+                      "description": "Attribute created by the seller, in their VTEX store configuration."
+                    },
+                    "loggedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether the user is logged into the store."
+                    },
+                    "isCheckedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether order is checked in."
+                    },
+                    "storeId": {
+                      "type": "string",
+                      "description": "ID of the store.",
+                      "nullable": true
+                    },
+                    "allowManualPrice": {
+                      "type": "boolean",
+                      "description": "Permission to modify item price manually."
+                    },
+                    "canEditData": {
+                      "type": "boolean",
+                      "description": "Data can be edited."
+                    },
+                    "userProfileId": {
+                      "type": "string",
+                      "description": "Unique ID associated with the customer profile."
+                    },
+                    "profileProvider": {
+                      "type": "string",
+                      "description": "Profile provider."
+                    },
+                    "availableAccounts": {
+                      "type": "array",
+                      "description": "Available accounts.",
+                      "items": {
+                        "type": "string",
+                        "description": "Account."
+                      }
+                    },
+                    "availableAddresses": {
+                      "type": "array",
+                      "description": "Information on each available address.",
+                      "items": {
+                        "description": "Address information.",
+                        "type": "object",
+                        "properties": {
+                          "addressType": {
+                            "type": "string",
+                            "description": "Address type."
+                          },
+                          "receiverName": {
+                            "type": "string",
+                            "description": "Name of the receiver."
+                          },
+                          "addressId": {
+                            "type": "string",
+                            "description": "Address ID.",
+                            "nullable": true
+                          },
+                          "isDisposable": {
+                            "type": "boolean",
+                            "description": "Indicates whether address is disposable."
+                          },
+                          "city": {
+                            "type": "string",
+                            "description": "City of the address."
+                          },
+                          "state": {
+                            "type": "string",
+                            "description": "State of the address."
+                          },
+                          "country": {
+                            "type": "string",
+                            "description": "Country of the address. ISO three-letter code."
+                          },
+                          "street": {
+                            "type": "string",
+                            "description": "Street of the address."
+                          },
+                          "number": {
+                            "type": "string",
+                            "description": "Number of the address."
+                          },
+                          "neighborhood": {
+                            "type": "string",
+                            "description": "Neighborhood of the address."
+                          },
+                          "complement": {
+                            "description": "Complement to the shipping address, in case it applies.",
+                            "type": "string",
+                            "nullable": true
+                          },
+                          "reference": {
+                            "type": "string",
+                            "description": "Reference that may help in the location of the address.",
+                            "nullable": true
+                          },
+                          "geoCoordinates": {
+                            "type": "array",
+                            "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                            "items": {
+                              "type": "number",
+                              "description": "Geocoordinates."
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "userType": {
+                      "type": "string",
+                      "description": "User type.",
+                      "nullable": true
+                    },
+                    "ignoreProfileData": {
+                      "type": "boolean",
+                      "description": "Ignore customer profile data."
+                    },
+                    "value": {
+                      "type": "integer",
+                      "description": "Total value of the order without separating cents. For example, $24.99 is represented as `2499`."
+                    },
+                    "messages": {
+                      "type": "array",
+                      "description": "Array containing an object for each message generated by our servers while processing the request.",
+                      "items": {
+                        "type": "string",
+                        "description": "Message."
+                      }
+                    },
+                    "items": {
+                      "type": "array",
+                      "description": "Information on each item in the order.",
+                      "items": {
+                        "description": "Item information.",
+                        "type": "object",
+                        "properties": {
+                          "uniqueId": {
+                            "type": "string",
+                            "description": "Unique ID."
+                          },
+                          "id": {
+                            "type": "string",
+                            "description": "ID of the item."
+                          },
+                          "productId": {
+                            "type": "string",
+                            "description": "Product ID."
+                          },
+                          "productRefId": {
+                            "type": "string",
+                            "description": "Product Ref ID."
+                          },
+                          "refId": {
+                            "type": "string",
+                            "description": "Ref ID."
+                          },
+                          "ean": {
+                            "type": "string",
+                            "description": "European Article Number.",
+                            "nullable": true
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Product name."
+                          },
+                          "skuName": {
+                            "type": "string",
+                            "description": "SKU name."
+                          },
+                          "modalType": {
+                            "type": "string",
+                            "description": "Modal type.",
+                            "nullable": true
+                          },
+                          "parentItemIndex": {
+                            "type": "integer",
+                            "description": "Parent item index.",
+                            "nullable": true
+                          },
+                          "parentAssemblyBinding": {
+                            "type": "string",
+                            "description": "Parent assembly binding.",
+                            "nullable": true
+                          },
+                          "priceValidUntil": {
+                            "type": "string",
+                            "description": "Price expiration date and time."
+                          },
+                          "tax": {
+                            "type": "integer",
+                            "description": "Tax value in cents."
+                          },
+                          "taxCode": {
+                            "type": "string",
+                            "description": "A unique identifier code assigned to a tax within the VTEX Admin."
+                          },
+                          "price": {
+                            "type": "integer",
+                            "description": "Price in cents."
+                          },
+                          "listPrice": {
+                            "type": "integer",
+                            "description": "List price in cents."
+                          },
+                          "manualPrice": {
+                            "type": "integer",
+                            "description": "Manual price in cents.",
+                            "nullable": true
+                          },
+                          "manualPriceAppliedBy": {
+                            "type": "string",
+                            "description": "User that applied the manual price, if that is the case.",
+                            "nullable": true
+                          },
+                          "sellingPrice": {
+                            "type": "integer",
+                            "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
+                          },
+                          "rewardValue": {
+                            "type": "integer",
+                            "description": "Reward value in cents."
+                          },
+                          "isGift": {
+                            "type": "boolean",
+                            "description": "Indicates whether item is a gift."
+                          },
+                          "additionalInfo": {
+                            "type": "object",
+                            "description": "Additional information.",
+                            "properties": {
+                              "dimension": {
+                                "type": "string",
+                                "description": "Dimension.",
+                                "nullable": true
+                              },
+                              "brandName": {
+                                "type": "string",
+                                "description": "Brand name."
+                              },
+                              "brandId": {
+                                "type": "string",
+                                "description": "Brand ID."
+                              },
+                              "offeringInfo": {
+                                "type": "string",
+                                "description": "Offering information.",
+                                "nullable": true
+                              },
+                              "offeringType": {
+                                "type": "string",
+                                "description": "Offering type.",
+                                "nullable": true
+                              },
+                              "offeringTypeId": {
+                                "type": "string",
+                                "description": "Offering type ID.",
+                                "nullable": true
+                              }
+                            }
+                          },
+                          "preSaleDate": {
+                            "type": "string",
+                            "description": "Presale date.",
+                            "nullable": true
+                          },
+                          "productCategoryIds": {
+                            "type": "string",
+                            "description": "Product category IDs."
+                          },
+                          "productCategories": {
+                            "type": "object",
+                            "description": "Object, where each field is an ID from `productCategoryIds`.",
+                            "properties": {
+                              "{ID}": {
+                                "type": "string",
+                                "description": "Product category corresponding to the ID in the field key."
+                              }
+                            }
+                          },
+                          "quantity": {
+                            "type": "integer",
+                            "description": "Quantity."
+                          },
+                          "seller": {
+                            "type": "string",
+                            "description": "Seller."
+                          },
+                          "sellerChain": {
+                            "type": "array",
+                            "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
+                            "items": {
+                              "type": "string",
+                              "description": "Seller."
+                            }
+                          },
+                          "imageUrl": {
+                            "type": "string",
+                            "description": "Image URL."
+                          },
+                          "detailUrl": {
+                            "type": "string",
+                            "description": "Detail URL."
+                          },
+                          "bundleItems": {
+                            "type": "array",
+                            "description": "Information on services sold along with the SKU. Example: a gift package.",
+                            "items": {
+                              "description": "Service information.",
+                              "type": "object",
+                              "properties": {
+                                "type": {
+                                  "type": "string",
+                                  "description": "Service type."
+                                },
+                                "id": {
+                                  "type": "integer",
+                                  "description": "Service identifier."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Service name."
+                                },
+                                "price": {
+                                  "type": "integer",
+                                  "description": "Service price in cents."
+                                }
+                              }
+                            }
+                          },
+                          "attachments": {
+                            "type": "array",
+                            "description": "Array containing information on attachments.",
+                            "items": {
+                              "type": "string",
+                              "description": "Attachment."
+                            }
+                          },
+                          "priceTags": {
+                            "type": "array",
+                            "description": "Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.",
+                            "items": {
+                              "description": "Price tag information.",
+                              "type": "object",
+                              "properties": {
+                                "identifier": {
+                                  "type": "string",
+                                  "description": "Promotion unique identifier.",
+                                  "nullable": true
+                                },
+                                "isPercentual": {
+                                  "type": "boolean",
+                                  "description": "Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\r\n- `type` indicates whether the tag refers to a discount or tax.\r\n- `where` specifies the context, either price or shipping.\r\n- `identifier` is the promotion ID.\r\n- `calculationId` is a hash that may vary with each price calculation."
+                                },
+                                "rawValue": {
+                                  "type": "number",
+                                  "description": "Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations."
+                                },
+                                "value": {
+                                  "type": "integer",
+                                  "description": "Price tag value representing either a promotion (value decrease) or a tax (value increase)."
+                                }
+                              }
+                            }
+                          },
+                          "availability": {
+                            "type": "string",
+                            "description": "Availability."
+                          },
+                          "measurementUnit": {
+                            "type": "string",
+                            "description": "Measurement unit."
+                          },
+                          "unitMultiplier": {
+                            "type": "integer",
+                            "description": "Unit multiplier."
+                          },
+                          "manufacturerCode": {
+                            "type": "string",
+                            "description": "Manufacturer code.",
+                            "nullable": true
+                          },
+                          "priceDefinition": {
+                            "type": "object",
+                            "description": "Price information for all units of a specific item.",
+                            "properties": {
+                              "calculatedSellingPrice": {
+                                "type": "integer",
+                                "description": "Item's calculated unitary selling price in cents."
+                              },
+                              "total": {
+                                "type": "integer",
+                                "description": "Total value for all units of the item in cents."
+                              },
+                              "sellingPrices": {
+                                "type": "array",
+                                "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
+                                "items": {
+                                  "description": "Rounding information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value in cents for that specific rounding."
+                                    },
+                                    "quantity": {
+                                      "type": "integer",
+                                      "description": "Rounding quantity, meaning how many items are rounded to this value."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "selectableGifts": {
+                      "type": "array",
+                      "description": "Array containing the data of the item selected as a gift.",
+                      "items": {
+                        "type": "string",
+                        "description": "Gift."
+                      }
+                    },
+                    "totalizers": {
+                      "type": "array",
+                      "description": "Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).",
+                      "items": {
+                        "type": "object",
+                        "description": "Totalizer of purchases."
+                      }
+                    },
+                    "shippingData": {
+                      "type": "object",
+                      "description": "Shipping information pertinent to the order.",
+                      "nullable": true,
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Address information.",
+                          "nullable": true,
+                          "properties": {
+                            "addressType": {
+                              "type": "string",
+                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                            },
+                            "receiverName": {
+                              "type": "string",
+                              "description": "Name of the person who is going to receive the order."
+                            },
+                            "addressId": {
+                              "type": "string",
+                              "description": "Address ID.",
+                              "nullable": true
+                            },
+                            "isDisposable": {
+                              "type": "boolean",
+                              "description": "Indicates whether address is disposable."
+                            },
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City of the shipping address."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State of the shipping address."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Three letter ISO code of the country of the shipping address."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street of the shipping address."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Number of the building, house or apartment in the shipping address."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood of the shipping address."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Complement to the shipping address, in case it applies.",
+                              "nullable": true
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                              "nullable": true
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                              "items": {
+                                "type": "number",
+                                "description": "Geocoordinates."
+                              }
+                            }
+                          }
+                        },
+                        "logisticsInfo": {
+                          "type": "array",
+                          "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.",
+                          "items": {
+                            "description": "Logistics information.",
+                            "type": "object",
+                            "properties": {
+                              "itemIndex": {
+                                "type": "integer",
+                                "description": "Index corresponding to the position of the object in the `items` array."
+                              },
+                              "selectedSla": {
+                                "type": "string",
+                                "description": "SLA selected by the customer.",
+                                "nullable": true
+                              },
+                              "selectedDeliveryChannel": {
+                                "type": "string",
+                                "description": "Delivery channel selected by the customer.",
+                                "nullable": true
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "slas": {
+                                "type": "array",
+                                "description": "Information on available SLAs.",
+                                "items": {
+                                  "description": "SLA information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "SLA ID."
+                                    },
+                                    "deliveryChannel": {
+                                      "type": "string",
+                                      "description": "Delivery channel."
+                                    },
+                                    "name": {
+                                      "type": "string",
+                                      "description": "SLA name."
+                                    },
+                                    "deliveryIds": {
+                                      "type": "array",
+                                      "description": "Information on each delivery ID.",
+                                      "items": {
+                                        "description": "Delivery ID information.",
+                                        "type": "object",
+                                        "properties": {
+                                          "courierId": {
+                                            "type": "string",
+                                            "description": "Courier ID."
+                                          },
+                                          "warehouseId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "dockId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "courierName": {
+                                            "type": "string",
+                                            "description": "Courier name."
+                                          },
+                                          "quantity": {
+                                            "type": "integer",
+                                            "description": "Quantity."
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "attachmentOfferings": {
+                                      "type": "array",
+                                      "description": "List of attachments details.",
+                                      "nullable": true,
+                                      "items": {
+                                        "description": "Attachment details.",
+                                        "type": "object",
+                                        "required": [
+                                          "name",
+                                          "required",
+                                          "schema"
+                                        ],
+                                        "properties": {
+                                          "name": {
+                                            "type": "string",
+                                            "description": "Name of the attachment.",
+                                            "nullable": true
+                                          },
+                                          "required": {
+                                            "type": "boolean",
+                                            "description": "Defines if the attachment is required (`true`) or not (`false`).",
+                                            "nullable": true
+                                          },
+                                          "schema": {
+                                            "type": "object",
+                                            "description": "Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).",
+                                            "nullable": true
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "shippingEstimate": {
+                                      "type": "string",
+                                      "description": "Shipping estimate. For instance, \"three business days\" will be represented as `3bd`."
+                                    },
+                                    "shippingEstimateDate": {
+                                      "type": "string",
+                                      "description": "When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.",
+                                      "nullable": true
+                                    },
+                                    "useIndividualShippingEstimates": {
+                                      "type": "boolean",
+                                      "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`."
+                                    },
+                                    "lockTTL": {
+                                      "type": "string",
+                                      "description": "Estimate date of delivery.",
+                                      "nullable": true
+                                    },
+                                    "price": {
+                                      "type": "integer",
+                                      "description": "Price in cents."
+                                    },
+                                    "listPrice": {
+                                      "type": "integer",
+                                      "description": "List price in cents."
+                                    },
+                                    "tax": {
+                                      "type": "integer",
+                                      "description": "Tax in cents."
+                                    },
+                                    "pickupStoreInfo": {
+                                      "type": "object",
+                                      "description": "Information on the pickup store.",
+                                      "properties": {
+                                        "isPickupStore": {
+                                          "type": "boolean",
+                                          "description": "Indicates whether it is the pickup store."
+                                        },
+                                        "friendlyName": {
+                                          "type": "string",
+                                          "description": "Friendly name.",
+                                          "nullable": true
+                                        },
+                                        "address": {
+                                          "type": "object",
+                                          "description": "Address information.",
+                                          "nullable": true,
+                                          "properties": {
+                                            "addressType": {
+                                              "type": "string",
+                                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                                            },
+                                            "postalCode": {
+                                              "type": "string",
+                                              "description": "Postal code."
+                                            },
+                                            "city": {
+                                              "type": "string",
+                                              "description": "City of the shipping address."
+                                            },
+                                            "state": {
+                                              "type": "string",
+                                              "description": "State of the shipping address."
+                                            },
+                                            "country": {
+                                              "type": "string",
+                                              "description": "Three letter ISO code of the country of the shipping address."
+                                            },
+                                            "street": {
+                                              "type": "string",
+                                              "description": "Street of the shipping address."
+                                            },
+                                            "number": {
+                                              "type": "string",
+                                              "description": "Number of the building, house or apartment in the shipping address."
+                                            },
+                                            "neighborhood": {
+                                              "type": "string",
+                                              "description": "Neighborhood of the shipping address."
+                                            },
+                                            "complement": {
+                                              "type": "string",
+                                              "description": "Complement to the shipping address, in case it applies.",
+                                              "nullable": true
+                                            },
+                                            "reference": {
+                                              "type": "string",
+                                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                              "nullable": true
+                                            },
+                                            "geoCoordinates": {
+                                              "type": "array",
+                                              "description": "Array with two strings that repesent geocoordinates: first latitude, then longitude.",
+                                              "items": {
+                                                "type": "number",
+                                                "description": "Geocoordinates."
+                                              }
+                                            }
+                                          }
+                                        },
+                                        "additionalInfo": {
+                                          "type": "string",
+                                          "description": "Additional information.",
+                                          "nullable": true
+                                        },
+                                        "dockId": {
+                                          "type": "string",
+                                          "description": "Corresponding dock ID.",
+                                          "nullable": true
+                                        }
+                                      }
+                                    },
+                                    "pickupPointId": {
+                                      "type": "string",
+                                      "description": "Pickup point ID.",
+                                      "nullable": true
+                                    },
+                                    "pickupDistance": {
+                                      "type": "integer",
+                                      "description": "Pickup point distance."
+                                    },
+                                    "polygonName": {
+                                      "type": "string",
+                                      "description": "Polygon name.",
+                                      "nullable": true
+                                    },
+                                    "transitTime": {
+                                      "type": "string",
+                                      "description": "Transit time. For instance, \"three business days\" is represented as `3bd`."
+                                    }
+                                  }
+                                }
+                              },
+                              "shipsTo": {
+                                "type": "array",
+                                "description": "List of countries that the item may be shipped to.",
+                                "items": {
+                                  "type": "string",
+                                  "description": "Three letter country code."
+                                }
+                              },
+                              "itemId": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "deliveryChannels": {
+                                "type": "array",
+                                "description": "List of available delivery channels.",
+                                "items": {
+                                  "description": "Delivery channel information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "Delivery channel ID."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "selectedAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the selected addresses for the order.",
+                          "items": {
+                            "description": "Selected address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "availableAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the available addresses for the order.",
+                          "items": {
+                            "description": "Available address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "clientProfileData": {
+                      "type": "object",
+                      "description": "Customer's profile information.",
+                      "nullable": true,
+                      "properties": {
+                        "email": {
+                          "type": "string",
+                          "description": "Email address.",
+                          "nullable": true
+                        },
+                        "firstName": {
+                          "type": "string",
+                          "description": "First name.",
+                          "nullable": true
+                        },
+                        "lastName": {
+                          "type": "string",
+                          "description": "Last name."
+                        },
+                        "documentType": {
+                          "type": "string",
+                          "description": "Type of the document informed by the customer."
+                        },
+                        "document": {
+                          "type": "string",
+                          "description": "Document informed by the customer."
+                        },
+                        "phone": {
+                          "type": "string",
+                          "description": "Phone number."
+                        },
+                        "corporateName": {
+                          "type": "string",
+                          "description": "Company name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "tradeName": {
+                          "type": "string",
+                          "description": "Trade name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporateDocument": {
+                          "type": "string",
+                          "description": "Corporate document, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "stateInscription": {
+                          "type": "string",
+                          "description": "State inscription, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporatePhone": {
+                          "type": "string",
+                          "description": "Corporate phone number, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "isCorporate": {
+                          "type": "boolean",
+                          "description": "Indicates whether the customer is a legal entity."
+                        },
+                        "profileCompleteOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile is complete on loading."
+                        },
+                        "profileErrorOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile presents error on loading.",
+                          "nullable": true
+                        },
+                        "customerClass": {
+                          "type": "string",
+                          "description": "Customer class.",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "paymentData": {
+                      "type": "object",
+                      "description": "Information on the order's payment.",
+                      "properties": {
+                        "giftCards": {
+                          "type": "array",
+                          "description": "Gift card information, if it applies to the order.",
+                          "items": {
+                            "description": "Gift card information.",
+                            "type": "object",
+                            "properties": {
+                              "redemptionCode": {
+                                "type": "string",
+                                "description": "Gift card redemption code."
+                              },
+                              "value": {
+                                "type": "integer",
+                                "description": "Gift card value in cents."
+                              },
+                              "balance": {
+                                "type": "integer",
+                                "description": "Gift card balance in cents."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Gift card name."
+                              },
+                              "id": {
+                                "type": "string",
+                                "description": "Gift card ID."
+                              },
+                              "inUse": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is in use."
+                              },
+                              "isSpecialCard": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is special."
+                              }
+                            }
+                          }
+                        },
+                        "transactions": {
+                          "type": "array",
+                          "description": "Information on each transaction pertinent to the order.",
+                          "items": {
+                            "description": "Transaction information.",
+                            "nullable": true,
+                            "type": "object",
+                            "properties": {
+                              "isActive": {
+                                "type": "boolean",
+                                "description": "Indicates whether transaction is active."
+                              },
+                              "transactionId": {
+                                "type": "string",
+                                "description": "Transaction ID."
+                              },
+                              "merchantName": {
+                                "type": "string",
+                                "description": "Merchant name."
+                              },
+                              "payments": {
+                                "type": "array",
+                                "description": "Information on each payment.",
+                                "items": {
+                                  "description": "Payment information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "accountId": {
+                                      "type": "string",
+                                      "description": "Account ID."
+                                    },
+                                    "bin": {
+                                      "type": "string",
+                                      "description": "Bin.",
+                                      "nullable": true
+                                    },
+                                    "installments": {
+                                      "type": "integer",
+                                      "description": "Number of installments."
+                                    },
+                                    "paymentSystem": {
+                                      "type": "string",
+                                      "description": "Payment system."
+                                    },
+                                    "referenceValue": {
+                                      "type": "integer",
+                                      "description": "Reference value for calculating interest rates, in case it applies. Displayed in cents."
+                                    },
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value including interest, in case it applies. Displayed in cents."
+                                    }
+                                  }
+                                }
+                              },
+                              "sharedTransaction": {
+                                "type": "boolean",
+                                "description": "Indicates whather transaction is shared."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "marketingData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Object containing promotion data such as coupon tracking information and internal or external UTMs.",
+                      "properties": {
+                        "coupon": {
+                          "type": "string",
+                          "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.",
+                          "example": "free-shipping"
+                        },
+                        "utmSource": {
+                          "type": "string",
+                          "description": "UTM source.",
+                          "example": "Facebook"
+                        },
+                        "utmMedium": {
+                          "type": "string",
+                          "description": "UTM medium.",
+                          "example": "CPC"
+                        },
+                        "utmCampaign": {
+                          "type": "string",
+                          "description": "UTM campaign.",
+                          "example": "Black friday"
+                        },
+                        "utmiPage": {
+                          "type": "string",
+                          "description": "utmi_page (internal utm).",
+                          "example": "utmi_page-example",
+                          "nullable": true
+                        },
+                        "utmiPart": {
+                          "type": "string",
+                          "description": "utmi_part (internal utm).",
+                          "example": "utmi_part-example",
+                          "nullable": true
+                        },
+                        "utmiCampaign": {
+                          "type": "string",
+                          "description": "utmi_campaign (internal utm).",
+                          "example": "utmi_campaign-example",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "sellers": {
+                      "type": "array",
+                      "description": "Information on each seller.",
+                      "items": {
+                        "description": "Seller information.",
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "Seller ID."
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Seller name."
+                          },
+                          "logo": {
+                            "type": "string",
+                            "description": "Seller logo.",
+                            "nullable": true
+                          }
+                        }
+                      }
+                    },
+                    "clientPreferencesData": {
+                      "type": "object",
+                      "description": "Object containing preferences from the client who placed the order.",
+                      "properties": {
+                        "locale": {
+                          "type": "string",
+                          "description": "Client's locale. Examples: `pt-BR` and `en-US`."
+                        },
+                        "optinNewsLetter": {
+                          "type": "boolean",
+                          "description": "`true` if the client opted to receive newsletter from the store.",
+                          "example": false,
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "commercialConditionData": {
+                      "type": "object",
+                      "description": "Object containing commercial condition information.",
+                      "nullable": true
+                    },
+                    "storePreferencesData": {
+                      "type": "object",
+                      "description": "Object containing data from the store's configuration (stored in VTEX's License Manager)."
+                    },
+                    "giftRegistryData": {
+                      "type": "object",
+                      "description": "Gift registry list information.",
+                      "nullable": true
+                    },
+                    "openTextField": {
+                      "type": "string",
+                      "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).",
+                      "example": "open-text-example",
+                      "nullable": true
+                    },
+                    "invoiceData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Invoice data including billing address.",
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Billing address.",
+                          "properties": {
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City name."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State name."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Country."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street name."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Street number."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Address complement."
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Reference for location."
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Geographic coordinates (latitude, longitude).",
+                              "items": {
+                                "type": "number"
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "customData": {
+                      "type": "object",
+                      "description": "Customer additional information.",
+                      "nullable": true
+                    },
+                    "itemMetadata": {
+                      "type": "object",
+                      "description": "Item metadata.",
+                      "properties": {
+                        "items": {
+                          "type": "array",
+                          "description": "List of objects containing metadata on each item in the order.",
+                          "items": {
+                            "description": "Item metadata.",
+                            "type": "object",
+                            "properties": {
+                              "id": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "seller": {
+                                "type": "string",
+                                "description": "Seller."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Product name."
+                              },
+                              "skuName": {
+                                "type": "string",
+                                "description": "SKU name."
+                              },
+                              "productId": {
+                                "type": "string",
+                                "description": "Product ID."
+                              },
+                              "refId": {
+                                "type": "string",
+                                "description": "Ref ID."
+                              },
+                              "ean": {
+                                "type": "string",
+                                "description": "European Article Number.",
+                                "nullable": true
+                              },
+                              "imageUrl": {
+                                "type": "string",
+                                "description": "Image URL."
+                              },
+                              "detailUrl": {
+                                "type": "string",
+                                "description": "Detail URL."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "hooksData": {
+                      "type": "object",
+                      "description": "Hooks information.",
+                      "nullable": true
+                    },
+                    "ratesAndBenefitsData": {
+                      "type": "object",
+                      "description": "Information on rates and benefits that apply to the order.",
+                      "properties": {
+                        "rateAndBenefitsIdentifiers": {
+                          "type": "array",
+                          "description": "List with rates and benefits identifiers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit identifier."
+                          }
+                        },
+                        "teaser": {
+                          "type": "array",
+                          "description": "List with rates and benefits teasers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit teaser."
+                          }
+                        }
+                      }
+                    },
+                    "subscriptionData": {
+                      "type": "object",
+                      "description": "Subscription information.",
+                      "nullable": true
+                    },
+                    "itemsOrdination": {
+                      "type": "object",
+                      "description": "Object containing information about the ordering of items within the `orderForm`.",
+                      "properties": {
+                        "criteria": {
+                          "type": "string",
+                          "description": "Criteria adopted to order the items in the list."
+                        },
+                        "ascending": {
+                          "type": "boolean",
+                          "description": "Indicates whether the ordering is ascending."
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/api/checkout/pub/orderForm/{orderFormId}/attachments/shippingData": {
+      "post": {
+        "tags": [
+          "Cart attachments"
+        ],
+        "summary": "Add shipping address and select delivery option",
+        "description": "Use this request to include shipping information and/or selected delivery option to a given shopping cart.\r\n\r\nTo add shipping addresses send the `selectedAddresses` array. For delivery option use the `logisticsInfo` array.\r\n\r\nThe [orderForm](https://developers.vtex.com/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.\n\r\n\r> This request has a time out of 12 seconds.\r\n\r\n>⚠️ 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.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "AddShippingAddress",
+        "security": [],
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "orderFormId",
+            "in": "path",
+            "description": "ID of the orderForm that will receive client profile information.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "ede846222cd44046ba6c638442c3505a"
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "clearAddressIfPostalCodeNotFound": {
+                    "type": "boolean",
+                    "description": "This field should be sent as `false` to prevent the address information from being filled in automatically based on the `postalCode` information.",
+                    "example": false
+                  },
+                  "selectedAddresses": {
+                    "type": "array",
+                    "description": "List of objects with addresses information.",
+                    "items": {
+                      "type": "object",
+                      "description": "Address information.",
+                      "properties": {
+                        "addressType": {
+                          "type": "string",
+                          "description": "Type of address. For example, `Residential` or `Pickup`, among others.",
+                          "example": "residential"
+                        },
+                        "receiverName": {
+                          "type": "string",
+                          "description": "Name of the person who is going to receive the order.",
+                          "example": "receiver name"
+                        },
+                        "addressId": {
+                          "type": "string",
+                          "description": "Address ID.",
+                          "example": "c3701fc4c61b4d1b91f67e81415db44d",
+                          "nullable": true
+                        },
+                        "postalCode": {
+                          "type": "string",
+                          "description": "Postal Code.",
+                          "example": "12345-000"
+                        },
+                        "city": {
+                          "type": "string",
+                          "description": "City of the shipping address.",
+                          "example": "Rio de Janeiro"
+                        },
+                        "state": {
+                          "type": "string",
+                          "description": "State of the shipping address.",
+                          "example": "RJ"
+                        },
+                        "country": {
+                          "type": "string",
+                          "description": "Three letter ISO code of the country of the shipping address.",
+                          "example": "BRA"
+                        },
+                        "street": {
+                          "type": "string",
+                          "description": "Street of the shipping address.",
+                          "example": "Praia de Botafogo"
+                        },
+                        "number": {
+                          "type": "string",
+                          "description": "Number of the building, house or apartment in the shipping address.",
+                          "example": "300"
+                        },
+                        "neighborhood": {
+                          "type": "string",
+                          "description": "Neighborhood of the shipping address.",
+                          "example": "Botafogo"
+                        },
+                        "complement": {
+                          "type": "string",
+                          "description": "Complement to the shipping address in case it applies.",
+                          "example": "3rd floor",
+                          "nullable": true
+                        },
+                        "reference": {
+                          "type": "string",
+                          "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                          "example": "Grey building"
+                        },
+                        "geoCoordinates": {
+                          "type": "array",
+                          "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
+                          "example": [
+                            -47.924747467041016,
+                            -15.832582473754883
+                          ],
+                          "items": {
+                            "type": "number",
+                            "example": -47.924747467041016,
+                            "description": "Geocoordinates."
+                          }
+                        }
+                      }
+                    }
+                  },
+                  "logisticsInfo": {
+                    "type": "array",
+                    "description": "Array with logistics information on each item of the `items` array in the `orderForm`.",
+                    "items": {
+                      "type": "object",
+                      "description": "Logistic information.",
+                      "properties": {
+                        "itemIndex": {
+                          "type": "integer",
+                          "description": "Index of item in items array.",
+                          "example": 0
+                        },
+                        "selectedDeliveryChannel": {
+                          "type": "string",
+                          "description": "Delivery channel selected by the customer. For example, `\"delivery\"` or `\"pickup-in-point\"`.",
+                          "example": "delivery",
+                          "nullable": true
+                        },
+                        "selectedSla": {
+                          "type": "string",
+                          "description": "Selected SLA. For example, `\"normal\"` or `\"express\"`.",
+                          "example": "normal",
+                          "nullable": true
+                        }
+                      }
+                    }
+                  }
+                }
+              },
+              "example": {
+                "clearAddressIfPostalCodeNotFound": false,
+                "selectedAddresses": [
+                  {
+                    "addressType": "residential",
+                    "receiverName": "Clark Kent",
+                    "addressId": "c3701fc4c61b4d1b91f67e81415db44d",
+                    "isDisposable": true,
+                    "postalCode": "12345000",
+                    "city": "Rio de Janeiro",
+                    "state": "ST",
+                    "country": "BRA",
+                    "street": "My street",
+                    "number": "1091",
+                    "neighborhood": "My neighborhood",
+                    "complement": null,
+                    "reference": null,
+                    "geoCoordinates": []
+                  }
+                ],
+                "logisticsInfo": [
+                  {
+                    "itemIndex": 0,
+                    "selectedSla": null,
+                    "selectedDeliveryChannel": null
+                  }
+                ]
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "orderFormId": {
+                      "type": "string",
+                      "description": "ID of the orderForm corresponding to a specific cart."
+                    },
+                    "salesChannel": {
+                      "type": "string",
+                      "description": "Attribute created by the seller, in their VTEX store configuration."
+                    },
+                    "loggedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether the user is logged into the store."
+                    },
+                    "isCheckedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether order is checked in."
+                    },
+                    "storeId": {
+                      "type": "string",
+                      "description": "ID of the store.",
+                      "nullable": true
+                    },
+                    "allowManualPrice": {
+                      "type": "boolean",
+                      "description": "Permission to modify item price manually."
+                    },
+                    "canEditData": {
+                      "type": "boolean",
+                      "description": "Data can be edited."
+                    },
+                    "userProfileId": {
+                      "type": "string",
+                      "description": "Unique ID associated with the customer profile."
+                    },
+                    "profileProvider": {
+                      "type": "string",
+                      "description": "Profile provider."
+                    },
+                    "availableAccounts": {
+                      "type": "array",
+                      "description": "Available accounts.",
+                      "items": {
+                        "type": "string",
+                        "description": "Account."
+                      }
+                    },
+                    "availableAddresses": {
+                      "type": "array",
+                      "description": "Information on each available address.",
+                      "items": {
+                        "description": "Address information.",
+                        "type": "object",
+                        "properties": {
+                          "addressType": {
+                            "type": "string",
+                            "description": "Address type."
+                          },
+                          "receiverName": {
+                            "type": "string",
+                            "description": "Name of the receiver."
+                          },
+                          "addressId": {
+                            "type": "string",
+                            "description": "Address ID.",
+                            "nullable": true
+                          },
+                          "isDisposable": {
+                            "type": "boolean",
+                            "description": "Indicates whether address is disposable."
+                          },
+                          "city": {
+                            "type": "string",
+                            "description": "City of the address."
+                          },
+                          "state": {
+                            "type": "string",
+                            "description": "State of the address."
+                          },
+                          "country": {
+                            "type": "string",
+                            "description": "Country of the address. ISO three-letter code."
+                          },
+                          "street": {
+                            "type": "string",
+                            "description": "Street of the address."
+                          },
+                          "number": {
+                            "type": "string",
+                            "description": "Number of the address."
+                          },
+                          "neighborhood": {
+                            "type": "string",
+                            "description": "Neighborhood of the address."
+                          },
+                          "complement": {
+                            "description": "Complement to the shipping address, in case it applies.",
+                            "type": "string",
+                            "nullable": true
+                          },
+                          "reference": {
+                            "type": "string",
+                            "description": "Reference that may help in the location of the address.",
+                            "nullable": true
+                          },
+                          "geoCoordinates": {
+                            "type": "array",
+                            "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                            "items": {
+                              "type": "number",
+                              "description": "Geocoordinates."
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "userType": {
+                      "type": "string",
+                      "description": "User type.",
+                      "nullable": true
+                    },
+                    "ignoreProfileData": {
+                      "type": "boolean",
+                      "description": "Ignore customer profile data."
+                    },
+                    "value": {
+                      "type": "integer",
+                      "description": "Total value of the order without separating cents. For example, $24.99 is represented as `2499`."
+                    },
+                    "messages": {
+                      "type": "array",
+                      "description": "Array containing an object for each message generated by our servers while processing the request.",
+                      "items": {
+                        "type": "string",
+                        "description": "Message."
+                      }
+                    },
+                    "items": {
+                      "type": "array",
+                      "description": "Information on each item in the order.",
+                      "items": {
+                        "description": "Item information.",
+                        "type": "object",
+                        "properties": {
+                          "uniqueId": {
+                            "type": "string",
+                            "description": "Unique ID."
+                          },
+                          "id": {
+                            "type": "string",
+                            "description": "ID of the item."
+                          },
+                          "productId": {
+                            "type": "string",
+                            "description": "Product ID."
+                          },
+                          "productRefId": {
+                            "type": "string",
+                            "description": "Product Ref ID."
+                          },
+                          "refId": {
+                            "type": "string",
+                            "description": "Ref ID."
+                          },
+                          "ean": {
+                            "type": "string",
+                            "description": "European Article Number.",
+                            "nullable": true
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Product name."
+                          },
+                          "skuName": {
+                            "type": "string",
+                            "description": "SKU name."
+                          },
+                          "modalType": {
+                            "type": "string",
+                            "description": "Modal type.",
+                            "nullable": true
+                          },
+                          "parentItemIndex": {
+                            "type": "integer",
+                            "description": "Parent item index.",
+                            "nullable": true
+                          },
+                          "parentAssemblyBinding": {
+                            "type": "string",
+                            "description": "Parent assembly binding.",
+                            "nullable": true
+                          },
+                          "priceValidUntil": {
+                            "type": "string",
+                            "description": "Price expiration date and time."
+                          },
+                          "tax": {
+                            "type": "integer",
+                            "description": "Tax value in cents."
+                          },
+                          "taxCode": {
+                            "type": "string",
+                            "description": "A unique identifier code assigned to a tax within the VTEX Admin."
+                          },
+                          "price": {
+                            "type": "integer",
+                            "description": "Price in cents."
+                          },
+                          "listPrice": {
+                            "type": "integer",
+                            "description": "List price in cents."
+                          },
+                          "manualPrice": {
+                            "type": "integer",
+                            "description": "Manual price in cents.",
+                            "nullable": true
+                          },
+                          "manualPriceAppliedBy": {
+                            "type": "string",
+                            "description": "User that applied the manual price, if that is the case.",
+                            "nullable": true
+                          },
+                          "sellingPrice": {
+                            "type": "integer",
+                            "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
+                          },
+                          "rewardValue": {
+                            "type": "integer",
+                            "description": "Reward value in cents."
+                          },
+                          "isGift": {
+                            "type": "boolean",
+                            "description": "Indicates whether item is a gift."
+                          },
+                          "additionalInfo": {
+                            "type": "object",
+                            "description": "Additional information.",
+                            "properties": {
+                              "dimension": {
+                                "type": "string",
+                                "description": "Dimension.",
+                                "nullable": true
+                              },
+                              "brandName": {
+                                "type": "string",
+                                "description": "Brand name."
+                              },
+                              "brandId": {
+                                "type": "string",
+                                "description": "Brand ID."
+                              },
+                              "offeringInfo": {
+                                "type": "string",
+                                "description": "Offering information.",
+                                "nullable": true
+                              },
+                              "offeringType": {
+                                "type": "string",
+                                "description": "Offering type.",
+                                "nullable": true
+                              },
+                              "offeringTypeId": {
+                                "type": "string",
+                                "description": "Offering type ID.",
+                                "nullable": true
+                              }
+                            }
+                          },
+                          "preSaleDate": {
+                            "type": "string",
+                            "description": "Presale date.",
+                            "nullable": true
+                          },
+                          "productCategoryIds": {
+                            "type": "string",
+                            "description": "Product category IDs."
+                          },
+                          "productCategories": {
+                            "type": "object",
+                            "description": "Object, where each field is an ID from `productCategoryIds`.",
+                            "properties": {
+                              "{ID}": {
+                                "type": "string",
+                                "description": "Product category corresponding to the ID in the field key."
+                              }
+                            }
+                          },
+                          "quantity": {
+                            "type": "integer",
+                            "description": "Quantity."
+                          },
+                          "seller": {
+                            "type": "string",
+                            "description": "Seller."
+                          },
+                          "sellerChain": {
+                            "type": "array",
+                            "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
+                            "items": {
+                              "type": "string",
+                              "description": "Seller."
+                            }
+                          },
+                          "imageUrl": {
+                            "type": "string",
+                            "description": "Image URL."
+                          },
+                          "detailUrl": {
+                            "type": "string",
+                            "description": "Detail URL."
+                          },
+                          "bundleItems": {
+                            "type": "array",
+                            "description": "Information on services sold along with the SKU. Example: a gift package.",
+                            "items": {
+                              "description": "Service information.",
+                              "type": "object",
+                              "properties": {
+                                "type": {
+                                  "type": "string",
+                                  "description": "Service type."
+                                },
+                                "id": {
+                                  "type": "integer",
+                                  "description": "Service identifier."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Service name."
+                                },
+                                "price": {
+                                  "type": "integer",
+                                  "description": "Service price in cents."
+                                }
+                              }
+                            }
+                          },
+                          "attachments": {
+                            "type": "array",
+                            "description": "Array containing information on attachments.",
+                            "items": {
+                              "type": "string",
+                              "description": "Attachment."
+                            }
+                          },
+                          "priceTags": {
+                            "type": "array",
+                            "description": "Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.",
+                            "items": {
+                              "description": "Price tag information.",
+                              "type": "object",
+                              "properties": {
+                                "identifier": {
+                                  "type": "string",
+                                  "description": "Promotion unique identifier.",
+                                  "nullable": true
+                                },
+                                "isPercentual": {
+                                  "type": "boolean",
+                                  "description": "Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\r\n- `type` indicates whether the tag refers to a discount or tax.\r\n- `where` specifies the context, either price or shipping.\r\n- `identifier` is the promotion ID.\r\n- `calculationId` is a hash that may vary with each price calculation."
+                                },
+                                "rawValue": {
+                                  "type": "number",
+                                  "description": "Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations."
+                                },
+                                "value": {
+                                  "type": "integer",
+                                  "description": "Price tag value representing either a promotion (value decrease) or a tax (value increase)."
+                                }
+                              }
+                            }
+                          },
+                          "availability": {
+                            "type": "string",
+                            "description": "Availability."
+                          },
+                          "measurementUnit": {
+                            "type": "string",
+                            "description": "Measurement unit."
+                          },
+                          "unitMultiplier": {
+                            "type": "integer",
+                            "description": "Unit multiplier."
+                          },
+                          "manufacturerCode": {
+                            "type": "string",
+                            "description": "Manufacturer code.",
+                            "nullable": true
+                          },
+                          "priceDefinition": {
+                            "type": "object",
+                            "description": "Price information for all units of a specific item.",
+                            "properties": {
+                              "calculatedSellingPrice": {
+                                "type": "integer",
+                                "description": "Item's calculated unitary selling price in cents."
+                              },
+                              "total": {
+                                "type": "integer",
+                                "description": "Total value for all units of the item in cents."
+                              },
+                              "sellingPrices": {
+                                "type": "array",
+                                "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
+                                "items": {
+                                  "description": "Rounding information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value in cents for that specific rounding."
+                                    },
+                                    "quantity": {
+                                      "type": "integer",
+                                      "description": "Rounding quantity, meaning how many items are rounded to this value."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "selectableGifts": {
+                      "type": "array",
+                      "description": "Array containing the data of the item selected as a gift.",
+                      "items": {
+                        "type": "string",
+                        "description": "Gift."
+                      }
+                    },
+                    "totalizers": {
+                      "type": "array",
+                      "description": "Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).",
+                      "items": {
+                        "type": "object",
+                        "description": "Totalizer of purchases."
+                      }
+                    },
+                    "shippingData": {
+                      "type": "object",
+                      "description": "Shipping information pertinent to the order.",
+                      "nullable": true,
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Address information.",
+                          "nullable": true,
+                          "properties": {
+                            "addressType": {
+                              "type": "string",
+                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                            },
+                            "receiverName": {
+                              "type": "string",
+                              "description": "Name of the person who is going to receive the order."
+                            },
+                            "addressId": {
+                              "type": "string",
+                              "description": "Address ID.",
+                              "nullable": true
+                            },
+                            "isDisposable": {
+                              "type": "boolean",
+                              "description": "Indicates whether address is disposable."
+                            },
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City of the shipping address."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State of the shipping address."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Three letter ISO code of the country of the shipping address."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street of the shipping address."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Number of the building, house or apartment in the shipping address."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood of the shipping address."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Complement to the shipping address, in case it applies.",
+                              "nullable": true
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                              "nullable": true
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                              "items": {
+                                "type": "number",
+                                "description": "Geocoordinates."
+                              }
+                            }
+                          }
+                        },
+                        "logisticsInfo": {
+                          "type": "array",
+                          "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.",
+                          "items": {
+                            "description": "Logistics information.",
+                            "type": "object",
+                            "properties": {
+                              "itemIndex": {
+                                "type": "integer",
+                                "description": "Index corresponding to the position of the object in the `items` array."
+                              },
+                              "selectedSla": {
+                                "type": "string",
+                                "description": "SLA selected by the customer.",
+                                "nullable": true
+                              },
+                              "selectedDeliveryChannel": {
+                                "type": "string",
+                                "description": "Delivery channel selected by the customer.",
+                                "nullable": true
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "slas": {
+                                "type": "array",
+                                "description": "Information on available SLAs.",
+                                "items": {
+                                  "description": "SLA information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "SLA ID."
+                                    },
+                                    "deliveryChannel": {
+                                      "type": "string",
+                                      "description": "Delivery channel."
+                                    },
+                                    "name": {
+                                      "type": "string",
+                                      "description": "SLA name."
+                                    },
+                                    "deliveryIds": {
+                                      "type": "array",
+                                      "description": "Information on each delivery ID.",
+                                      "items": {
+                                        "description": "Delivery ID information.",
+                                        "type": "object",
+                                        "properties": {
+                                          "courierId": {
+                                            "type": "string",
+                                            "description": "Courier ID."
+                                          },
+                                          "warehouseId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "dockId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "courierName": {
+                                            "type": "string",
+                                            "description": "Courier name."
+                                          },
+                                          "quantity": {
+                                            "type": "integer",
+                                            "description": "Quantity."
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "attachmentOfferings": {
+                                      "type": "array",
+                                      "description": "List of attachments details.",
+                                      "nullable": true,
+                                      "items": {
+                                        "description": "Attachment details.",
+                                        "type": "object",
+                                        "required": [
+                                          "name",
+                                          "required",
+                                          "schema"
+                                        ],
+                                        "properties": {
+                                          "name": {
+                                            "type": "string",
+                                            "description": "Name of the attachment.",
+                                            "nullable": true
+                                          },
+                                          "required": {
+                                            "type": "boolean",
+                                            "description": "Defines if the attachment is required (`true`) or not (`false`).",
+                                            "nullable": true
+                                          },
+                                          "schema": {
+                                            "type": "object",
+                                            "description": "Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).",
+                                            "nullable": true
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "shippingEstimate": {
+                                      "type": "string",
+                                      "description": "Shipping estimate. For instance, \"three business days\" will be represented as `3bd`."
+                                    },
+                                    "shippingEstimateDate": {
+                                      "type": "string",
+                                      "description": "When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.",
+                                      "nullable": true
+                                    },
+                                    "useIndividualShippingEstimates": {
+                                      "type": "boolean",
+                                      "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`."
+                                    },
+                                    "lockTTL": {
+                                      "type": "string",
+                                      "description": "Estimate date of delivery.",
+                                      "nullable": true
+                                    },
+                                    "price": {
+                                      "type": "integer",
+                                      "description": "Price in cents."
+                                    },
+                                    "listPrice": {
+                                      "type": "integer",
+                                      "description": "List price in cents."
+                                    },
+                                    "tax": {
+                                      "type": "integer",
+                                      "description": "Tax in cents."
+                                    },
+                                    "pickupStoreInfo": {
+                                      "type": "object",
+                                      "description": "Information on the pickup store.",
+                                      "properties": {
+                                        "isPickupStore": {
+                                          "type": "boolean",
+                                          "description": "Indicates whether it is the pickup store."
+                                        },
+                                        "friendlyName": {
+                                          "type": "string",
+                                          "description": "Friendly name.",
+                                          "nullable": true
+                                        },
+                                        "address": {
+                                          "type": "object",
+                                          "description": "Address information.",
+                                          "nullable": true,
+                                          "properties": {
+                                            "addressType": {
+                                              "type": "string",
+                                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                                            },
+                                            "postalCode": {
+                                              "type": "string",
+                                              "description": "Postal code."
+                                            },
+                                            "city": {
+                                              "type": "string",
+                                              "description": "City of the shipping address."
+                                            },
+                                            "state": {
+                                              "type": "string",
+                                              "description": "State of the shipping address."
+                                            },
+                                            "country": {
+                                              "type": "string",
+                                              "description": "Three letter ISO code of the country of the shipping address."
+                                            },
+                                            "street": {
+                                              "type": "string",
+                                              "description": "Street of the shipping address."
+                                            },
+                                            "number": {
+                                              "type": "string",
+                                              "description": "Number of the building, house or apartment in the shipping address."
+                                            },
+                                            "neighborhood": {
+                                              "type": "string",
+                                              "description": "Neighborhood of the shipping address."
+                                            },
+                                            "complement": {
+                                              "type": "string",
+                                              "description": "Complement to the shipping address, in case it applies.",
+                                              "nullable": true
+                                            },
+                                            "reference": {
+                                              "type": "string",
+                                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                              "nullable": true
+                                            },
+                                            "geoCoordinates": {
+                                              "type": "array",
+                                              "description": "Array with two strings that repesent geocoordinates: first latitude, then longitude.",
+                                              "items": {
+                                                "type": "number",
+                                                "description": "Geocoordinates."
+                                              }
+                                            }
+                                          }
+                                        },
+                                        "additionalInfo": {
+                                          "type": "string",
+                                          "description": "Additional information.",
+                                          "nullable": true
+                                        },
+                                        "dockId": {
+                                          "type": "string",
+                                          "description": "Corresponding dock ID.",
+                                          "nullable": true
+                                        }
+                                      }
+                                    },
+                                    "pickupPointId": {
+                                      "type": "string",
+                                      "description": "Pickup point ID.",
+                                      "nullable": true
+                                    },
+                                    "pickupDistance": {
+                                      "type": "integer",
+                                      "description": "Pickup point distance."
+                                    },
+                                    "polygonName": {
+                                      "type": "string",
+                                      "description": "Polygon name.",
+                                      "nullable": true
+                                    },
+                                    "transitTime": {
+                                      "type": "string",
+                                      "description": "Transit time. For instance, \"three business days\" is represented as `3bd`."
+                                    }
+                                  }
+                                }
+                              },
+                              "shipsTo": {
+                                "type": "array",
+                                "description": "List of countries that the item may be shipped to.",
+                                "items": {
+                                  "type": "string",
+                                  "description": "Three letter country code."
+                                }
+                              },
+                              "itemId": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "deliveryChannels": {
+                                "type": "array",
+                                "description": "List of available delivery channels.",
+                                "items": {
+                                  "description": "Delivery channel information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "Delivery channel ID."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "selectedAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the selected addresses for the order.",
+                          "items": {
+                            "description": "Selected address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "availableAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the available addresses for the order.",
+                          "items": {
+                            "description": "Available address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "clientProfileData": {
+                      "type": "object",
+                      "description": "Customer's profile information.",
+                      "nullable": true,
+                      "properties": {
+                        "email": {
+                          "type": "string",
+                          "description": "Email address.",
+                          "nullable": true
+                        },
+                        "firstName": {
+                          "type": "string",
+                          "description": "First name.",
+                          "nullable": true
+                        },
+                        "lastName": {
+                          "type": "string",
+                          "description": "Last name."
+                        },
+                        "documentType": {
+                          "type": "string",
+                          "description": "Type of the document informed by the customer."
+                        },
+                        "document": {
+                          "type": "string",
+                          "description": "Document informed by the customer."
+                        },
+                        "phone": {
+                          "type": "string",
+                          "description": "Phone number."
+                        },
+                        "corporateName": {
+                          "type": "string",
+                          "description": "Company name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "tradeName": {
+                          "type": "string",
+                          "description": "Trade name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporateDocument": {
+                          "type": "string",
+                          "description": "Corporate document, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "stateInscription": {
+                          "type": "string",
+                          "description": "State inscription, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporatePhone": {
+                          "type": "string",
+                          "description": "Corporate phone number, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "isCorporate": {
+                          "type": "boolean",
+                          "description": "Indicates whether the customer is a legal entity."
+                        },
+                        "profileCompleteOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile is complete on loading."
+                        },
+                        "profileErrorOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile presents error on loading.",
+                          "nullable": true
+                        },
+                        "customerClass": {
+                          "type": "string",
+                          "description": "Customer class.",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "paymentData": {
+                      "type": "object",
+                      "description": "Information on the order's payment.",
+                      "properties": {
+                        "giftCards": {
+                          "type": "array",
+                          "description": "Gift card information, if it applies to the order.",
+                          "items": {
+                            "description": "Gift card information.",
+                            "type": "object",
+                            "properties": {
+                              "redemptionCode": {
+                                "type": "string",
+                                "description": "Gift card redemption code."
+                              },
+                              "value": {
+                                "type": "integer",
+                                "description": "Gift card value in cents."
+                              },
+                              "balance": {
+                                "type": "integer",
+                                "description": "Gift card balance in cents."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Gift card name."
+                              },
+                              "id": {
+                                "type": "string",
+                                "description": "Gift card ID."
+                              },
+                              "inUse": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is in use."
+                              },
+                              "isSpecialCard": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is special."
+                              }
+                            }
+                          }
+                        },
+                        "transactions": {
+                          "type": "array",
+                          "description": "Information on each transaction pertinent to the order.",
+                          "items": {
+                            "description": "Transaction information.",
+                            "nullable": true,
+                            "type": "object",
+                            "properties": {
+                              "isActive": {
+                                "type": "boolean",
+                                "description": "Indicates whether transaction is active."
+                              },
+                              "transactionId": {
+                                "type": "string",
+                                "description": "Transaction ID."
+                              },
+                              "merchantName": {
+                                "type": "string",
+                                "description": "Merchant name."
+                              },
+                              "payments": {
+                                "type": "array",
+                                "description": "Information on each payment.",
+                                "items": {
+                                  "description": "Payment information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "accountId": {
+                                      "type": "string",
+                                      "description": "Account ID."
+                                    },
+                                    "bin": {
+                                      "type": "string",
+                                      "description": "Bin.",
+                                      "nullable": true
+                                    },
+                                    "installments": {
+                                      "type": "integer",
+                                      "description": "Number of installments."
+                                    },
+                                    "paymentSystem": {
+                                      "type": "string",
+                                      "description": "Payment system."
+                                    },
+                                    "referenceValue": {
+                                      "type": "integer",
+                                      "description": "Reference value for calculating interest rates, in case it applies. Displayed in cents."
+                                    },
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value including interest, in case it applies. Displayed in cents."
+                                    }
+                                  }
+                                }
+                              },
+                              "sharedTransaction": {
+                                "type": "boolean",
+                                "description": "Indicates whather transaction is shared."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "marketingData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Object containing promotion data such as coupon tracking information and internal or external UTMs.",
+                      "properties": {
+                        "coupon": {
+                          "type": "string",
+                          "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.",
+                          "example": "free-shipping"
+                        },
+                        "utmSource": {
+                          "type": "string",
+                          "description": "UTM source.",
+                          "example": "Facebook"
+                        },
+                        "utmMedium": {
+                          "type": "string",
+                          "description": "UTM medium.",
+                          "example": "CPC"
+                        },
+                        "utmCampaign": {
+                          "type": "string",
+                          "description": "UTM campaign.",
+                          "example": "Black friday"
+                        },
+                        "utmiPage": {
+                          "type": "string",
+                          "description": "utmi_page (internal utm).",
+                          "example": "utmi_page-example",
+                          "nullable": true
+                        },
+                        "utmiPart": {
+                          "type": "string",
+                          "description": "utmi_part (internal utm).",
+                          "example": "utmi_part-example",
+                          "nullable": true
+                        },
+                        "utmiCampaign": {
+                          "type": "string",
+                          "description": "utmi_campaign (internal utm).",
+                          "example": "utmi_campaign-example",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "sellers": {
+                      "type": "array",
+                      "description": "Information on each seller.",
+                      "items": {
+                        "description": "Seller information.",
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "Seller ID."
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Seller name."
+                          },
+                          "logo": {
+                            "type": "string",
+                            "description": "Seller logo.",
+                            "nullable": true
+                          }
+                        }
+                      }
+                    },
+                    "clientPreferencesData": {
+                      "type": "object",
+                      "description": "Object containing preferences from the client who placed the order.",
+                      "properties": {
+                        "locale": {
+                          "type": "string",
+                          "description": "Client's locale. Examples: `pt-BR` and `en-US`."
+                        },
+                        "optinNewsLetter": {
+                          "type": "boolean",
+                          "description": "`true` if the client opted to receive newsletter from the store.",
+                          "example": false,
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "commercialConditionData": {
+                      "type": "object",
+                      "description": "Object containing commercial condition information.",
+                      "nullable": true
+                    },
+                    "storePreferencesData": {
+                      "type": "object",
+                      "description": "Object containing data from the store's configuration (stored in VTEX's License Manager)."
+                    },
+                    "giftRegistryData": {
+                      "type": "object",
+                      "description": "Gift registry list information.",
+                      "nullable": true
+                    },
+                    "openTextField": {
+                      "type": "string",
+                      "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).",
+                      "example": "open-text-example",
+                      "nullable": true
+                    },
+                    "invoiceData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Invoice data including billing address.",
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Billing address.",
+                          "properties": {
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City name."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State name."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Country."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street name."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Street number."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Address complement."
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Reference for location."
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Geographic coordinates (latitude, longitude).",
+                              "items": {
+                                "type": "number"
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "customData": {
+                      "type": "object",
+                      "description": "Customer additional information.",
+                      "nullable": true
+                    },
+                    "itemMetadata": {
+                      "type": "object",
+                      "description": "Item metadata.",
+                      "properties": {
+                        "items": {
+                          "type": "array",
+                          "description": "List of objects containing metadata on each item in the order.",
+                          "items": {
+                            "description": "Item metadata.",
+                            "type": "object",
+                            "properties": {
+                              "id": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "seller": {
+                                "type": "string",
+                                "description": "Seller."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Product name."
+                              },
+                              "skuName": {
+                                "type": "string",
+                                "description": "SKU name."
+                              },
+                              "productId": {
+                                "type": "string",
+                                "description": "Product ID."
+                              },
+                              "refId": {
+                                "type": "string",
+                                "description": "Ref ID."
+                              },
+                              "ean": {
+                                "type": "string",
+                                "description": "European Article Number.",
+                                "nullable": true
+                              },
+                              "imageUrl": {
+                                "type": "string",
+                                "description": "Image URL."
+                              },
+                              "detailUrl": {
+                                "type": "string",
+                                "description": "Detail URL."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "hooksData": {
+                      "type": "object",
+                      "description": "Hooks information.",
+                      "nullable": true
+                    },
+                    "ratesAndBenefitsData": {
+                      "type": "object",
+                      "description": "Information on rates and benefits that apply to the order.",
+                      "properties": {
+                        "rateAndBenefitsIdentifiers": {
+                          "type": "array",
+                          "description": "List with rates and benefits identifiers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit identifier."
+                          }
+                        },
+                        "teaser": {
+                          "type": "array",
+                          "description": "List with rates and benefits teasers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit teaser."
+                          }
+                        }
+                      }
+                    },
+                    "subscriptionData": {
+                      "type": "object",
+                      "description": "Subscription information.",
+                      "nullable": true
+                    },
+                    "itemsOrdination": {
+                      "type": "object",
+                      "description": "Object containing information about the ordering of items within the `orderForm`.",
+                      "properties": {
+                        "criteria": {
+                          "type": "string",
+                          "description": "Criteria adopted to order the items in the list."
+                        },
+                        "ascending": {
+                          "type": "boolean",
+                          "description": "Indicates whether the ordering is ascending."
+                        }
+                      }
+                    }
+                  }
+                },
+                "example": {
+                  "orderFormId": "2f586e50342a4f87b7e0654c56299e88",
+                  "salesChannel": "1",
+                  "loggedIn": false,
+                  "isCheckedIn": false,
+                  "storeId": "1",
+                  "checkedInPickupPointId": "21",
+                  "allowManualPrice": false,
+                  "canEditData": true,
+                  "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
+                  "userType": "User type",
+                  "ignoreProfileData": false,
+                  "value": 0,
+                  "messages": [],
+                  "items": [],
+                  "selectableGifts": [],
+                  "totalizers": [],
+                  "shippingData": {
+                    "address": {
+                      "addressType": "residential",
+                      "receiverName": "Clark Kent",
+                      "addressId": "c3701fc4c61b4d1b91f67e81415db44d",
+                      "isDisposable": true,
+                      "postalCode": "12345000",
+                      "city": "Rio de Janeiro",
+                      "state": "ST",
+                      "country": "BRA",
+                      "street": "My street",
+                      "number": "1091",
+                      "neighborhood": "My neighborhood",
+                      "complement": null,
+                      "reference": null,
+                      "geoCoordinates": []
+                    },
+                    "logisticsInfo": [
+                      {
+                        "itemIndex": 0,
+                        "selectedSla": "Normal",
+                        "selectedDeliveryChannel": "delivery",
+                        "addressId": "f239ad30f8c948a382543ab2c739b967",
+                        "slas": [
+                          {
+                            "id": "Retirada (VTEXSP)",
+                            "deliveryChannel": "pickup-in-point",
+                            "name": "Retirada (VTEXSP)",
+                            "deliveryIds": [
+                              {
+                                "courierId": "1ee17c2",
+                                "warehouseId": "1_1",
+                                "dockId": "1",
+                                "courierName": "Retira em Loja",
+                                "quantity": 2,
+                                "kitItemDetails": []
+                              }
+                            ],
+                            "shippingEstimate": "3bd",
+                            "shippingEstimateDate": null,
+                            "lockTTL": null,
+                            "availableDeliveryWindows": {
+                              "startDateUtc": "2024-03-27T00:00:00+00:00",
+                              "endDateUtc": "2024-03-27T00:00:00+00:00",
+                              "price": 0,
+                              "lisPrice": 0,
+                              "tax": 0
+                            },
+                            "deliveryWindow": {
+                              "startDateUtc": "2014-04-21T09:00:00+00:00",
+                              "endDateUtc": "2014-04-21T12:00:00+00:00",
+                              "price": 0,
+                              "listprice": 1000,
+                              "tax": 0
+                            },
+                            "price": 250,
+                            "listPrice": 250,
+                            "tax": 0,
+                            "pickupStoreInfo": {
+                              "isPickupStore": true,
+                              "friendlyName": "VTEX SP",
+                              "address": {
+                                "addressType": "pickup",
+                                "receiverName": "Clark Kent",
+                                "addressId": "VTEXSP",
+                                "isDisposable": true,
+                                "postalCode": "04538-132",
+                                "city": "São Paulo",
+                                "state": "SP",
+                                "country": "BRA",
+                                "street": "Avenida Brigadeiro Faria Lima",
+                                "number": "4440",
+                                "neighborhood": "Itaim Bibi",
+                                "complement": "Apto 101",
+                                "reference": null,
+                                "geoCoordinates": [
+                                  -47.924747467041016,
+                                  -15.832582473754883
+                                ]
+                              },
+                              "additionalInfo": "Additional info",
+                              "dockId": "1"
+                            },
+                            "pickupPointId": "1_VTEXSP",
+                            "pickupDistance": 15,
+                            "polygonName": null,
+                            "transitTime": "3bd"
+                          }
+                        ],
+                        "shipsTo": [
+                          "BRA",
+                          "COL",
+                          "USA"
+                        ],
+                        "itemId": "2",
+                        "deliveryChannels": [
+                          {
+                            "id": "pickup-in-point"
+                          },
+                          {
+                            "id": "delivery"
+                          }
+                        ]
+                      }
+                    ],
+                    "selectedAddresses": [
+                      {
+                        "addressType": "residential",
+                        "receiverName": "Clark Kent",
+                        "addressId": "c3701fc4c61b4d1b91f67e81415db44d",
+                        "isDisposable": true,
+                        "postalCode": "12345000",
+                        "city": "Rio de Janeiro",
+                        "state": "ST",
+                        "country": "BRA",
+                        "street": "My street",
+                        "number": "1091",
+                        "neighborhood": "My neighborhood",
+                        "complement": null,
+                        "reference": null,
+                        "geoCoordinates": []
+                      }
+                    ],
+                    "availableAddresses": [
+                      {
+                        "addressType": "residential",
+                        "receiverName": "Clark Kent",
+                        "addressId": "ae3173b32bf64663a81fc42b057be211",
+                        "isDisposable": true,
+                        "postalCode": "70386060",
+                        "city": "Brasília",
+                        "state": "DF",
+                        "country": "BRA",
+                        "street": "Quadra SQS 116 Bloco F",
+                        "number": "101",
+                        "neighborhood": "Asa Sul",
+                        "complement": null,
+                        "reference": null,
+                        "geoCoordinates": [
+                          -47.92592239379883,
+                          -15.832707405090332
+                        ]
+                      },
+                      {
+                        "addressType": "residential",
+                        "receiverName": "Clark Kent",
+                        "addressId": "449dcbe11c5844098fb4545a49cf6e07",
+                        "isDisposable": true,
+                        "postalCode": "00076555",
+                        "city": "Brasília",
+                        "state": "DF",
+                        "country": "BRA",
+                        "street": "My street",
+                        "number": "101",
+                        "neighborhood": "Asa sul",
+                        "complement": null,
+                        "reference": null,
+                        "geoCoordinates": []
+                      },
+                      {
+                        "addressType": "residential",
+                        "receiverName": "Clark Kent",
+                        "addressId": "c3701fc4c61b4d1b91f67e81415db44d",
+                        "isDisposable": true,
+                        "postalCode": "12345000",
+                        "city": "Rio de Janeiro",
+                        "state": "ST",
+                        "country": "BRA",
+                        "street": "My street",
+                        "number": "1091",
+                        "neighborhood": "My neighborhood",
+                        "complement": null,
+                        "reference": null,
+                        "geoCoordinates": []
+                      }
+                    ],
+                    "pickupPoints": []
+                  },
+                  "clientProfileData": {
+                    "email": "clark.kent@example.com",
+                    "firstName": "Clark",
+                    "lastName": "Kent",
+                    "document": "12345678900",
+                    "documentType": "cpf",
+                    "phone": "+5521998765432",
+                    "corporateName": "company-name",
+                    "tradeName": "trade-name",
+                    "corporateDocument": "12345678000100",
+                    "stateInscription": "12345678",
+                    "corporatePhone": "551100988887777",
+                    "isCorporate": false,
+                    "profileCompleteOnLoading": false,
+                    "profileErrorOnLoading": false,
+                    "customerClass": null
+                  },
+                  "paymentData": {
+                    "updateStatus": "updated",
+                    "installmentOptions": [],
+                    "paymentSystems": [],
+                    "payments": [
+                      {
+                        "paymentSystem": 6,
+                        "bin": null,
+                        "accountId": "12",
+                        "tokenId": null,
+                        "value": 34390,
+                        "referenceValue": 34390,
+                        "giftCardRedemptionCode": null,
+                        "giftCardProvider": null,
+                        "giftCardId": null
+                      }
+                    ],
+                    "giftCards": [],
+                    "giftCardMessages": [],
+                    "availableAccounts": [],
+                    "availableTokens": []
+                  },
+                  "marketingData": null,
+                  "sellers": [],
+                  "clientPreferencesData": {
+                    "locale": "pt-BR",
+                    "optinNewsLetter": false
+                  },
+                  "commercialConditionData": null,
+                  "storePreferencesData": {
+                    "countryCode": "BRA",
+                    "saveUserData": true,
+                    "timeZone": "E. South America Standard Time",
+                    "currencyCode": "BRL",
+                    "currencyLocale": 1046,
+                    "currencySymbol": "R$",
+                    "currencyFormatInfo": {
+                      "currencyDecimalDigits": 2,
+                      "currencyDecimalSeparator": ",",
+                      "currencyGroupSeparator": ".",
+                      "currencyGroupSize": 3,
+                      "startsWithCurrencySymbol": true
+                    }
+                  },
+                  "giftRegistryData": null,
+                  "openTextField": null,
+                  "invoiceData": null,
+                  "customData": null,
+                  "itemMetadata": {
+                    "items": [
+                      {
+                        "id": "1",
+                        "seller": "1",
+                        "name": "Ração Royal Canin Feline Urinary 500g",
+                        "skuName": "Ração Royal Canin Feline Urinary 500g",
+                        "productId": "1",
+                        "refId": "0001",
+                        "ean": "123456789",
+                        "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
+                        "detailUrl": "/racao-royal-canin-feline-urinary/p",
+                        "assemblyOptions": []
+                      }
+                    ]
+                  },
+                  "hooksData": null,
+                  "ratesAndBenefitsData": {
+                    "rateAndBenefitsIdentifiers": [],
+                    "teaser": []
+                  },
+                  "subscriptionData": null,
+                  "itemsOrdination": {
+                    "criteria": "NAME",
+                    "ascending": true
+                  }
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/api/checkout/pub/orderForm/{orderFormId}/attachments/clientPreferencesData": {
+      "post": {
+        "tags": [
+          "Cart attachments"
+        ],
+        "summary": "Add client preferences",
+        "description": "Use this request to include client preferences information to a given shopping cart.\r\n\r\nThe [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.\n\r\n\r> This request has a time out of 12 seconds.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "AddClientPreferences",
+        "security": [],
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "orderFormId",
+            "in": "path",
+            "description": "ID of the orderForm that will receive client profile information.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "ede846222cd44046ba6c638442c3505a"
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "locale": {
+                    "type": "string",
+                    "description": "Locale chosen by the shopper. Determines website language.",
+                    "example": "EN"
+                  },
+                  "optinNewsLetter": {
+                    "type": "boolean",
+                    "description": "Indicates whether the shopper opted in to receive the store's news letter.",
+                    "example": false,
+                    "nullable": true
+                  }
+                }
+              },
+              "example": {
+                "locale": "pt-BR",
+                "optinNewsLetter": false
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "orderFormId": {
+                      "type": "string",
+                      "description": "ID of the orderForm corresponding to a specific cart."
+                    },
+                    "salesChannel": {
+                      "type": "string",
+                      "description": "Attribute created by the seller, in their VTEX store configuration."
+                    },
+                    "loggedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether the user is logged into the store."
+                    },
+                    "isCheckedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether order is checked in."
+                    },
+                    "storeId": {
+                      "type": "string",
+                      "description": "ID of the store.",
+                      "nullable": true
+                    },
+                    "allowManualPrice": {
+                      "type": "boolean",
+                      "description": "Permission to modify item price manually."
+                    },
+                    "canEditData": {
+                      "type": "boolean",
+                      "description": "Data can be edited."
+                    },
+                    "userProfileId": {
+                      "type": "string",
+                      "description": "Unique ID associated with the customer profile."
+                    },
+                    "profileProvider": {
+                      "type": "string",
+                      "description": "Profile provider."
+                    },
+                    "availableAccounts": {
+                      "type": "array",
+                      "description": "Available accounts.",
+                      "items": {
+                        "type": "string",
+                        "description": "Account."
+                      }
+                    },
+                    "availableAddresses": {
+                      "type": "array",
+                      "description": "Information on each available address.",
+                      "items": {
+                        "description": "Address information.",
+                        "type": "object",
+                        "properties": {
+                          "addressType": {
+                            "type": "string",
+                            "description": "Address type."
+                          },
+                          "receiverName": {
+                            "type": "string",
+                            "description": "Name of the receiver."
+                          },
+                          "addressId": {
+                            "type": "string",
+                            "description": "Address ID.",
+                            "nullable": true
+                          },
+                          "isDisposable": {
+                            "type": "boolean",
+                            "description": "Indicates whether address is disposable."
+                          },
+                          "city": {
+                            "type": "string",
+                            "description": "City of the address."
+                          },
+                          "state": {
+                            "type": "string",
+                            "description": "State of the address."
+                          },
+                          "country": {
+                            "type": "string",
+                            "description": "Country of the address. ISO three-letter code."
+                          },
+                          "street": {
+                            "type": "string",
+                            "description": "Street of the address."
+                          },
+                          "number": {
+                            "type": "string",
+                            "description": "Number of the address."
+                          },
+                          "neighborhood": {
+                            "type": "string",
+                            "description": "Neighborhood of the address."
+                          },
+                          "complement": {
+                            "description": "Complement to the shipping address, in case it applies.",
+                            "type": "string",
+                            "nullable": true
+                          },
+                          "reference": {
+                            "type": "string",
+                            "description": "Reference that may help in the location of the address.",
+                            "nullable": true
+                          },
+                          "geoCoordinates": {
+                            "type": "array",
+                            "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                            "items": {
+                              "type": "number",
+                              "description": "Geocoordinates."
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "userType": {
+                      "type": "string",
+                      "description": "User type.",
+                      "nullable": true
+                    },
+                    "ignoreProfileData": {
+                      "type": "boolean",
+                      "description": "Ignore customer profile data."
+                    },
+                    "value": {
+                      "type": "integer",
+                      "description": "Total value of the order without separating cents. For example, $24.99 is represented as `2499`."
+                    },
+                    "messages": {
+                      "type": "array",
+                      "description": "Array containing an object for each message generated by our servers while processing the request.",
+                      "items": {
+                        "type": "string",
+                        "description": "Message."
+                      }
+                    },
+                    "items": {
+                      "type": "array",
+                      "description": "Information on each item in the order.",
+                      "items": {
+                        "description": "Item information.",
+                        "type": "object",
+                        "properties": {
+                          "uniqueId": {
+                            "type": "string",
+                            "description": "Unique ID."
+                          },
+                          "id": {
+                            "type": "string",
+                            "description": "ID of the item."
+                          },
+                          "productId": {
+                            "type": "string",
+                            "description": "Product ID."
+                          },
+                          "productRefId": {
+                            "type": "string",
+                            "description": "Product Ref ID."
+                          },
+                          "refId": {
+                            "type": "string",
+                            "description": "Ref ID."
+                          },
+                          "ean": {
+                            "type": "string",
+                            "description": "European Article Number.",
+                            "nullable": true
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Product name."
+                          },
+                          "skuName": {
+                            "type": "string",
+                            "description": "SKU name."
+                          },
+                          "modalType": {
+                            "type": "string",
+                            "description": "Modal type.",
+                            "nullable": true
+                          },
+                          "parentItemIndex": {
+                            "type": "integer",
+                            "description": "Parent item index.",
+                            "nullable": true
+                          },
+                          "parentAssemblyBinding": {
+                            "type": "string",
+                            "description": "Parent assembly binding.",
+                            "nullable": true
+                          },
+                          "priceValidUntil": {
+                            "type": "string",
+                            "description": "Price expiration date and time."
+                          },
+                          "tax": {
+                            "type": "integer",
+                            "description": "Tax value in cents."
+                          },
+                          "taxCode": {
+                            "type": "string",
+                            "description": "A unique identifier code assigned to a tax within the VTEX Admin."
+                          },
+                          "price": {
+                            "type": "integer",
+                            "description": "Price in cents."
+                          },
+                          "listPrice": {
+                            "type": "integer",
+                            "description": "List price in cents."
+                          },
+                          "manualPrice": {
+                            "type": "integer",
+                            "description": "Manual price in cents.",
+                            "nullable": true
+                          },
+                          "manualPriceAppliedBy": {
+                            "type": "string",
+                            "description": "User that applied the manual price, if that is the case.",
+                            "nullable": true
+                          },
+                          "sellingPrice": {
+                            "type": "integer",
+                            "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
+                          },
+                          "rewardValue": {
+                            "type": "integer",
+                            "description": "Reward value in cents."
+                          },
+                          "isGift": {
+                            "type": "boolean",
+                            "description": "Indicates whether item is a gift."
+                          },
+                          "additionalInfo": {
+                            "type": "object",
+                            "description": "Additional information.",
+                            "properties": {
+                              "dimension": {
+                                "type": "string",
+                                "description": "Dimension.",
+                                "nullable": true
+                              },
+                              "brandName": {
+                                "type": "string",
+                                "description": "Brand name."
+                              },
+                              "brandId": {
+                                "type": "string",
+                                "description": "Brand ID."
+                              },
+                              "offeringInfo": {
+                                "type": "string",
+                                "description": "Offering information.",
+                                "nullable": true
+                              },
+                              "offeringType": {
+                                "type": "string",
+                                "description": "Offering type.",
+                                "nullable": true
+                              },
+                              "offeringTypeId": {
+                                "type": "string",
+                                "description": "Offering type ID.",
+                                "nullable": true
+                              }
+                            }
+                          },
+                          "preSaleDate": {
+                            "type": "string",
+                            "description": "Presale date.",
+                            "nullable": true
+                          },
+                          "productCategoryIds": {
+                            "type": "string",
+                            "description": "Product category IDs."
+                          },
+                          "productCategories": {
+                            "type": "object",
+                            "description": "Object, where each field is an ID from `productCategoryIds`.",
+                            "properties": {
+                              "{ID}": {
+                                "type": "string",
+                                "description": "Product category corresponding to the ID in the field key."
+                              }
+                            }
+                          },
+                          "quantity": {
+                            "type": "integer",
+                            "description": "Quantity."
+                          },
+                          "seller": {
+                            "type": "string",
+                            "description": "Seller."
+                          },
+                          "sellerChain": {
+                            "type": "array",
+                            "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
+                            "items": {
+                              "type": "string",
+                              "description": "Seller."
+                            }
+                          },
+                          "imageUrl": {
+                            "type": "string",
+                            "description": "Image URL."
+                          },
+                          "detailUrl": {
+                            "type": "string",
+                            "description": "Detail URL."
+                          },
+                          "bundleItems": {
+                            "type": "array",
+                            "description": "Information on services sold along with the SKU. Example: a gift package.",
+                            "items": {
+                              "description": "Service information.",
+                              "type": "object",
+                              "properties": {
+                                "type": {
+                                  "type": "string",
+                                  "description": "Service type."
+                                },
+                                "id": {
+                                  "type": "integer",
+                                  "description": "Service identifier."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Service name."
+                                },
+                                "price": {
+                                  "type": "integer",
+                                  "description": "Service price in cents."
+                                }
+                              }
+                            }
+                          },
+                          "attachments": {
+                            "type": "array",
+                            "description": "Array containing information on attachments.",
+                            "items": {
+                              "type": "string",
+                              "description": "Attachment."
+                            }
+                          },
+                          "priceTags": {
+                            "type": "array",
+                            "description": "Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.",
+                            "items": {
+                              "description": "Price tag information.",
+                              "type": "object",
+                              "properties": {
+                                "identifier": {
+                                  "type": "string",
+                                  "description": "Promotion unique identifier.",
+                                  "nullable": true
+                                },
+                                "isPercentual": {
+                                  "type": "boolean",
+                                  "description": "Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\r\n- `type` indicates whether the tag refers to a discount or tax.\r\n- `where` specifies the context, either price or shipping.\r\n- `identifier` is the promotion ID.\r\n- `calculationId` is a hash that may vary with each price calculation."
+                                },
+                                "rawValue": {
+                                  "type": "number",
+                                  "description": "Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations."
+                                },
+                                "value": {
+                                  "type": "integer",
+                                  "description": "Price tag value representing either a promotion (value decrease) or a tax (value increase)."
+                                }
+                              }
+                            }
+                          },
+                          "availability": {
+                            "type": "string",
+                            "description": "Availability."
+                          },
+                          "measurementUnit": {
+                            "type": "string",
+                            "description": "Measurement unit."
+                          },
+                          "unitMultiplier": {
+                            "type": "integer",
+                            "description": "Unit multiplier."
+                          },
+                          "manufacturerCode": {
+                            "type": "string",
+                            "description": "Manufacturer code.",
+                            "nullable": true
+                          },
+                          "priceDefinition": {
+                            "type": "object",
+                            "description": "Price information for all units of a specific item.",
+                            "properties": {
+                              "calculatedSellingPrice": {
+                                "type": "integer",
+                                "description": "Item's calculated unitary selling price in cents."
+                              },
+                              "total": {
+                                "type": "integer",
+                                "description": "Total value for all units of the item in cents."
+                              },
+                              "sellingPrices": {
+                                "type": "array",
+                                "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
+                                "items": {
+                                  "description": "Rounding information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value in cents for that specific rounding."
+                                    },
+                                    "quantity": {
+                                      "type": "integer",
+                                      "description": "Rounding quantity, meaning how many items are rounded to this value."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "selectableGifts": {
+                      "type": "array",
+                      "description": "Array containing the data of the item selected as a gift.",
+                      "items": {
+                        "type": "string",
+                        "description": "Gift."
+                      }
+                    },
+                    "totalizers": {
+                      "type": "array",
+                      "description": "Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).",
+                      "items": {
+                        "type": "object",
+                        "description": "Totalizer of purchases."
+                      }
+                    },
+                    "shippingData": {
+                      "type": "object",
+                      "description": "Shipping information pertinent to the order.",
+                      "nullable": true,
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Address information.",
+                          "nullable": true,
+                          "properties": {
+                            "addressType": {
+                              "type": "string",
+                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                            },
+                            "receiverName": {
+                              "type": "string",
+                              "description": "Name of the person who is going to receive the order."
+                            },
+                            "addressId": {
+                              "type": "string",
+                              "description": "Address ID.",
+                              "nullable": true
+                            },
+                            "isDisposable": {
+                              "type": "boolean",
+                              "description": "Indicates whether address is disposable."
+                            },
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City of the shipping address."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State of the shipping address."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Three letter ISO code of the country of the shipping address."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street of the shipping address."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Number of the building, house or apartment in the shipping address."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood of the shipping address."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Complement to the shipping address, in case it applies.",
+                              "nullable": true
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                              "nullable": true
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                              "items": {
+                                "type": "number",
+                                "description": "Geocoordinates."
+                              }
+                            }
+                          }
+                        },
+                        "logisticsInfo": {
+                          "type": "array",
+                          "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.",
+                          "items": {
+                            "description": "Logistics information.",
+                            "type": "object",
+                            "properties": {
+                              "itemIndex": {
+                                "type": "integer",
+                                "description": "Index corresponding to the position of the object in the `items` array."
+                              },
+                              "selectedSla": {
+                                "type": "string",
+                                "description": "SLA selected by the customer.",
+                                "nullable": true
+                              },
+                              "selectedDeliveryChannel": {
+                                "type": "string",
+                                "description": "Delivery channel selected by the customer.",
+                                "nullable": true
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "slas": {
+                                "type": "array",
+                                "description": "Information on available SLAs.",
+                                "items": {
+                                  "description": "SLA information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "SLA ID."
+                                    },
+                                    "deliveryChannel": {
+                                      "type": "string",
+                                      "description": "Delivery channel."
+                                    },
+                                    "name": {
+                                      "type": "string",
+                                      "description": "SLA name."
+                                    },
+                                    "deliveryIds": {
+                                      "type": "array",
+                                      "description": "Information on each delivery ID.",
+                                      "items": {
+                                        "description": "Delivery ID information.",
+                                        "type": "object",
+                                        "properties": {
+                                          "courierId": {
+                                            "type": "string",
+                                            "description": "Courier ID."
+                                          },
+                                          "warehouseId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "dockId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "courierName": {
+                                            "type": "string",
+                                            "description": "Courier name."
+                                          },
+                                          "quantity": {
+                                            "type": "integer",
+                                            "description": "Quantity."
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "attachmentOfferings": {
+                                      "type": "array",
+                                      "description": "List of attachments details.",
+                                      "nullable": true,
+                                      "items": {
+                                        "description": "Attachment details.",
+                                        "type": "object",
+                                        "required": [
+                                          "name",
+                                          "required",
+                                          "schema"
+                                        ],
+                                        "properties": {
+                                          "name": {
+                                            "type": "string",
+                                            "description": "Name of the attachment.",
+                                            "nullable": true
+                                          },
+                                          "required": {
+                                            "type": "boolean",
+                                            "description": "Defines if the attachment is required (`true`) or not (`false`).",
+                                            "nullable": true
+                                          },
+                                          "schema": {
+                                            "type": "object",
+                                            "description": "Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).",
+                                            "nullable": true
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "shippingEstimate": {
+                                      "type": "string",
+                                      "description": "Shipping estimate. For instance, \"three business days\" will be represented as `3bd`."
+                                    },
+                                    "shippingEstimateDate": {
+                                      "type": "string",
+                                      "description": "When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.",
+                                      "nullable": true
+                                    },
+                                    "useIndividualShippingEstimates": {
+                                      "type": "boolean",
+                                      "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`."
+                                    },
+                                    "lockTTL": {
+                                      "type": "string",
+                                      "description": "Estimate date of delivery.",
+                                      "nullable": true
+                                    },
+                                    "price": {
+                                      "type": "integer",
+                                      "description": "Price in cents."
+                                    },
+                                    "listPrice": {
+                                      "type": "integer",
+                                      "description": "List price in cents."
+                                    },
+                                    "tax": {
+                                      "type": "integer",
+                                      "description": "Tax in cents."
+                                    },
+                                    "pickupStoreInfo": {
+                                      "type": "object",
+                                      "description": "Information on the pickup store.",
+                                      "properties": {
+                                        "isPickupStore": {
+                                          "type": "boolean",
+                                          "description": "Indicates whether it is the pickup store."
+                                        },
+                                        "friendlyName": {
+                                          "type": "string",
+                                          "description": "Friendly name.",
+                                          "nullable": true
+                                        },
+                                        "address": {
+                                          "type": "object",
+                                          "description": "Address information.",
+                                          "nullable": true,
+                                          "properties": {
+                                            "addressType": {
+                                              "type": "string",
+                                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                                            },
+                                            "postalCode": {
+                                              "type": "string",
+                                              "description": "Postal code."
+                                            },
+                                            "city": {
+                                              "type": "string",
+                                              "description": "City of the shipping address."
+                                            },
+                                            "state": {
+                                              "type": "string",
+                                              "description": "State of the shipping address."
+                                            },
+                                            "country": {
+                                              "type": "string",
+                                              "description": "Three letter ISO code of the country of the shipping address."
+                                            },
+                                            "street": {
+                                              "type": "string",
+                                              "description": "Street of the shipping address."
+                                            },
+                                            "number": {
+                                              "type": "string",
+                                              "description": "Number of the building, house or apartment in the shipping address."
+                                            },
+                                            "neighborhood": {
+                                              "type": "string",
+                                              "description": "Neighborhood of the shipping address."
+                                            },
+                                            "complement": {
+                                              "type": "string",
+                                              "description": "Complement to the shipping address, in case it applies.",
+                                              "nullable": true
+                                            },
+                                            "reference": {
+                                              "type": "string",
+                                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                              "nullable": true
+                                            },
+                                            "geoCoordinates": {
+                                              "type": "array",
+                                              "description": "Array with two strings that repesent geocoordinates: first latitude, then longitude.",
+                                              "items": {
+                                                "type": "number",
+                                                "description": "Geocoordinates."
+                                              }
+                                            }
+                                          }
+                                        },
+                                        "additionalInfo": {
+                                          "type": "string",
+                                          "description": "Additional information.",
+                                          "nullable": true
+                                        },
+                                        "dockId": {
+                                          "type": "string",
+                                          "description": "Corresponding dock ID.",
+                                          "nullable": true
+                                        }
+                                      }
+                                    },
+                                    "pickupPointId": {
+                                      "type": "string",
+                                      "description": "Pickup point ID.",
+                                      "nullable": true
+                                    },
+                                    "pickupDistance": {
+                                      "type": "integer",
+                                      "description": "Pickup point distance."
+                                    },
+                                    "polygonName": {
+                                      "type": "string",
+                                      "description": "Polygon name.",
+                                      "nullable": true
+                                    },
+                                    "transitTime": {
+                                      "type": "string",
+                                      "description": "Transit time. For instance, \"three business days\" is represented as `3bd`."
+                                    }
+                                  }
+                                }
+                              },
+                              "shipsTo": {
+                                "type": "array",
+                                "description": "List of countries that the item may be shipped to.",
+                                "items": {
+                                  "type": "string",
+                                  "description": "Three letter country code."
+                                }
+                              },
+                              "itemId": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "deliveryChannels": {
+                                "type": "array",
+                                "description": "List of available delivery channels.",
+                                "items": {
+                                  "description": "Delivery channel information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "Delivery channel ID."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "selectedAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the selected addresses for the order.",
+                          "items": {
+                            "description": "Selected address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "availableAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the available addresses for the order.",
+                          "items": {
+                            "description": "Available address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "clientProfileData": {
+                      "type": "object",
+                      "description": "Customer's profile information.",
+                      "nullable": true,
+                      "properties": {
+                        "email": {
+                          "type": "string",
+                          "description": "Email address.",
+                          "nullable": true
+                        },
+                        "firstName": {
+                          "type": "string",
+                          "description": "First name.",
+                          "nullable": true
+                        },
+                        "lastName": {
+                          "type": "string",
+                          "description": "Last name."
+                        },
+                        "documentType": {
+                          "type": "string",
+                          "description": "Type of the document informed by the customer."
+                        },
+                        "document": {
+                          "type": "string",
+                          "description": "Document informed by the customer."
+                        },
+                        "phone": {
+                          "type": "string",
+                          "description": "Phone number."
+                        },
+                        "corporateName": {
+                          "type": "string",
+                          "description": "Company name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "tradeName": {
+                          "type": "string",
+                          "description": "Trade name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporateDocument": {
+                          "type": "string",
+                          "description": "Corporate document, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "stateInscription": {
+                          "type": "string",
+                          "description": "State inscription, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporatePhone": {
+                          "type": "string",
+                          "description": "Corporate phone number, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "isCorporate": {
+                          "type": "boolean",
+                          "description": "Indicates whether the customer is a legal entity."
+                        },
+                        "profileCompleteOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile is complete on loading."
+                        },
+                        "profileErrorOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile presents error on loading.",
+                          "nullable": true
+                        },
+                        "customerClass": {
+                          "type": "string",
+                          "description": "Customer class.",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "paymentData": {
+                      "type": "object",
+                      "description": "Information on the order's payment.",
+                      "properties": {
+                        "giftCards": {
+                          "type": "array",
+                          "description": "Gift card information, if it applies to the order.",
+                          "items": {
+                            "description": "Gift card information.",
+                            "type": "object",
+                            "properties": {
+                              "redemptionCode": {
+                                "type": "string",
+                                "description": "Gift card redemption code."
+                              },
+                              "value": {
+                                "type": "integer",
+                                "description": "Gift card value in cents."
+                              },
+                              "balance": {
+                                "type": "integer",
+                                "description": "Gift card balance in cents."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Gift card name."
+                              },
+                              "id": {
+                                "type": "string",
+                                "description": "Gift card ID."
+                              },
+                              "inUse": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is in use."
+                              },
+                              "isSpecialCard": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is special."
+                              }
+                            }
+                          }
+                        },
+                        "transactions": {
+                          "type": "array",
+                          "description": "Information on each transaction pertinent to the order.",
+                          "items": {
+                            "description": "Transaction information.",
+                            "nullable": true,
+                            "type": "object",
+                            "properties": {
+                              "isActive": {
+                                "type": "boolean",
+                                "description": "Indicates whether transaction is active."
+                              },
+                              "transactionId": {
+                                "type": "string",
+                                "description": "Transaction ID."
+                              },
+                              "merchantName": {
+                                "type": "string",
+                                "description": "Merchant name."
+                              },
+                              "payments": {
+                                "type": "array",
+                                "description": "Information on each payment.",
+                                "items": {
+                                  "description": "Payment information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "accountId": {
+                                      "type": "string",
+                                      "description": "Account ID."
+                                    },
+                                    "bin": {
+                                      "type": "string",
+                                      "description": "Bin.",
+                                      "nullable": true
+                                    },
+                                    "installments": {
+                                      "type": "integer",
+                                      "description": "Number of installments."
+                                    },
+                                    "paymentSystem": {
+                                      "type": "string",
+                                      "description": "Payment system."
+                                    },
+                                    "referenceValue": {
+                                      "type": "integer",
+                                      "description": "Reference value for calculating interest rates, in case it applies. Displayed in cents."
+                                    },
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value including interest, in case it applies. Displayed in cents."
+                                    }
+                                  }
+                                }
+                              },
+                              "sharedTransaction": {
+                                "type": "boolean",
+                                "description": "Indicates whather transaction is shared."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "marketingData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Object containing promotion data such as coupon tracking information and internal or external UTMs.",
+                      "properties": {
+                        "coupon": {
+                          "type": "string",
+                          "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.",
+                          "example": "free-shipping"
+                        },
+                        "utmSource": {
+                          "type": "string",
+                          "description": "UTM source.",
+                          "example": "Facebook"
+                        },
+                        "utmMedium": {
+                          "type": "string",
+                          "description": "UTM medium.",
+                          "example": "CPC"
+                        },
+                        "utmCampaign": {
+                          "type": "string",
+                          "description": "UTM campaign.",
+                          "example": "Black friday"
+                        },
+                        "utmiPage": {
+                          "type": "string",
+                          "description": "utmi_page (internal utm).",
+                          "example": "utmi_page-example",
+                          "nullable": true
+                        },
+                        "utmiPart": {
+                          "type": "string",
+                          "description": "utmi_part (internal utm).",
+                          "example": "utmi_part-example",
+                          "nullable": true
+                        },
+                        "utmiCampaign": {
+                          "type": "string",
+                          "description": "utmi_campaign (internal utm).",
+                          "example": "utmi_campaign-example",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "sellers": {
+                      "type": "array",
+                      "description": "Information on each seller.",
+                      "items": {
+                        "description": "Seller information.",
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "Seller ID."
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Seller name."
+                          },
+                          "logo": {
+                            "type": "string",
+                            "description": "Seller logo.",
+                            "nullable": true
+                          }
+                        }
+                      }
+                    },
+                    "clientPreferencesData": {
+                      "type": "object",
+                      "description": "Object containing preferences from the client who placed the order.",
+                      "properties": {
+                        "locale": {
+                          "type": "string",
+                          "description": "Client's locale. Examples: `pt-BR` and `en-US`."
+                        },
+                        "optinNewsLetter": {
+                          "type": "boolean",
+                          "description": "`true` if the client opted to receive newsletter from the store.",
+                          "example": false,
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "commercialConditionData": {
+                      "type": "object",
+                      "description": "Object containing commercial condition information.",
+                      "nullable": true
+                    },
+                    "storePreferencesData": {
+                      "type": "object",
+                      "description": "Object containing data from the store's configuration (stored in VTEX's License Manager)."
+                    },
+                    "giftRegistryData": {
+                      "type": "object",
+                      "description": "Gift registry list information.",
+                      "nullable": true
+                    },
+                    "openTextField": {
+                      "type": "string",
+                      "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).",
+                      "example": "open-text-example",
+                      "nullable": true
+                    },
+                    "invoiceData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Invoice data including billing address.",
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Billing address.",
+                          "properties": {
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City name."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State name."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Country."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street name."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Street number."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Address complement."
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Reference for location."
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Geographic coordinates (latitude, longitude).",
+                              "items": {
+                                "type": "number"
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "customData": {
+                      "type": "object",
+                      "description": "Customer additional information.",
+                      "nullable": true
+                    },
+                    "itemMetadata": {
+                      "type": "object",
+                      "description": "Item metadata.",
+                      "properties": {
+                        "items": {
+                          "type": "array",
+                          "description": "List of objects containing metadata on each item in the order.",
+                          "items": {
+                            "description": "Item metadata.",
+                            "type": "object",
+                            "properties": {
+                              "id": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "seller": {
+                                "type": "string",
+                                "description": "Seller."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Product name."
+                              },
+                              "skuName": {
+                                "type": "string",
+                                "description": "SKU name."
+                              },
+                              "productId": {
+                                "type": "string",
+                                "description": "Product ID."
+                              },
+                              "refId": {
+                                "type": "string",
+                                "description": "Ref ID."
+                              },
+                              "ean": {
+                                "type": "string",
+                                "description": "European Article Number.",
+                                "nullable": true
+                              },
+                              "imageUrl": {
+                                "type": "string",
+                                "description": "Image URL."
+                              },
+                              "detailUrl": {
+                                "type": "string",
+                                "description": "Detail URL."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "hooksData": {
+                      "type": "object",
+                      "description": "Hooks information.",
+                      "nullable": true
+                    },
+                    "ratesAndBenefitsData": {
+                      "type": "object",
+                      "description": "Information on rates and benefits that apply to the order.",
+                      "properties": {
+                        "rateAndBenefitsIdentifiers": {
+                          "type": "array",
+                          "description": "List with rates and benefits identifiers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit identifier."
+                          }
+                        },
+                        "teaser": {
+                          "type": "array",
+                          "description": "List with rates and benefits teasers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit teaser."
+                          }
+                        }
+                      }
+                    },
+                    "subscriptionData": {
+                      "type": "object",
+                      "description": "Subscription information.",
+                      "nullable": true
+                    },
+                    "itemsOrdination": {
+                      "type": "object",
+                      "description": "Object containing information about the ordering of items within the `orderForm`.",
+                      "properties": {
+                        "criteria": {
+                          "type": "string",
+                          "description": "Criteria adopted to order the items in the list."
+                        },
+                        "ascending": {
+                          "type": "boolean",
+                          "description": "Indicates whether the ordering is ascending."
+                        }
+                      }
+                    }
+                  }
+                },
+                "example": {
+                  "orderFormId": "a7e4702410864239959f9bdcf77e3fba",
+                  "salesChannel": "1",
+                  "loggedIn": false,
+                  "isCheckedIn": false,
+                  "storeId": "1",
+                  "checkedInPickupPointId": "21",
+                  "allowManualPrice": false,
+                  "canEditData": true,
+                  "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
+                  "userType": "User type",
+                  "ignoreProfileData": false,
+                  "value": 0,
+                  "messages": [],
+                  "items": [],
+                  "selectableGifts": [],
+                  "totalizers": [],
+                  "shippingData": null,
+                  "clientProfileData": null,
+                  "paymentData": {
+                    "updateStatus": "updated",
+                    "installmentOptions": [],
+                    "paymentSystems": [],
+                    "payments": [
+                      {
+                        "paymentSystem": 6,
+                        "bin": null,
+                        "accountId": "12",
+                        "tokenId": null,
+                        "value": 34390,
+                        "referenceValue": 34390,
+                        "giftCardRedemptionCode": null,
+                        "giftCardProvider": null,
+                        "giftCardId": null
+                      }
+                    ],
+                    "giftCards": [],
+                    "giftCardMessages": [],
+                    "availableAccounts": [],
+                    "availableTokens": []
+                  },
+                  "marketingData": null,
+                  "sellers": [],
+                  "clientPreferencesData": {
+                    "locale": "PT",
+                    "optinNewsLetter": false
+                  },
+                  "commercialConditionData": null,
+                  "storePreferencesData": {
+                    "countryCode": "BRA",
+                    "saveUserData": true,
+                    "timeZone": "E. South America Standard Time",
+                    "currencyCode": "BRL",
+                    "currencyLocale": 1046,
+                    "currencySymbol": "R$",
+                    "currencyFormatInfo": {
+                      "currencyDecimalDigits": 2,
+                      "currencyDecimalSeparator": ",",
+                      "currencyGroupSeparator": ".",
+                      "currencyGroupSize": 3,
+                      "startsWithCurrencySymbol": true
+                    }
+                  },
+                  "giftRegistryData": null,
+                  "openTextField": null,
+                  "invoiceData": null,
+                  "customData": null,
+                  "itemMetadata": {
+                    "items": [
+                      {
+                        "id": "1",
+                        "seller": "1",
+                        "name": "Ração Royal Canin Feline Urinary 500g",
+                        "skuName": "Ração Royal Canin Feline Urinary 500g",
+                        "productId": "1",
+                        "refId": "0001",
+                        "ean": "123456789",
+                        "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
+                        "detailUrl": "/racao-royal-canin-feline-urinary/p",
+                        "assemblyOptions": []
+                      }
+                    ]
+                  },
+                  "hooksData": null,
+                  "ratesAndBenefitsData": {
+                    "rateAndBenefitsIdentifiers": [],
+                    "teaser": []
+                  },
+                  "subscriptionData": null,
+                  "itemsOrdination": {
+                    "criteria": "NAME",
+                    "ascending": true
+                  }
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/api/checkout/pub/orderForm/{orderFormId}/attachments/marketingData": {
+      "post": {
+        "tags": [
+          "Cart attachments"
+        ],
+        "summary": "Add marketing data",
+        "description": "Use this request to include marketing information to a given shopping cart.\r\n\r\nThe [orderForm](https://developers.vtex.com/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.\n\r\n\r> This request has a time out of 12 seconds.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "AddMarketingData",
+        "security": [],
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "orderFormId",
+            "in": "path",
+            "description": "ID of the orderForm that will receive client profile information.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "ede846222cd44046ba6c638442c3505a"
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "coupon": {
+                    "type": "string",
+                    "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.\n\r\n\rTo send more than one coupon code to the same cart, use commas. E.g.`\"sales25, blackfriday30\"`.",
+                    "example": "free-shipping"
+                  },
+                  "marketingTags": {
+                    "type": "array",
+                    "description": "Marketing tags. Limited to a maximum of 50 items.",
+                    "items": {
+                      "type": "string",
+                      "description": "Marketing tag.",
+                      "example": "tag1"
+                    },
+                    "example": [
+                      "tag1",
+                      "tag2"
+                    ]
+                  },
+                  "utmSource": {
+                    "type": "string",
+                    "description": "UTM source.",
+                    "example": "Facebook"
+                  },
+                  "utmMedium": {
+                    "type": "string",
+                    "description": "UTM medium.",
+                    "example": "CPC"
+                  },
+                  "utmCampaign": {
+                    "type": "string",
+                    "description": "UTM campaign.",
+                    "example": "Black friday"
+                  },
+                  "utmiPage": {
+                    "type": "string",
+                    "description": "UTMI page (internal utm).",
+                    "example": "utmi_page-example"
+                  },
+                  "utmiPart": {
+                    "type": "string",
+                    "description": "UTMI part (internal utm).",
+                    "example": "utmi_part-exmaple"
+                  },
+                  "utmiCampaign": {
+                    "type": "string",
+                    "description": "UTMI campaign (internal utm).",
+                    "example": "utmi_campaign-exmaple"
+                  }
+                }
+              },
+              "example": {
+                "utmSource": "app",
+                "utmMedium": "CPC",
+                "utmCampaign": "Black friday",
+                "utmiPage": null,
+                "utmiPart": null,
+                "utmiCampaign": null,
+                "coupon": "free-shipping",
+                "marketingTags": [
+                  "tag1",
+                  "tag2"
+                ]
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "example": {
+                  "orderFormId": "7c5b47971fad41b89102c7ab7bb8b08b",
+                  "salesChannel": "1",
+                  "loggedIn": false,
+                  "isCheckedIn": false,
+                  "storeId": "1",
+                  "checkedInPickupPointId": "21",
+                  "allowManualPrice": false,
+                  "canEditData": true,
+                  "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
+                  "userType": "User type",
+                  "ignoreProfileData": false,
+                  "value": 0,
+                  "messages": [],
+                  "items": [],
+                  "selectableGifts": [],
+                  "totalizers": [],
+                  "shippingData": null,
+                  "clientProfileData": null,
+                  "paymentData": {
+                    "updateStatus": "updated",
+                    "installmentOptions": [],
+                    "paymentSystems": [],
+                    "payments": [
+                      {
+                        "paymentSystem": 6,
+                        "bin": null,
+                        "accountId": "12",
+                        "tokenId": null,
+                        "value": 34390,
+                        "referenceValue": 34390,
+                        "giftCardRedemptionCode": null,
+                        "giftCardProvider": null,
+                        "giftCardId": null
+                      }
+                    ],
+                    "giftCards": [],
+                    "giftCardMessages": [],
+                    "availableAccounts": [],
+                    "availableTokens": []
+                  },
+                  "marketingData": {
+                    "utmSource": "app",
+                    "utmMedium": "CPC",
+                    "utmCampaign": "Black friday",
+                    "utmipage": null,
+                    "utmiPart": null,
+                    "utmiCampaign": null,
+                    "coupon": "free-shipping",
+                    "marketingTags": [
+                      "tag1",
+                      "tag2"
+                    ]
+                  },
+                  "sellers": [],
+                  "clientPreferencesData": {
+                    "locale": "pt-BR",
+                    "optinNewsLetter": null
+                  },
+                  "commercialConditionData": null,
+                  "storePreferencesData": {
+                    "countryCode": "BRA",
+                    "saveUserData": true,
+                    "timeZone": "E. South America Standard Time",
+                    "currencyCode": "BRL",
+                    "currencyLocale": 1046,
+                    "currencySymbol": "R$",
+                    "currencyFormatInfo": {
+                      "currencyDecimalDigits": 2,
+                      "currencyDecimalSeparator": ",",
+                      "currencyGroupSeparator": ".",
+                      "currencyGroupSize": 3,
+                      "startsWithCurrencySymbol": true
+                    }
+                  },
+                  "giftRegistryData": null,
+                  "openTextField": null,
+                  "invoiceData": null,
+                  "customData": null,
+                  "itemMetadata": {
+                    "items": [
+                      {
+                        "id": "1",
+                        "seller": "1",
+                        "name": "Ração Royal Canin Feline Urinary 500g",
+                        "skuName": "Ração Royal Canin Feline Urinary 500g",
+                        "productId": "1",
+                        "refId": "0001",
+                        "ean": "123456789",
+                        "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
+                        "detailUrl": "/racao-royal-canin-feline-urinary/p",
+                        "assemblyOptions": []
+                      }
+                    ]
+                  },
+                  "hooksData": null,
+                  "ratesAndBenefitsData": {
+                    "rateAndBenefitsIdentifiers": [],
+                    "teaser": []
+                  },
+                  "subscriptionData": null,
+                  "itemsOrdination": {
+                    "criteria": "NAME",
+                    "ascending": true
+                  }
+                },
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "orderFormId": {
+                      "type": "string",
+                      "description": "ID of the orderForm corresponding to a specific cart."
+                    },
+                    "salesChannel": {
+                      "type": "string",
+                      "description": "Attribute created by the seller, in their VTEX store configuration."
+                    },
+                    "loggedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether the user is logged into the store."
+                    },
+                    "isCheckedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether order is checked in."
+                    },
+                    "storeId": {
+                      "type": "string",
+                      "description": "ID of the store.",
+                      "nullable": true
+                    },
+                    "allowManualPrice": {
+                      "type": "boolean",
+                      "description": "Permission to modify item price manually."
+                    },
+                    "canEditData": {
+                      "type": "boolean",
+                      "description": "Data can be edited."
+                    },
+                    "userProfileId": {
+                      "type": "string",
+                      "description": "Unique ID associated with the customer profile."
+                    },
+                    "profileProvider": {
+                      "type": "string",
+                      "description": "Profile provider."
+                    },
+                    "availableAccounts": {
+                      "type": "array",
+                      "description": "Available accounts.",
+                      "items": {
+                        "type": "string",
+                        "description": "Account."
+                      }
+                    },
+                    "availableAddresses": {
+                      "type": "array",
+                      "description": "Information on each available address.",
+                      "items": {
+                        "description": "Address information.",
+                        "type": "object",
+                        "properties": {
+                          "addressType": {
+                            "type": "string",
+                            "description": "Address type."
+                          },
+                          "receiverName": {
+                            "type": "string",
+                            "description": "Name of the receiver."
+                          },
+                          "addressId": {
+                            "type": "string",
+                            "description": "Address ID.",
+                            "nullable": true
+                          },
+                          "isDisposable": {
+                            "type": "boolean",
+                            "description": "Indicates whether address is disposable."
+                          },
+                          "city": {
+                            "type": "string",
+                            "description": "City of the address."
+                          },
+                          "state": {
+                            "type": "string",
+                            "description": "State of the address."
+                          },
+                          "country": {
+                            "type": "string",
+                            "description": "Country of the address. ISO three-letter code."
+                          },
+                          "street": {
+                            "type": "string",
+                            "description": "Street of the address."
+                          },
+                          "number": {
+                            "type": "string",
+                            "description": "Number of the address."
+                          },
+                          "neighborhood": {
+                            "type": "string",
+                            "description": "Neighborhood of the address."
+                          },
+                          "complement": {
+                            "description": "Complement to the shipping address, in case it applies.",
+                            "type": "string",
+                            "nullable": true
+                          },
+                          "reference": {
+                            "type": "string",
+                            "description": "Reference that may help in the location of the address.",
+                            "nullable": true
+                          },
+                          "geoCoordinates": {
+                            "type": "array",
+                            "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                            "items": {
+                              "type": "number",
+                              "description": "Geocoordinates."
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "userType": {
+                      "type": "string",
+                      "description": "User type.",
+                      "nullable": true
+                    },
+                    "ignoreProfileData": {
+                      "type": "boolean",
+                      "description": "Ignore customer profile data."
+                    },
+                    "value": {
+                      "type": "integer",
+                      "description": "Total value of the order without separating cents. For example, $24.99 is represented as `2499`."
+                    },
+                    "messages": {
+                      "type": "array",
+                      "description": "Array containing an object for each message generated by our servers while processing the request.",
+                      "items": {
+                        "type": "string",
+                        "description": "Message."
+                      }
+                    },
+                    "items": {
+                      "type": "array",
+                      "description": "Information on each item in the order.",
+                      "items": {
+                        "description": "Item information.",
+                        "type": "object",
+                        "properties": {
+                          "uniqueId": {
+                            "type": "string",
+                            "description": "Unique ID."
+                          },
+                          "id": {
+                            "type": "string",
+                            "description": "ID of the item."
+                          },
+                          "productId": {
+                            "type": "string",
+                            "description": "Product ID."
+                          },
+                          "productRefId": {
+                            "type": "string",
+                            "description": "Product Ref ID."
+                          },
+                          "refId": {
+                            "type": "string",
+                            "description": "Ref ID."
+                          },
+                          "ean": {
+                            "type": "string",
+                            "description": "European Article Number.",
+                            "nullable": true
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Product name."
+                          },
+                          "skuName": {
+                            "type": "string",
+                            "description": "SKU name."
+                          },
+                          "modalType": {
+                            "type": "string",
+                            "description": "Modal type.",
+                            "nullable": true
+                          },
+                          "parentItemIndex": {
+                            "type": "integer",
+                            "description": "Parent item index.",
+                            "nullable": true
+                          },
+                          "parentAssemblyBinding": {
+                            "type": "string",
+                            "description": "Parent assembly binding.",
+                            "nullable": true
+                          },
+                          "priceValidUntil": {
+                            "type": "string",
+                            "description": "Price expiration date and time."
+                          },
+                          "tax": {
+                            "type": "integer",
+                            "description": "Tax value in cents."
+                          },
+                          "taxCode": {
+                            "type": "string",
+                            "description": "A unique identifier code assigned to a tax within the VTEX Admin."
+                          },
+                          "price": {
+                            "type": "integer",
+                            "description": "Price in cents."
+                          },
+                          "listPrice": {
+                            "type": "integer",
+                            "description": "List price in cents."
+                          },
+                          "manualPrice": {
+                            "type": "integer",
+                            "description": "Manual price in cents.",
+                            "nullable": true
+                          },
+                          "manualPriceAppliedBy": {
+                            "type": "string",
+                            "description": "User that applied the manual price, if that is the case.",
+                            "nullable": true
+                          },
+                          "sellingPrice": {
+                            "type": "integer",
+                            "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
+                          },
+                          "rewardValue": {
+                            "type": "integer",
+                            "description": "Reward value in cents."
+                          },
+                          "isGift": {
+                            "type": "boolean",
+                            "description": "Indicates whether item is a gift."
+                          },
+                          "additionalInfo": {
+                            "type": "object",
+                            "description": "Additional information.",
+                            "properties": {
+                              "dimension": {
+                                "type": "string",
+                                "description": "Dimension.",
+                                "nullable": true
+                              },
+                              "brandName": {
+                                "type": "string",
+                                "description": "Brand name."
+                              },
+                              "brandId": {
+                                "type": "string",
+                                "description": "Brand ID."
+                              },
+                              "offeringInfo": {
+                                "type": "string",
+                                "description": "Offering information.",
+                                "nullable": true
+                              },
+                              "offeringType": {
+                                "type": "string",
+                                "description": "Offering type.",
+                                "nullable": true
+                              },
+                              "offeringTypeId": {
+                                "type": "string",
+                                "description": "Offering type ID.",
+                                "nullable": true
+                              }
+                            }
+                          },
+                          "preSaleDate": {
+                            "type": "string",
+                            "description": "Presale date.",
+                            "nullable": true
+                          },
+                          "productCategoryIds": {
+                            "type": "string",
+                            "description": "Product category IDs."
+                          },
+                          "productCategories": {
+                            "type": "object",
+                            "description": "Object, where each field is an ID from `productCategoryIds`.",
+                            "properties": {
+                              "{ID}": {
+                                "type": "string",
+                                "description": "Product category corresponding to the ID in the field key."
+                              }
+                            }
+                          },
+                          "quantity": {
+                            "type": "integer",
+                            "description": "Quantity."
+                          },
+                          "seller": {
+                            "type": "string",
+                            "description": "Seller."
+                          },
+                          "sellerChain": {
+                            "type": "array",
+                            "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
+                            "items": {
+                              "type": "string",
+                              "description": "Seller."
+                            }
+                          },
+                          "imageUrl": {
+                            "type": "string",
+                            "description": "Image URL."
+                          },
+                          "detailUrl": {
+                            "type": "string",
+                            "description": "Detail URL."
+                          },
+                          "bundleItems": {
+                            "type": "array",
+                            "description": "Information on services sold along with the SKU. Example: a gift package.",
+                            "items": {
+                              "description": "Service information.",
+                              "type": "object",
+                              "properties": {
+                                "type": {
+                                  "type": "string",
+                                  "description": "Service type."
+                                },
+                                "id": {
+                                  "type": "integer",
+                                  "description": "Service identifier."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Service name."
+                                },
+                                "price": {
+                                  "type": "integer",
+                                  "description": "Service price in cents."
+                                }
+                              }
+                            }
+                          },
+                          "attachments": {
+                            "type": "array",
+                            "description": "Array containing information on attachments.",
+                            "items": {
+                              "type": "string",
+                              "description": "Attachment."
+                            }
+                          },
+                          "priceTags": {
+                            "type": "array",
+                            "description": "Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.",
+                            "items": {
+                              "description": "Price tag information.",
+                              "type": "object",
+                              "properties": {
+                                "identifier": {
+                                  "type": "string",
+                                  "description": "Promotion unique identifier.",
+                                  "nullable": true
+                                },
+                                "isPercentual": {
+                                  "type": "boolean",
+                                  "description": "Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\r\n- `type` indicates whether the tag refers to a discount or tax.\r\n- `where` specifies the context, either price or shipping.\r\n- `identifier` is the promotion ID.\r\n- `calculationId` is a hash that may vary with each price calculation."
+                                },
+                                "rawValue": {
+                                  "type": "number",
+                                  "description": "Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations."
+                                },
+                                "value": {
+                                  "type": "integer",
+                                  "description": "Price tag value representing either a promotion (value decrease) or a tax (value increase)."
+                                }
+                              }
+                            }
+                          },
+                          "availability": {
+                            "type": "string",
+                            "description": "Availability."
+                          },
+                          "measurementUnit": {
+                            "type": "string",
+                            "description": "Measurement unit."
+                          },
+                          "unitMultiplier": {
+                            "type": "integer",
+                            "description": "Unit multiplier."
+                          },
+                          "manufacturerCode": {
+                            "type": "string",
+                            "description": "Manufacturer code.",
+                            "nullable": true
+                          },
+                          "priceDefinition": {
+                            "type": "object",
+                            "description": "Price information for all units of a specific item.",
+                            "properties": {
+                              "calculatedSellingPrice": {
+                                "type": "integer",
+                                "description": "Item's calculated unitary selling price in cents."
+                              },
+                              "total": {
+                                "type": "integer",
+                                "description": "Total value for all units of the item in cents."
+                              },
+                              "sellingPrices": {
+                                "type": "array",
+                                "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
+                                "items": {
+                                  "description": "Rounding information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value in cents for that specific rounding."
+                                    },
+                                    "quantity": {
+                                      "type": "integer",
+                                      "description": "Rounding quantity, meaning how many items are rounded to this value."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "selectableGifts": {
+                      "type": "array",
+                      "description": "Array containing the data of the item selected as a gift.",
+                      "items": {
+                        "type": "string",
+                        "description": "Gift."
+                      }
+                    },
+                    "totalizers": {
+                      "type": "array",
+                      "description": "Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).",
+                      "items": {
+                        "type": "object",
+                        "description": "Totalizer of purchases."
+                      }
+                    },
+                    "shippingData": {
+                      "type": "object",
+                      "description": "Shipping information pertinent to the order.",
+                      "nullable": true,
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Address information.",
+                          "nullable": true,
+                          "properties": {
+                            "addressType": {
+                              "type": "string",
+                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                            },
+                            "receiverName": {
+                              "type": "string",
+                              "description": "Name of the person who is going to receive the order."
+                            },
+                            "addressId": {
+                              "type": "string",
+                              "description": "Address ID.",
+                              "nullable": true
+                            },
+                            "isDisposable": {
+                              "type": "boolean",
+                              "description": "Indicates whether address is disposable."
+                            },
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City of the shipping address."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State of the shipping address."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Three letter ISO code of the country of the shipping address."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street of the shipping address."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Number of the building, house or apartment in the shipping address."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood of the shipping address."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Complement to the shipping address, in case it applies.",
+                              "nullable": true
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                              "nullable": true
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                              "items": {
+                                "type": "number",
+                                "description": "Geocoordinates."
+                              }
+                            }
+                          }
+                        },
+                        "logisticsInfo": {
+                          "type": "array",
+                          "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.",
+                          "items": {
+                            "description": "Logistics information.",
+                            "type": "object",
+                            "properties": {
+                              "itemIndex": {
+                                "type": "integer",
+                                "description": "Index corresponding to the position of the object in the `items` array."
+                              },
+                              "selectedSla": {
+                                "type": "string",
+                                "description": "SLA selected by the customer.",
+                                "nullable": true
+                              },
+                              "selectedDeliveryChannel": {
+                                "type": "string",
+                                "description": "Delivery channel selected by the customer.",
+                                "nullable": true
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "slas": {
+                                "type": "array",
+                                "description": "Information on available SLAs.",
+                                "items": {
+                                  "description": "SLA information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "SLA ID."
+                                    },
+                                    "deliveryChannel": {
+                                      "type": "string",
+                                      "description": "Delivery channel."
+                                    },
+                                    "name": {
+                                      "type": "string",
+                                      "description": "SLA name."
+                                    },
+                                    "deliveryIds": {
+                                      "type": "array",
+                                      "description": "Information on each delivery ID.",
+                                      "items": {
+                                        "description": "Delivery ID information.",
+                                        "type": "object",
+                                        "properties": {
+                                          "courierId": {
+                                            "type": "string",
+                                            "description": "Courier ID."
+                                          },
+                                          "warehouseId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "dockId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "courierName": {
+                                            "type": "string",
+                                            "description": "Courier name."
+                                          },
+                                          "quantity": {
+                                            "type": "integer",
+                                            "description": "Quantity."
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "attachmentOfferings": {
+                                      "type": "array",
+                                      "description": "List of attachments details.",
+                                      "nullable": true,
+                                      "items": {
+                                        "description": "Attachment details.",
+                                        "type": "object",
+                                        "required": [
+                                          "name",
+                                          "required",
+                                          "schema"
+                                        ],
+                                        "properties": {
+                                          "name": {
+                                            "type": "string",
+                                            "description": "Name of the attachment.",
+                                            "nullable": true
+                                          },
+                                          "required": {
+                                            "type": "boolean",
+                                            "description": "Defines if the attachment is required (`true`) or not (`false`).",
+                                            "nullable": true
+                                          },
+                                          "schema": {
+                                            "type": "object",
+                                            "description": "Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).",
+                                            "nullable": true
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "shippingEstimate": {
+                                      "type": "string",
+                                      "description": "Shipping estimate. For instance, \"three business days\" will be represented as `3bd`."
+                                    },
+                                    "shippingEstimateDate": {
+                                      "type": "string",
+                                      "description": "When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.",
+                                      "nullable": true
+                                    },
+                                    "useIndividualShippingEstimates": {
+                                      "type": "boolean",
+                                      "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`."
+                                    },
+                                    "lockTTL": {
+                                      "type": "string",
+                                      "description": "Estimate date of delivery.",
+                                      "nullable": true
+                                    },
+                                    "price": {
+                                      "type": "integer",
+                                      "description": "Price in cents."
+                                    },
+                                    "listPrice": {
+                                      "type": "integer",
+                                      "description": "List price in cents."
+                                    },
+                                    "tax": {
+                                      "type": "integer",
+                                      "description": "Tax in cents."
+                                    },
+                                    "pickupStoreInfo": {
+                                      "type": "object",
+                                      "description": "Information on the pickup store.",
+                                      "properties": {
+                                        "isPickupStore": {
+                                          "type": "boolean",
+                                          "description": "Indicates whether it is the pickup store."
+                                        },
+                                        "friendlyName": {
+                                          "type": "string",
+                                          "description": "Friendly name.",
+                                          "nullable": true
+                                        },
+                                        "address": {
+                                          "type": "object",
+                                          "description": "Address information.",
+                                          "nullable": true,
+                                          "properties": {
+                                            "addressType": {
+                                              "type": "string",
+                                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                                            },
+                                            "postalCode": {
+                                              "type": "string",
+                                              "description": "Postal code."
+                                            },
+                                            "city": {
+                                              "type": "string",
+                                              "description": "City of the shipping address."
+                                            },
+                                            "state": {
+                                              "type": "string",
+                                              "description": "State of the shipping address."
+                                            },
+                                            "country": {
+                                              "type": "string",
+                                              "description": "Three letter ISO code of the country of the shipping address."
+                                            },
+                                            "street": {
+                                              "type": "string",
+                                              "description": "Street of the shipping address."
+                                            },
+                                            "number": {
+                                              "type": "string",
+                                              "description": "Number of the building, house or apartment in the shipping address."
+                                            },
+                                            "neighborhood": {
+                                              "type": "string",
+                                              "description": "Neighborhood of the shipping address."
+                                            },
+                                            "complement": {
+                                              "type": "string",
+                                              "description": "Complement to the shipping address, in case it applies.",
+                                              "nullable": true
+                                            },
+                                            "reference": {
+                                              "type": "string",
+                                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                              "nullable": true
+                                            },
+                                            "geoCoordinates": {
+                                              "type": "array",
+                                              "description": "Array with two strings that repesent geocoordinates: first latitude, then longitude.",
+                                              "items": {
+                                                "type": "number",
+                                                "description": "Geocoordinates."
+                                              }
+                                            }
+                                          }
+                                        },
+                                        "additionalInfo": {
+                                          "type": "string",
+                                          "description": "Additional information.",
+                                          "nullable": true
+                                        },
+                                        "dockId": {
+                                          "type": "string",
+                                          "description": "Corresponding dock ID.",
+                                          "nullable": true
+                                        }
+                                      }
+                                    },
+                                    "pickupPointId": {
+                                      "type": "string",
+                                      "description": "Pickup point ID.",
+                                      "nullable": true
+                                    },
+                                    "pickupDistance": {
+                                      "type": "integer",
+                                      "description": "Pickup point distance."
+                                    },
+                                    "polygonName": {
+                                      "type": "string",
+                                      "description": "Polygon name.",
+                                      "nullable": true
+                                    },
+                                    "transitTime": {
+                                      "type": "string",
+                                      "description": "Transit time. For instance, \"three business days\" is represented as `3bd`."
+                                    }
+                                  }
+                                }
+                              },
+                              "shipsTo": {
+                                "type": "array",
+                                "description": "List of countries that the item may be shipped to.",
+                                "items": {
+                                  "type": "string",
+                                  "description": "Three letter country code."
+                                }
+                              },
+                              "itemId": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "deliveryChannels": {
+                                "type": "array",
+                                "description": "List of available delivery channels.",
+                                "items": {
+                                  "description": "Delivery channel information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "Delivery channel ID."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "selectedAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the selected addresses for the order.",
+                          "items": {
+                            "description": "Selected address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "availableAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the available addresses for the order.",
+                          "items": {
+                            "description": "Available address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "clientProfileData": {
+                      "type": "object",
+                      "description": "Customer's profile information.",
+                      "nullable": true,
+                      "properties": {
+                        "email": {
+                          "type": "string",
+                          "description": "Email address.",
+                          "nullable": true
+                        },
+                        "firstName": {
+                          "type": "string",
+                          "description": "First name.",
+                          "nullable": true
+                        },
+                        "lastName": {
+                          "type": "string",
+                          "description": "Last name."
+                        },
+                        "documentType": {
+                          "type": "string",
+                          "description": "Type of the document informed by the customer."
+                        },
+                        "document": {
+                          "type": "string",
+                          "description": "Document informed by the customer."
+                        },
+                        "phone": {
+                          "type": "string",
+                          "description": "Phone number."
+                        },
+                        "corporateName": {
+                          "type": "string",
+                          "description": "Company name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "tradeName": {
+                          "type": "string",
+                          "description": "Trade name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporateDocument": {
+                          "type": "string",
+                          "description": "Corporate document, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "stateInscription": {
+                          "type": "string",
+                          "description": "State inscription, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporatePhone": {
+                          "type": "string",
+                          "description": "Corporate phone number, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "isCorporate": {
+                          "type": "boolean",
+                          "description": "Indicates whether the customer is a legal entity."
+                        },
+                        "profileCompleteOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile is complete on loading."
+                        },
+                        "profileErrorOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile presents error on loading.",
+                          "nullable": true
+                        },
+                        "customerClass": {
+                          "type": "string",
+                          "description": "Customer class.",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "paymentData": {
+                      "type": "object",
+                      "description": "Information on the order's payment.",
+                      "properties": {
+                        "giftCards": {
+                          "type": "array",
+                          "description": "Gift card information, if it applies to the order.",
+                          "items": {
+                            "description": "Gift card information.",
+                            "type": "object",
+                            "properties": {
+                              "redemptionCode": {
+                                "type": "string",
+                                "description": "Gift card redemption code."
+                              },
+                              "value": {
+                                "type": "integer",
+                                "description": "Gift card value in cents."
+                              },
+                              "balance": {
+                                "type": "integer",
+                                "description": "Gift card balance in cents."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Gift card name."
+                              },
+                              "id": {
+                                "type": "string",
+                                "description": "Gift card ID."
+                              },
+                              "inUse": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is in use."
+                              },
+                              "isSpecialCard": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is special."
+                              }
+                            }
+                          }
+                        },
+                        "transactions": {
+                          "type": "array",
+                          "description": "Information on each transaction pertinent to the order.",
+                          "items": {
+                            "description": "Transaction information.",
+                            "nullable": true,
+                            "type": "object",
+                            "properties": {
+                              "isActive": {
+                                "type": "boolean",
+                                "description": "Indicates whether transaction is active."
+                              },
+                              "transactionId": {
+                                "type": "string",
+                                "description": "Transaction ID."
+                              },
+                              "merchantName": {
+                                "type": "string",
+                                "description": "Merchant name."
+                              },
+                              "payments": {
+                                "type": "array",
+                                "description": "Information on each payment.",
+                                "items": {
+                                  "description": "Payment information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "accountId": {
+                                      "type": "string",
+                                      "description": "Account ID."
+                                    },
+                                    "bin": {
+                                      "type": "string",
+                                      "description": "Bin.",
+                                      "nullable": true
+                                    },
+                                    "installments": {
+                                      "type": "integer",
+                                      "description": "Number of installments."
+                                    },
+                                    "paymentSystem": {
+                                      "type": "string",
+                                      "description": "Payment system."
+                                    },
+                                    "referenceValue": {
+                                      "type": "integer",
+                                      "description": "Reference value for calculating interest rates, in case it applies. Displayed in cents."
+                                    },
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value including interest, in case it applies. Displayed in cents."
+                                    }
+                                  }
+                                }
+                              },
+                              "sharedTransaction": {
+                                "type": "boolean",
+                                "description": "Indicates whather transaction is shared."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "marketingData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Object containing promotion data such as coupon tracking information and internal or external UTMs.",
+                      "properties": {
+                        "coupon": {
+                          "type": "string",
+                          "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.",
+                          "example": "free-shipping"
+                        },
+                        "utmSource": {
+                          "type": "string",
+                          "description": "UTM source.",
+                          "example": "Facebook"
+                        },
+                        "utmMedium": {
+                          "type": "string",
+                          "description": "UTM medium.",
+                          "example": "CPC"
+                        },
+                        "utmCampaign": {
+                          "type": "string",
+                          "description": "UTM campaign.",
+                          "example": "Black friday"
+                        },
+                        "utmiPage": {
+                          "type": "string",
+                          "description": "utmi_page (internal utm).",
+                          "example": "utmi_page-example",
+                          "nullable": true
+                        },
+                        "utmiPart": {
+                          "type": "string",
+                          "description": "utmi_part (internal utm).",
+                          "example": "utmi_part-example",
+                          "nullable": true
+                        },
+                        "utmiCampaign": {
+                          "type": "string",
+                          "description": "utmi_campaign (internal utm).",
+                          "example": "utmi_campaign-example",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "sellers": {
+                      "type": "array",
+                      "description": "Information on each seller.",
+                      "items": {
+                        "description": "Seller information.",
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "Seller ID."
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Seller name."
+                          },
+                          "logo": {
+                            "type": "string",
+                            "description": "Seller logo.",
+                            "nullable": true
+                          }
+                        }
+                      }
+                    },
+                    "clientPreferencesData": {
+                      "type": "object",
+                      "description": "Object containing preferences from the client who placed the order.",
+                      "properties": {
+                        "locale": {
+                          "type": "string",
+                          "description": "Client's locale. Examples: `pt-BR` and `en-US`."
+                        },
+                        "optinNewsLetter": {
+                          "type": "boolean",
+                          "description": "`true` if the client opted to receive newsletter from the store.",
+                          "example": false,
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "commercialConditionData": {
+                      "type": "object",
+                      "description": "Object containing commercial condition information.",
+                      "nullable": true
+                    },
+                    "storePreferencesData": {
+                      "type": "object",
+                      "description": "Object containing data from the store's configuration (stored in VTEX's License Manager)."
+                    },
+                    "giftRegistryData": {
+                      "type": "object",
+                      "description": "Gift registry list information.",
+                      "nullable": true
+                    },
+                    "openTextField": {
+                      "type": "string",
+                      "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).",
+                      "example": "open-text-example",
+                      "nullable": true
+                    },
+                    "invoiceData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Invoice data including billing address.",
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Billing address.",
+                          "properties": {
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City name."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State name."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Country."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street name."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Street number."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Address complement."
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Reference for location."
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Geographic coordinates (latitude, longitude).",
+                              "items": {
+                                "type": "number"
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "customData": {
+                      "type": "object",
+                      "description": "Customer additional information.",
+                      "nullable": true
+                    },
+                    "itemMetadata": {
+                      "type": "object",
+                      "description": "Item metadata.",
+                      "properties": {
+                        "items": {
+                          "type": "array",
+                          "description": "List of objects containing metadata on each item in the order.",
+                          "items": {
+                            "description": "Item metadata.",
+                            "type": "object",
+                            "properties": {
+                              "id": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "seller": {
+                                "type": "string",
+                                "description": "Seller."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Product name."
+                              },
+                              "skuName": {
+                                "type": "string",
+                                "description": "SKU name."
+                              },
+                              "productId": {
+                                "type": "string",
+                                "description": "Product ID."
+                              },
+                              "refId": {
+                                "type": "string",
+                                "description": "Ref ID."
+                              },
+                              "ean": {
+                                "type": "string",
+                                "description": "European Article Number.",
+                                "nullable": true
+                              },
+                              "imageUrl": {
+                                "type": "string",
+                                "description": "Image URL."
+                              },
+                              "detailUrl": {
+                                "type": "string",
+                                "description": "Detail URL."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "hooksData": {
+                      "type": "object",
+                      "description": "Hooks information.",
+                      "nullable": true
+                    },
+                    "ratesAndBenefitsData": {
+                      "type": "object",
+                      "description": "Information on rates and benefits that apply to the order.",
+                      "properties": {
+                        "rateAndBenefitsIdentifiers": {
+                          "type": "array",
+                          "description": "List with rates and benefits identifiers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit identifier."
+                          }
+                        },
+                        "teaser": {
+                          "type": "array",
+                          "description": "List with rates and benefits teasers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit teaser."
+                          }
+                        }
+                      }
+                    },
+                    "subscriptionData": {
+                      "type": "object",
+                      "description": "Subscription information.",
+                      "nullable": true
+                    },
+                    "itemsOrdination": {
+                      "type": "object",
+                      "description": "Object containing information about the ordering of items within the `orderForm`.",
+                      "properties": {
+                        "criteria": {
+                          "type": "string",
+                          "description": "Criteria adopted to order the items in the list."
+                        },
+                        "ascending": {
+                          "type": "boolean",
+                          "description": "Indicates whether the ordering is ascending."
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/api/checkout/pub/orderForm/{orderFormId}/attachments/paymentData": {
+      "post": {
+        "tags": [
+          "Cart attachments"
+        ],
+        "summary": "Add payment data",
+        "description": "Use this request to include payment information to a given shopping cart. The payment information attachment in the shopping cart does not determine the final order payment method in itself. However, it allows tha platform to update any relevant information that may be impacted by the payment method.\r\n\r\nThe [orderForm](https://developers.vtex.com/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.\n\r\n\r> This request has a time out of 12 seconds.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "AddPaymentData",
+        "security": [],
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "orderFormId",
+            "in": "path",
+            "description": "ID of the orderForm that will receive client profile information.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "ede846222cd44046ba6c638442c3505a"
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "payments": {
+                    "type": "array",
+                    "description": "Array with information on each payment chosen by the shopper.",
+                    "items": {
+                      "type": "object",
+                      "description": "Payment information.",
+                      "properties": {
+                        "paymentSystem": {
+                          "type": "integer",
+                          "description": "Payment system ID.",
+                          "example": 1
+                        },
+                        "paymentSystemName": {
+                          "type": "string",
+                          "description": "Payment system name.",
+                          "example": "Boleto Bancário"
+                        },
+                        "group": {
+                          "type": "string",
+                          "description": "Payment system group.",
+                          "example": "bankInvoicePaymentGroup"
+                        },
+                        "installments": {
+                          "type": "integer",
+                          "description": "Selected number of installments.",
+                          "example": 1
+                        },
+                        "installmentsInterestRate": {
+                          "type": "number",
+                          "description": "Installments' interest rate.",
+                          "example": 0
+                        },
+                        "installmentsValue": {
+                          "type": "integer",
+                          "description": "Value of the installments.",
+                          "example": 1
+                        },
+                        "value": {
+                          "type": "integer",
+                          "description": "Total value assigned to this payment.",
+                          "example": 100
+                        },
+                        "referenceValue": {
+                          "type": "integer",
+                          "description": "Reference value used to calculate total order value with interest.",
+                          "example": 100
+                        },
+                        "hasDefaultBillingAddress": {
+                          "type": "boolean",
+                          "description": "Indicates whether billing address for this payment is the default address.",
+                          "example": false
+                        }
+                      }
+                    }
+                  }
+                }
+              },
+              "example": {
+                "payments": [
+                  {
+                    "paymentSystem": 6,
+                    "paymentSystemName": "Boleto Bancário",
+                    "group": "bankInvoicePaymentGroup",
+                    "installments": 1,
+                    "installmentsInterestRate": 0,
+                    "installmentsValue": 34390,
+                    "value": 34390,
+                    "referenceValue": 34390,
+                    "hasDefaultBillingAddress": false
+                  }
+                ]
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "example": {
+                  "orderFormId": "29154e27383145cc8ce1f7a1df0d99c4",
+                  "salesChannel": "1",
+                  "loggedIn": false,
+                  "isCheckedIn": false,
+                  "storeId": "1",
+                  "checkedInPickupPointId": "21",
+                  "allowManualPrice": false,
+                  "canEditData": true,
+                  "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
+                  "userType": "User type",
+                  "ignoreProfileData": false,
+                  "value": 65780,
+                  "messages": [],
+                  "items": [
+                    {
+                      "uniqueId": "3CBFA140CE8F4E208062FC15CE9ED8D3",
+                      "id": "2",
+                      "productId": "2",
+                      "productRefId": "1",
+                      "refId": "CBC30L",
+                      "ean": null,
+                      "name": "Chopp Claro 30L",
+                      "skuName": "Chopp Claro 30L",
+                      "modalType": null,
+                      "parentItemIndex": null,
+                      "parentAssemblyBinding": null,
+                      "assemblies": [],
+                      "priceValidUntil": "2022-07-28T22:25:25Z",
+                      "tax": 0,
+                      "price": 32890,
+                      "listPrice": 49900,
+                      "manualPrice": null,
+                      "manualPriceAppliedBy": null,
+                      "sellingPrice": 32890,
+                      "rewardValue": 0,
+                      "isGift": false,
+                      "additionalInfo": {
+                        "dimension": null,
+                        "brandName": "Beershow",
+                        "brandId": "2000000",
+                        "offeringInfo": null,
+                        "offeringType": null,
+                        "offeringTypeId": null
+                      },
+                      "preSaleDate": null,
+                      "productCategoryIds": "/1/",
+                      "productCategories": {
+                        "1": "Bebidas"
+                      },
+                      "quantity": 2,
+                      "seller": "1",
+                      "sellerChain": [
+                        "1"
+                      ],
+                      "imageUrl": "http://myshop.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000",
+                      "detailUrl": "/chopp-claro-30l/p",
+                      "components": [],
+                      "bundleItems": [],
+                      "attachments": [],
+                      "attachmentOfferings": [
+                        {
+                          "name": "vtex.subscription.weekly",
+                          "required": false,
+                          "schema": {
+                            "vtex.subscription.key.frequency": {
+                              "MaximumNumberOfCharacters": 7,
+                              "Domain": [
+                                "1 week",
+                                "2 week",
+                                "3 week",
+                                "4 week"
+                              ]
+                            }
+                          }
+                        },
+                        {
+                          "name": "vtex.subscription.daily",
+                          "required": false,
+                          "schema": {
+                            "vtex.subscription.key.frequency": {
+                              "MaximumNumberOfCharacters": 5,
+                              "Domain": [
+                                "1 day"
+                              ]
+                            }
+                          }
+                        }
+                      ],
+                      "offerings": [],
+                      "priceTags": [
+                        {
+                          "name": "DISCOUNT@MANUALPRICE",
+                          "value": -5000,
+                          "rawValue": -50,
+                          "isPercentual": false,
+                          "identifier": "1234abc-5678b-1234c"
+                        }
+                      ],
+                      "availability": "available",
+                      "measurementUnit": "un",
+                      "unitMultiplier": 1,
+                      "manufacturerCode": null,
+                      "priceDefinition": {
+                        "calculatedSellingPrice": 32890,
+                        "total": 65780,
+                        "sellingPrices": [
+                          {
+                            "value": 32890,
+                            "quantity": 2
+                          }
+                        ]
+                      }
+                    }
+                  ],
+                  "selectableGifts": [],
+                  "totalizers": [
+                    {
+                      "id": "Items",
+                      "name": "Total dos Itens",
+                      "value": 65780
+                    }
+                  ],
+                  "shippingData": {
+                    "address": null,
+                    "logisticsInfo": [
+                      {
+                        "itemIndex": 0,
+                        "selectedSla": "Normal",
+                        "selectedDeliveryChannel": "delivery",
+                        "addressId": "666c2e830bd9474ab6f6cc53fb6dd2d2",
+                        "slas": [],
+                        "shipsTo": [
+                          "BRA",
+                          "COL",
+                          "USA"
+                        ],
+                        "itemId": "2",
+                        "deliveryChannels": [
+                          {
+                            "id": "delivery"
+                          },
+                          {
+                            "id": "pickup-in-point"
+                          }
+                        ]
+                      }
+                    ],
+                    "selectedAddresses": [],
+                    "availableAddresses": [],
+                    "pickupPoints": []
+                  },
+                  "clientProfileData": null,
+                  "paymentData": {
+                    "updateStatus": "updated",
+                    "installmentOptions": [
+                      {
+                        "paymentSystem": 2,
+                        "bin": null,
+                        "paymentName": null,
+                        "paymentGroupName": null,
+                        "value": 65780,
+                        "installments": [
+                          {
+                            "count": 1,
+                            "hasInterestRate": false,
+                            "interestRate": 0,
+                            "value": 65780,
+                            "total": 65780,
+                            "sellerMerchantInstallments": [
+                              {
+                                "id": "MYSHOP",
+                                "count": 1,
+                                "hasInterestRate": false,
+                                "interestRate": 0,
+                                "value": 65780,
+                                "total": 65780
+                              }
+                            ]
+                          }
+                        ]
+                      },
+                      {
+                        "paymentSystem": 4,
+                        "bin": null,
+                        "paymentName": null,
+                        "paymentGroupName": null,
+                        "value": 65780,
+                        "installments": [
+                          {
+                            "count": 1,
+                            "hasInterestRate": false,
+                            "interestRate": 0,
+                            "value": 65780,
+                            "total": 65780,
+                            "sellerMerchantInstallments": [
+                              {
+                                "id": "MYSHOP",
+                                "count": 1,
+                                "hasInterestRate": false,
+                                "interestRate": 0,
+                                "value": 65780,
+                                "total": 65780
+                              }
+                            ]
+                          }
+                        ]
+                      },
+                      {
+                        "paymentSystem": 6,
+                        "bin": null,
+                        "paymentName": null,
+                        "paymentGroupName": null,
+                        "value": 65780,
+                        "installments": [
+                          {
+                            "count": 1,
+                            "hasInterestRate": false,
+                            "interestRate": 0,
+                            "value": 65780,
+                            "total": 65780,
+                            "sellerMerchantInstallments": [
+                              {
+                                "id": "MYSHOP",
+                                "count": 1,
+                                "hasInterestRate": false,
+                                "interestRate": 0,
+                                "value": 65780,
+                                "total": 65780
+                              }
+                            ]
+                          }
+                        ]
+                      }
+                    ],
+                    "paymentSystems": [
+                      {
+                        "id": 2,
+                        "name": "Visa",
+                        "groupName": "creditCardPaymentGroup",
+                        "validator": {
+                          "regex": "^4[0-9]{15}$",
+                          "mask": "9999 9999 9999 9999",
+                          "cardCodeRegex": "^[0-9]{3}$",
+                          "cardCodeMask": "999",
+                          "weights": [
+                            2,
+                            1,
+                            2,
+                            1,
+                            2,
+                            1,
+                            2,
+                            1,
+                            2,
+                            1,
+                            2,
+                            1,
+                            2,
+                            1,
+                            2,
+                            1,
+                            2,
+                            1,
+                            2
+                          ],
+                          "useCvv": true,
+                          "useExpirationDate": true,
+                          "useCardHolderName": true,
+                          "useBillingAddress": true
+                        },
+                        "stringId": "2",
+                        "template": "creditCardPaymentGroup-template",
+                        "requiresDocument": false,
+                        "isCustom": false,
+                        "description": "Payment description",
+                        "requiresAuthentication": false,
+                        "dueDate": "2021-08-04T22:19:04.9948627Z",
+                        "availablePayments": null
+                      },
+                      {
+                        "id": 4,
+                        "name": "Mastercard",
+                        "groupName": "creditCardPaymentGroup",
+                        "validator": {
+                          "regex": "^((5(([1-2]|[4-5])[0-9]{8}|0((1|6)([0-9]{7}))|3(0(4((0|[2-9])[0-9]{5})|([0-3]|[5-9])[0-9]{6})|[1-9][0-9]{7})))|((508116)\\d{4,10})|((502121)\\d{4,10})|((589916)\\d{4,10})|(2[0-9]{15})|(67[0-9]{14})|(506387)\\d{4,10})",
+                          "mask": "9999 9999 9999 9999",
+                          "cardCodeRegex": "^[0-9]{3}$",
+                          "cardCodeMask": "999",
+                          "weights": [
+                            2,
+                            1,
+                            2,
+                            1,
+                            2,
+                            1,
+                            2,
+                            1,
+                            2,
+                            1,
+                            2,
+                            1,
+                            2,
+                            1,
+                            2,
+                            1,
+                            2,
+                            1,
+                            2
+                          ],
+                          "useCvv": true,
+                          "useExpirationDate": true,
+                          "useCardHolderName": true,
+                          "useBillingAddress": true
+                        },
+                        "stringId": "4",
+                        "template": "creditCardPaymentGroup-template",
+                        "requiresDocument": false,
+                        "isCustom": false,
+                        "description": "Payment description",
+                        "requiresAuthentication": false,
+                        "dueDate": "2021-08-04T22:19:04.9948627Z",
+                        "availablePayments": null
+                      },
+                      {
+                        "id": 6,
+                        "name": "Boleto Bancário",
+                        "groupName": "bankInvoicePaymentGroup",
+                        "validator": {
+                          "regex": "^((5(([1-2]|[4-5])[0-9]{8}|0((1|6)([0-9]{7}))|3(0(4((0|[2-9])[0-9]{5})|([0-3]|[5-9])[0-9]{6})|[1-9][0-9]{7})))|((508116)\\d{4,10})|((502121)\\d{4,10})|((589916)\\d{4,10})|(2[0-9]{15})|(67[0-9]{14})|(506387)\\d{4,10})",
+                          "mask": "9999 9999 9999 9999",
+                          "cardCodeRegex": "^[0-9]{3}$",
+                          "cardCodeMask": "999",
+                          "weights": [
+                            2,
+                            1,
+                            2,
+                            1,
+                            2,
+                            1,
+                            2,
+                            1,
+                            2,
+                            1,
+                            2,
+                            1,
+                            2,
+                            1,
+                            2,
+                            1,
+                            2,
+                            1,
+                            2
+                          ],
+                          "useCvv": true,
+                          "useExpirationDate": true,
+                          "useCardHolderName": true,
+                          "useBillingAddress": true
+                        },
+                        "stringId": "6",
+                        "template": "bankInvoicePaymentGroup-template",
+                        "requiresDocument": false,
+                        "isCustom": false,
+                        "description": "Payment description",
+                        "requiresAuthentication": false,
+                        "dueDate": "2021-08-04T22:19:04.9948627Z",
+                        "availablePayments": null
+                      }
+                    ],
+                    "payments": [
+                      {
+                        "paymentSystem": 6,
+                        "bin": null,
+                        "accountId": "12",
+                        "tokenId": null,
+                        "installments": 1,
+                        "referenceValue": 65780,
+                        "value": 65780,
+                        "merchantSellerPayments": [
+                          {
+                            "id": "MYSHOP",
+                            "installments": 1,
+                            "referenceValue": 65780,
+                            "value": 65780,
+                            "interestRate": 0,
+                            "installmentValue": 65780
+                          }
+                        ]
+                      }
+                    ],
+                    "giftCards": [],
+                    "giftCardMessages": [],
+                    "availableAccounts": [],
+                    "availableTokens": []
+                  },
+                  "marketingData": null,
+                  "sellers": [
+                    {
+                      "id": "1",
+                      "name": "My Seller",
+                      "logo": "Logo"
+                    }
+                  ],
+                  "clientPreferencesData": {
+                    "locale": "pt-BR",
+                    "optinNewsLetter": null
+                  },
+                  "commercialConditionData": null,
+                  "storePreferencesData": {
+                    "countryCode": "BRA",
+                    "saveUserData": true,
+                    "timeZone": "E. South America Standard Time",
+                    "currencyCode": "BRL",
+                    "currencyLocale": 1046,
+                    "currencySymbol": "R$",
+                    "currencyFormatInfo": {
+                      "currencyDecimalDigits": 2,
+                      "currencyDecimalSeparator": ",",
+                      "currencyGroupSeparator": ".",
+                      "currencyGroupSize": 3,
+                      "startsWithCurrencySymbol": true
+                    }
+                  },
+                  "giftRegistryData": null,
+                  "openTextField": null,
+                  "invoiceData": null,
+                  "customData": null,
+                  "itemMetadata": {
+                    "items": [
+                      {
+                        "id": "2",
+                        "seller": "1",
+                        "name": "Chopp Claro 30L",
+                        "skuName": "Chopp Claro 30L",
+                        "productId": "2",
+                        "refId": "CBC30L",
+                        "ean": null,
+                        "imageUrl": "http://myshop.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000",
+                        "detailUrl": "/chopp-claro-30l/p",
+                        "assemblyOptions": []
+                      }
+                    ]
+                  },
+                  "hooksData": null,
+                  "ratesAndBenefitsData": {
+                    "rateAndBenefitsIdentifiers": [],
+                    "teaser": []
+                  },
+                  "subscriptionData": null,
+                  "itemsOrdination": {
+                    "criteria": "NAME",
+                    "ascending": true
+                  }
+                },
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "orderFormId": {
+                      "type": "string",
+                      "description": "ID of the orderForm corresponding to a specific cart."
+                    },
+                    "salesChannel": {
+                      "type": "string",
+                      "description": "Attribute created by the seller, in their VTEX store configuration."
+                    },
+                    "loggedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether the user is logged into the store."
+                    },
+                    "isCheckedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether order is checked in."
+                    },
+                    "storeId": {
+                      "type": "string",
+                      "description": "ID of the store.",
+                      "nullable": true
+                    },
+                    "allowManualPrice": {
+                      "type": "boolean",
+                      "description": "Permission to modify item price manually."
+                    },
+                    "canEditData": {
+                      "type": "boolean",
+                      "description": "Data can be edited."
+                    },
+                    "userProfileId": {
+                      "type": "string",
+                      "description": "Unique ID associated with the customer profile."
+                    },
+                    "profileProvider": {
+                      "type": "string",
+                      "description": "Profile provider."
+                    },
+                    "availableAccounts": {
+                      "type": "array",
+                      "description": "Available accounts.",
+                      "items": {
+                        "type": "string",
+                        "description": "Account."
+                      }
+                    },
+                    "availableAddresses": {
+                      "type": "array",
+                      "description": "Information on each available address.",
+                      "items": {
+                        "description": "Address information.",
+                        "type": "object",
+                        "properties": {
+                          "addressType": {
+                            "type": "string",
+                            "description": "Address type."
+                          },
+                          "receiverName": {
+                            "type": "string",
+                            "description": "Name of the receiver."
+                          },
+                          "addressId": {
+                            "type": "string",
+                            "description": "Address ID.",
+                            "nullable": true
+                          },
+                          "isDisposable": {
+                            "type": "boolean",
+                            "description": "Indicates whether address is disposable."
+                          },
+                          "city": {
+                            "type": "string",
+                            "description": "City of the address."
+                          },
+                          "state": {
+                            "type": "string",
+                            "description": "State of the address."
+                          },
+                          "country": {
+                            "type": "string",
+                            "description": "Country of the address. ISO three-letter code."
+                          },
+                          "street": {
+                            "type": "string",
+                            "description": "Street of the address."
+                          },
+                          "number": {
+                            "type": "string",
+                            "description": "Number of the address."
+                          },
+                          "neighborhood": {
+                            "type": "string",
+                            "description": "Neighborhood of the address."
+                          },
+                          "complement": {
+                            "description": "Complement to the shipping address, in case it applies.",
+                            "type": "string",
+                            "nullable": true
+                          },
+                          "reference": {
+                            "type": "string",
+                            "description": "Reference that may help in the location of the address.",
+                            "nullable": true
+                          },
+                          "geoCoordinates": {
+                            "type": "array",
+                            "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                            "items": {
+                              "type": "number",
+                              "description": "Geocoordinates."
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "userType": {
+                      "type": "string",
+                      "description": "User type.",
+                      "nullable": true
+                    },
+                    "ignoreProfileData": {
+                      "type": "boolean",
+                      "description": "Ignore customer profile data."
+                    },
+                    "value": {
+                      "type": "integer",
+                      "description": "Total value of the order without separating cents. For example, $24.99 is represented as `2499`."
+                    },
+                    "messages": {
+                      "type": "array",
+                      "description": "Array containing an object for each message generated by our servers while processing the request.",
+                      "items": {
+                        "type": "string",
+                        "description": "Message."
+                      }
+                    },
+                    "items": {
+                      "type": "array",
+                      "description": "Information on each item in the order.",
+                      "items": {
+                        "description": "Item information.",
+                        "type": "object",
+                        "properties": {
+                          "uniqueId": {
+                            "type": "string",
+                            "description": "Unique ID."
+                          },
+                          "id": {
+                            "type": "string",
+                            "description": "ID of the item."
+                          },
+                          "productId": {
+                            "type": "string",
+                            "description": "Product ID."
+                          },
+                          "productRefId": {
+                            "type": "string",
+                            "description": "Product Ref ID."
+                          },
+                          "refId": {
+                            "type": "string",
+                            "description": "Ref ID."
+                          },
+                          "ean": {
+                            "type": "string",
+                            "description": "European Article Number.",
+                            "nullable": true
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Product name."
+                          },
+                          "skuName": {
+                            "type": "string",
+                            "description": "SKU name."
+                          },
+                          "modalType": {
+                            "type": "string",
+                            "description": "Modal type.",
+                            "nullable": true
+                          },
+                          "parentItemIndex": {
+                            "type": "integer",
+                            "description": "Parent item index.",
+                            "nullable": true
+                          },
+                          "parentAssemblyBinding": {
+                            "type": "string",
+                            "description": "Parent assembly binding.",
+                            "nullable": true
+                          },
+                          "priceValidUntil": {
+                            "type": "string",
+                            "description": "Price expiration date and time."
+                          },
+                          "tax": {
+                            "type": "integer",
+                            "description": "Tax value in cents."
+                          },
+                          "taxCode": {
+                            "type": "string",
+                            "description": "A unique identifier code assigned to a tax within the VTEX Admin."
+                          },
+                          "price": {
+                            "type": "integer",
+                            "description": "Price in cents."
+                          },
+                          "listPrice": {
+                            "type": "integer",
+                            "description": "List price in cents."
+                          },
+                          "manualPrice": {
+                            "type": "integer",
+                            "description": "Manual price in cents.",
+                            "nullable": true
+                          },
+                          "manualPriceAppliedBy": {
+                            "type": "string",
+                            "description": "User that applied the manual price, if that is the case.",
+                            "nullable": true
+                          },
+                          "sellingPrice": {
+                            "type": "integer",
+                            "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
+                          },
+                          "rewardValue": {
+                            "type": "integer",
+                            "description": "Reward value in cents."
+                          },
+                          "isGift": {
+                            "type": "boolean",
+                            "description": "Indicates whether item is a gift."
+                          },
+                          "additionalInfo": {
+                            "type": "object",
+                            "description": "Additional information.",
+                            "properties": {
+                              "dimension": {
+                                "type": "string",
+                                "description": "Dimension.",
+                                "nullable": true
+                              },
+                              "brandName": {
+                                "type": "string",
+                                "description": "Brand name."
+                              },
+                              "brandId": {
+                                "type": "string",
+                                "description": "Brand ID."
+                              },
+                              "offeringInfo": {
+                                "type": "string",
+                                "description": "Offering information.",
+                                "nullable": true
+                              },
+                              "offeringType": {
+                                "type": "string",
+                                "description": "Offering type.",
+                                "nullable": true
+                              },
+                              "offeringTypeId": {
+                                "type": "string",
+                                "description": "Offering type ID.",
+                                "nullable": true
+                              }
+                            }
+                          },
+                          "preSaleDate": {
+                            "type": "string",
+                            "description": "Presale date.",
+                            "nullable": true
+                          },
+                          "productCategoryIds": {
+                            "type": "string",
+                            "description": "Product category IDs."
+                          },
+                          "productCategories": {
+                            "type": "object",
+                            "description": "Object, where each field is an ID from `productCategoryIds`.",
+                            "properties": {
+                              "{ID}": {
+                                "type": "string",
+                                "description": "Product category corresponding to the ID in the field key."
+                              }
+                            }
+                          },
+                          "quantity": {
+                            "type": "integer",
+                            "description": "Quantity."
+                          },
+                          "seller": {
+                            "type": "string",
+                            "description": "Seller."
+                          },
+                          "sellerChain": {
+                            "type": "array",
+                            "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
+                            "items": {
+                              "type": "string",
+                              "description": "Seller."
+                            }
+                          },
+                          "imageUrl": {
+                            "type": "string",
+                            "description": "Image URL."
+                          },
+                          "detailUrl": {
+                            "type": "string",
+                            "description": "Detail URL."
+                          },
+                          "bundleItems": {
+                            "type": "array",
+                            "description": "Information on services sold along with the SKU. Example: a gift package.",
+                            "items": {
+                              "description": "Service information.",
+                              "type": "object",
+                              "properties": {
+                                "type": {
+                                  "type": "string",
+                                  "description": "Service type."
+                                },
+                                "id": {
+                                  "type": "integer",
+                                  "description": "Service identifier."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Service name."
+                                },
+                                "price": {
+                                  "type": "integer",
+                                  "description": "Service price in cents."
+                                }
+                              }
+                            }
+                          },
+                          "attachments": {
+                            "type": "array",
+                            "description": "Array containing information on attachments.",
+                            "items": {
+                              "type": "string",
+                              "description": "Attachment."
+                            }
+                          },
+                          "priceTags": {
+                            "type": "array",
+                            "description": "Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.",
+                            "items": {
+                              "description": "Price tag information.",
+                              "type": "object",
+                              "properties": {
+                                "identifier": {
+                                  "type": "string",
+                                  "description": "Promotion unique identifier.",
+                                  "nullable": true
+                                },
+                                "isPercentual": {
+                                  "type": "boolean",
+                                  "description": "Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\r\n- `type` indicates whether the tag refers to a discount or tax.\r\n- `where` specifies the context, either price or shipping.\r\n- `identifier` is the promotion ID.\r\n- `calculationId` is a hash that may vary with each price calculation."
+                                },
+                                "rawValue": {
+                                  "type": "number",
+                                  "description": "Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations."
+                                },
+                                "value": {
+                                  "type": "integer",
+                                  "description": "Price tag value representing either a promotion (value decrease) or a tax (value increase)."
+                                }
+                              }
+                            }
+                          },
+                          "availability": {
+                            "type": "string",
+                            "description": "Availability."
+                          },
+                          "measurementUnit": {
+                            "type": "string",
+                            "description": "Measurement unit."
+                          },
+                          "unitMultiplier": {
+                            "type": "integer",
+                            "description": "Unit multiplier."
+                          },
+                          "manufacturerCode": {
+                            "type": "string",
+                            "description": "Manufacturer code.",
+                            "nullable": true
+                          },
+                          "priceDefinition": {
+                            "type": "object",
+                            "description": "Price information for all units of a specific item.",
+                            "properties": {
+                              "calculatedSellingPrice": {
+                                "type": "integer",
+                                "description": "Item's calculated unitary selling price in cents."
+                              },
+                              "total": {
+                                "type": "integer",
+                                "description": "Total value for all units of the item in cents."
+                              },
+                              "sellingPrices": {
+                                "type": "array",
+                                "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
+                                "items": {
+                                  "description": "Rounding information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value in cents for that specific rounding."
+                                    },
+                                    "quantity": {
+                                      "type": "integer",
+                                      "description": "Rounding quantity, meaning how many items are rounded to this value."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "selectableGifts": {
+                      "type": "array",
+                      "description": "Array containing the data of the item selected as a gift.",
+                      "items": {
+                        "type": "string",
+                        "description": "Gift."
+                      }
+                    },
+                    "totalizers": {
+                      "type": "array",
+                      "description": "Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).",
+                      "items": {
+                        "type": "object",
+                        "description": "Totalizer of purchases."
+                      }
+                    },
+                    "shippingData": {
+                      "type": "object",
+                      "description": "Shipping information pertinent to the order.",
+                      "nullable": true,
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Address information.",
+                          "nullable": true,
+                          "properties": {
+                            "addressType": {
+                              "type": "string",
+                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                            },
+                            "receiverName": {
+                              "type": "string",
+                              "description": "Name of the person who is going to receive the order."
+                            },
+                            "addressId": {
+                              "type": "string",
+                              "description": "Address ID.",
+                              "nullable": true
+                            },
+                            "isDisposable": {
+                              "type": "boolean",
+                              "description": "Indicates whether address is disposable."
+                            },
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City of the shipping address."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State of the shipping address."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Three letter ISO code of the country of the shipping address."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street of the shipping address."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Number of the building, house or apartment in the shipping address."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood of the shipping address."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Complement to the shipping address, in case it applies.",
+                              "nullable": true
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                              "nullable": true
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                              "items": {
+                                "type": "number",
+                                "description": "Geocoordinates."
+                              }
+                            }
+                          }
+                        },
+                        "logisticsInfo": {
+                          "type": "array",
+                          "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.",
+                          "items": {
+                            "description": "Logistics information.",
+                            "type": "object",
+                            "properties": {
+                              "itemIndex": {
+                                "type": "integer",
+                                "description": "Index corresponding to the position of the object in the `items` array."
+                              },
+                              "selectedSla": {
+                                "type": "string",
+                                "description": "SLA selected by the customer.",
+                                "nullable": true
+                              },
+                              "selectedDeliveryChannel": {
+                                "type": "string",
+                                "description": "Delivery channel selected by the customer.",
+                                "nullable": true
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "slas": {
+                                "type": "array",
+                                "description": "Information on available SLAs.",
+                                "items": {
+                                  "description": "SLA information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "SLA ID."
+                                    },
+                                    "deliveryChannel": {
+                                      "type": "string",
+                                      "description": "Delivery channel."
+                                    },
+                                    "name": {
+                                      "type": "string",
+                                      "description": "SLA name."
+                                    },
+                                    "deliveryIds": {
+                                      "type": "array",
+                                      "description": "Information on each delivery ID.",
+                                      "items": {
+                                        "description": "Delivery ID information.",
+                                        "type": "object",
+                                        "properties": {
+                                          "courierId": {
+                                            "type": "string",
+                                            "description": "Courier ID."
+                                          },
+                                          "warehouseId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "dockId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "courierName": {
+                                            "type": "string",
+                                            "description": "Courier name."
+                                          },
+                                          "quantity": {
+                                            "type": "integer",
+                                            "description": "Quantity."
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "attachmentOfferings": {
+                                      "type": "array",
+                                      "description": "List of attachments details.",
+                                      "nullable": true,
+                                      "items": {
+                                        "description": "Attachment details.",
+                                        "type": "object",
+                                        "required": [
+                                          "name",
+                                          "required",
+                                          "schema"
+                                        ],
+                                        "properties": {
+                                          "name": {
+                                            "type": "string",
+                                            "description": "Name of the attachment.",
+                                            "nullable": true
+                                          },
+                                          "required": {
+                                            "type": "boolean",
+                                            "description": "Defines if the attachment is required (`true`) or not (`false`).",
+                                            "nullable": true
+                                          },
+                                          "schema": {
+                                            "type": "object",
+                                            "description": "Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).",
+                                            "nullable": true
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "shippingEstimate": {
+                                      "type": "string",
+                                      "description": "Shipping estimate. For instance, \"three business days\" will be represented as `3bd`."
+                                    },
+                                    "shippingEstimateDate": {
+                                      "type": "string",
+                                      "description": "When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.",
+                                      "nullable": true
+                                    },
+                                    "useIndividualShippingEstimates": {
+                                      "type": "boolean",
+                                      "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`."
+                                    },
+                                    "lockTTL": {
+                                      "type": "string",
+                                      "description": "Estimate date of delivery.",
+                                      "nullable": true
+                                    },
+                                    "price": {
+                                      "type": "integer",
+                                      "description": "Price in cents."
+                                    },
+                                    "listPrice": {
+                                      "type": "integer",
+                                      "description": "List price in cents."
+                                    },
+                                    "tax": {
+                                      "type": "integer",
+                                      "description": "Tax in cents."
+                                    },
+                                    "pickupStoreInfo": {
+                                      "type": "object",
+                                      "description": "Information on the pickup store.",
+                                      "properties": {
+                                        "isPickupStore": {
+                                          "type": "boolean",
+                                          "description": "Indicates whether it is the pickup store."
+                                        },
+                                        "friendlyName": {
+                                          "type": "string",
+                                          "description": "Friendly name.",
+                                          "nullable": true
+                                        },
+                                        "address": {
+                                          "type": "object",
+                                          "description": "Address information.",
+                                          "nullable": true,
+                                          "properties": {
+                                            "addressType": {
+                                              "type": "string",
+                                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                                            },
+                                            "postalCode": {
+                                              "type": "string",
+                                              "description": "Postal code."
+                                            },
+                                            "city": {
+                                              "type": "string",
+                                              "description": "City of the shipping address."
+                                            },
+                                            "state": {
+                                              "type": "string",
+                                              "description": "State of the shipping address."
+                                            },
+                                            "country": {
+                                              "type": "string",
+                                              "description": "Three letter ISO code of the country of the shipping address."
+                                            },
+                                            "street": {
+                                              "type": "string",
+                                              "description": "Street of the shipping address."
+                                            },
+                                            "number": {
+                                              "type": "string",
+                                              "description": "Number of the building, house or apartment in the shipping address."
+                                            },
+                                            "neighborhood": {
+                                              "type": "string",
+                                              "description": "Neighborhood of the shipping address."
+                                            },
+                                            "complement": {
+                                              "type": "string",
+                                              "description": "Complement to the shipping address, in case it applies.",
+                                              "nullable": true
+                                            },
+                                            "reference": {
+                                              "type": "string",
+                                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                              "nullable": true
+                                            },
+                                            "geoCoordinates": {
+                                              "type": "array",
+                                              "description": "Array with two strings that repesent geocoordinates: first latitude, then longitude.",
+                                              "items": {
+                                                "type": "number",
+                                                "description": "Geocoordinates."
+                                              }
+                                            }
+                                          }
+                                        },
+                                        "additionalInfo": {
+                                          "type": "string",
+                                          "description": "Additional information.",
+                                          "nullable": true
+                                        },
+                                        "dockId": {
+                                          "type": "string",
+                                          "description": "Corresponding dock ID.",
+                                          "nullable": true
+                                        }
+                                      }
+                                    },
+                                    "pickupPointId": {
+                                      "type": "string",
+                                      "description": "Pickup point ID.",
+                                      "nullable": true
+                                    },
+                                    "pickupDistance": {
+                                      "type": "integer",
+                                      "description": "Pickup point distance."
+                                    },
+                                    "polygonName": {
+                                      "type": "string",
+                                      "description": "Polygon name.",
+                                      "nullable": true
+                                    },
+                                    "transitTime": {
+                                      "type": "string",
+                                      "description": "Transit time. For instance, \"three business days\" is represented as `3bd`."
+                                    }
+                                  }
+                                }
+                              },
+                              "shipsTo": {
+                                "type": "array",
+                                "description": "List of countries that the item may be shipped to.",
+                                "items": {
+                                  "type": "string",
+                                  "description": "Three letter country code."
+                                }
+                              },
+                              "itemId": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "deliveryChannels": {
+                                "type": "array",
+                                "description": "List of available delivery channels.",
+                                "items": {
+                                  "description": "Delivery channel information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "Delivery channel ID."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "selectedAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the selected addresses for the order.",
+                          "items": {
+                            "description": "Selected address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "availableAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the available addresses for the order.",
+                          "items": {
+                            "description": "Available address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "clientProfileData": {
+                      "type": "object",
+                      "description": "Customer's profile information.",
+                      "nullable": true,
+                      "properties": {
+                        "email": {
+                          "type": "string",
+                          "description": "Email address.",
+                          "nullable": true
+                        },
+                        "firstName": {
+                          "type": "string",
+                          "description": "First name.",
+                          "nullable": true
+                        },
+                        "lastName": {
+                          "type": "string",
+                          "description": "Last name."
+                        },
+                        "documentType": {
+                          "type": "string",
+                          "description": "Type of the document informed by the customer."
+                        },
+                        "document": {
+                          "type": "string",
+                          "description": "Document informed by the customer."
+                        },
+                        "phone": {
+                          "type": "string",
+                          "description": "Phone number."
+                        },
+                        "corporateName": {
+                          "type": "string",
+                          "description": "Company name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "tradeName": {
+                          "type": "string",
+                          "description": "Trade name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporateDocument": {
+                          "type": "string",
+                          "description": "Corporate document, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "stateInscription": {
+                          "type": "string",
+                          "description": "State inscription, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporatePhone": {
+                          "type": "string",
+                          "description": "Corporate phone number, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "isCorporate": {
+                          "type": "boolean",
+                          "description": "Indicates whether the customer is a legal entity."
+                        },
+                        "profileCompleteOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile is complete on loading."
+                        },
+                        "profileErrorOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile presents error on loading.",
+                          "nullable": true
+                        },
+                        "customerClass": {
+                          "type": "string",
+                          "description": "Customer class.",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "paymentData": {
+                      "type": "object",
+                      "description": "Information on the order's payment.",
+                      "properties": {
+                        "giftCards": {
+                          "type": "array",
+                          "description": "Gift card information, if it applies to the order.",
+                          "items": {
+                            "description": "Gift card information.",
+                            "type": "object",
+                            "properties": {
+                              "redemptionCode": {
+                                "type": "string",
+                                "description": "Gift card redemption code."
+                              },
+                              "value": {
+                                "type": "integer",
+                                "description": "Gift card value in cents."
+                              },
+                              "balance": {
+                                "type": "integer",
+                                "description": "Gift card balance in cents."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Gift card name."
+                              },
+                              "id": {
+                                "type": "string",
+                                "description": "Gift card ID."
+                              },
+                              "inUse": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is in use."
+                              },
+                              "isSpecialCard": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is special."
+                              }
+                            }
+                          }
+                        },
+                        "transactions": {
+                          "type": "array",
+                          "description": "Information on each transaction pertinent to the order.",
+                          "items": {
+                            "description": "Transaction information.",
+                            "nullable": true,
+                            "type": "object",
+                            "properties": {
+                              "isActive": {
+                                "type": "boolean",
+                                "description": "Indicates whether transaction is active."
+                              },
+                              "transactionId": {
+                                "type": "string",
+                                "description": "Transaction ID."
+                              },
+                              "merchantName": {
+                                "type": "string",
+                                "description": "Merchant name."
+                              },
+                              "payments": {
+                                "type": "array",
+                                "description": "Information on each payment.",
+                                "items": {
+                                  "description": "Payment information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "accountId": {
+                                      "type": "string",
+                                      "description": "Account ID."
+                                    },
+                                    "bin": {
+                                      "type": "string",
+                                      "description": "Bin.",
+                                      "nullable": true
+                                    },
+                                    "installments": {
+                                      "type": "integer",
+                                      "description": "Number of installments."
+                                    },
+                                    "paymentSystem": {
+                                      "type": "string",
+                                      "description": "Payment system."
+                                    },
+                                    "referenceValue": {
+                                      "type": "integer",
+                                      "description": "Reference value for calculating interest rates, in case it applies. Displayed in cents."
+                                    },
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value including interest, in case it applies. Displayed in cents."
+                                    }
+                                  }
+                                }
+                              },
+                              "sharedTransaction": {
+                                "type": "boolean",
+                                "description": "Indicates whather transaction is shared."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "marketingData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Object containing promotion data such as coupon tracking information and internal or external UTMs.",
+                      "properties": {
+                        "coupon": {
+                          "type": "string",
+                          "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.",
+                          "example": "free-shipping"
+                        },
+                        "utmSource": {
+                          "type": "string",
+                          "description": "UTM source.",
+                          "example": "Facebook"
+                        },
+                        "utmMedium": {
+                          "type": "string",
+                          "description": "UTM medium.",
+                          "example": "CPC"
+                        },
+                        "utmCampaign": {
+                          "type": "string",
+                          "description": "UTM campaign.",
+                          "example": "Black friday"
+                        },
+                        "utmiPage": {
+                          "type": "string",
+                          "description": "utmi_page (internal utm).",
+                          "example": "utmi_page-example",
+                          "nullable": true
+                        },
+                        "utmiPart": {
+                          "type": "string",
+                          "description": "utmi_part (internal utm).",
+                          "example": "utmi_part-example",
+                          "nullable": true
+                        },
+                        "utmiCampaign": {
+                          "type": "string",
+                          "description": "utmi_campaign (internal utm).",
+                          "example": "utmi_campaign-example",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "sellers": {
+                      "type": "array",
+                      "description": "Information on each seller.",
+                      "items": {
+                        "description": "Seller information.",
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "Seller ID."
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Seller name."
+                          },
+                          "logo": {
+                            "type": "string",
+                            "description": "Seller logo.",
+                            "nullable": true
+                          }
+                        }
+                      }
+                    },
+                    "clientPreferencesData": {
+                      "type": "object",
+                      "description": "Object containing preferences from the client who placed the order.",
+                      "properties": {
+                        "locale": {
+                          "type": "string",
+                          "description": "Client's locale. Examples: `pt-BR` and `en-US`."
+                        },
+                        "optinNewsLetter": {
+                          "type": "boolean",
+                          "description": "`true` if the client opted to receive newsletter from the store.",
+                          "example": false,
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "commercialConditionData": {
+                      "type": "object",
+                      "description": "Object containing commercial condition information.",
+                      "nullable": true
+                    },
+                    "storePreferencesData": {
+                      "type": "object",
+                      "description": "Object containing data from the store's configuration (stored in VTEX's License Manager)."
+                    },
+                    "giftRegistryData": {
+                      "type": "object",
+                      "description": "Gift registry list information.",
+                      "nullable": true
+                    },
+                    "openTextField": {
+                      "type": "string",
+                      "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).",
+                      "example": "open-text-example",
+                      "nullable": true
+                    },
+                    "invoiceData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Invoice data including billing address.",
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Billing address.",
+                          "properties": {
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City name."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State name."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Country."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street name."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Street number."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Address complement."
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Reference for location."
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Geographic coordinates (latitude, longitude).",
+                              "items": {
+                                "type": "number"
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "customData": {
+                      "type": "object",
+                      "description": "Customer additional information.",
+                      "nullable": true
+                    },
+                    "itemMetadata": {
+                      "type": "object",
+                      "description": "Item metadata.",
+                      "properties": {
+                        "items": {
+                          "type": "array",
+                          "description": "List of objects containing metadata on each item in the order.",
+                          "items": {
+                            "description": "Item metadata.",
+                            "type": "object",
+                            "properties": {
+                              "id": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "seller": {
+                                "type": "string",
+                                "description": "Seller."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Product name."
+                              },
+                              "skuName": {
+                                "type": "string",
+                                "description": "SKU name."
+                              },
+                              "productId": {
+                                "type": "string",
+                                "description": "Product ID."
+                              },
+                              "refId": {
+                                "type": "string",
+                                "description": "Ref ID."
+                              },
+                              "ean": {
+                                "type": "string",
+                                "description": "European Article Number.",
+                                "nullable": true
+                              },
+                              "imageUrl": {
+                                "type": "string",
+                                "description": "Image URL."
+                              },
+                              "detailUrl": {
+                                "type": "string",
+                                "description": "Detail URL."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "hooksData": {
+                      "type": "object",
+                      "description": "Hooks information.",
+                      "nullable": true
+                    },
+                    "ratesAndBenefitsData": {
+                      "type": "object",
+                      "description": "Information on rates and benefits that apply to the order.",
+                      "properties": {
+                        "rateAndBenefitsIdentifiers": {
+                          "type": "array",
+                          "description": "List with rates and benefits identifiers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit identifier."
+                          }
+                        },
+                        "teaser": {
+                          "type": "array",
+                          "description": "List with rates and benefits teasers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit teaser."
+                          }
+                        }
+                      }
+                    },
+                    "subscriptionData": {
+                      "type": "object",
+                      "description": "Subscription information.",
+                      "nullable": true
+                    },
+                    "itemsOrdination": {
+                      "type": "object",
+                      "description": "Object containing information about the ordering of items within the `orderForm`.",
+                      "properties": {
+                        "criteria": {
+                          "type": "string",
+                          "description": "Criteria adopted to order the items in the list."
+                        },
+                        "ascending": {
+                          "type": "boolean",
+                          "description": "Indicates whether the ordering is ascending."
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/api/checkout/pub/orderForm/{orderFormId}/attachments/merchantContextData": {
+      "post": {
+        "tags": [
+          "Cart attachments"
+        ],
+        "summary": "Add merchant context data",
+        "description": "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.\r\n\r\nThe [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.\n\r\n\r> This request has a time out of 12 seconds.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "AddMerchantContextData",
+        "security": [],
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "orderFormId",
+            "in": "path",
+            "description": "ID of the orderForm that will receive the relevant information added by the merchant.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "29154e27383145cc8ce1f7a1df0d99c4"
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "required": [
+                  "salesAssociateData"
+                ],
+                "properties": {
+                  "salesAssociateData": {
+                    "type": "object",
+                    "description": "Sales Associate information.",
+                    "properties": {
+                      "salesAssociateId": {
+                        "type": "string",
+                        "description": "Sales Associate (Seller) identification code. All information should be registered by the merchant. Maximum of 100 characters.",
+                        "example": "seller123"
+                      }
+                    }
+                  }
+                }
+              },
+              "example": {
+                "salesAssociateData": {
+                  "salesAssociateId": "seller123"
+                }
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "salesAssociateId": {
+                      "type": "string",
+                      "description": "Sales Associate (Seller) identification code."
+                    }
+                  }
+                },
+                "example": {
+                  "salesAssociateData": {
+                    "salesAssociateId": "seller123"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/api/checkout/pub/orderForm/{orderFormId}/attachments/invoiceData": {
+      "post": {
+        "tags": [
+          "Cart attachments"
+        ],
+        "summary": "Attach invoice data",
+        "description": "Attaches invoice data to the cart.\r\n\r\nThe [`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.\n\r\n\r> This request has a time out of 12 seconds.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "parameters": [
+          {
+            "name": "orderFormId",
+            "in": "path",
+            "description": "ID of the `orderForm` that will receive the invoice data.",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "example": "29154e27383145cc8ce1f7a1df0d99c4"
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "address": {
+                    "type": "object",
+                    "properties": {
+                      "addressType": {
+                        "type": "string",
+                        "description": " Type of address, as `residential` or `business`."
+                      },
+                      "city": {
+                        "type": "string",
+                        "description": "Address city name."
+                      },
+                      "complement": {
+                        "type": "string",
+                        "description": "Address complement, such as the apartment number."
+                      },
+                      "country": {
+                        "type": "string",
+                        "description": "Address country name."
+                      },
+                      "geoCoordinates": {
+                        "type": "array",
+                        "description": "List containing address geocoordinates, first longitude, then latitude.",
+                        "items": {
+                          "type": "number",
+                          "description": "Geocoordinates of the address, longitude and latitude."
+                        }
+                      },
+                      "neighborhood": {
+                        "type": "string",
+                        "description": "Address neighborhood name."
+                      },
+                      "number": {
+                        "type": "string",
+                        "description": "Address number."
+                      },
+                      "postalCode": {
+                        "type": "string",
+                        "description": "Address postal code."
+                      },
+                      "reference": {
+                        "type": "string",
+                        "description": "Reference that may help in the location of the address, as a landmark."
+                      },
+                      "state": {
+                        "type": "string",
+                        "description": "Address state name."
+                      },
+                      "street": {
+                        "type": "string",
+                        "description": "Address street name."
+                      }
+                    },
+                    "required": [
+                      "postalCode",
+                      "geoCoordinates"
+                    ]
+                  }
+                },
+                "required": [
+                  "address"
+                ]
+              },
+              "example": {
+                "address": {
+                  "addressType": "residential",
+                  "city": "New York",
+                  "complement": "101",
+                  "country": "USA",
+                  "geoCoordinates": [
+                    40.7986877,
+                    -73.9534529
+                  ],
+                  "neighborhood": "Manhattan",
+                  "number": "52",
+                  "postalCode": "10019",
+                  "reference": "Between the Upper West Side and Upper East Side",
+                  "state": "NY",
+                  "street": "North 110th Street"
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "orderFormId": {
+                      "type": "string",
+                      "description": "ID of the orderForm corresponding to a specific cart."
+                    },
+                    "salesChannel": {
+                      "type": "string",
+                      "description": "Attribute created by the seller, in their VTEX store configuration."
+                    },
+                    "loggedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether the user is logged into the store."
+                    },
+                    "isCheckedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether order is checked in."
+                    },
+                    "storeId": {
+                      "type": "string",
+                      "description": "ID of the store.",
+                      "nullable": true
+                    },
+                    "allowManualPrice": {
+                      "type": "boolean",
+                      "description": "Permission to modify item price manually."
+                    },
+                    "canEditData": {
+                      "type": "boolean",
+                      "description": "Data can be edited."
+                    },
+                    "userProfileId": {
+                      "type": "string",
+                      "description": "Unique ID associated with the customer profile."
+                    },
+                    "profileProvider": {
+                      "type": "string",
+                      "description": "Profile provider."
+                    },
+                    "availableAccounts": {
+                      "type": "array",
+                      "description": "Available accounts.",
+                      "items": {
+                        "type": "string",
+                        "description": "Account."
+                      }
+                    },
+                    "availableAddresses": {
+                      "type": "array",
+                      "description": "Information on each available address.",
+                      "items": {
+                        "description": "Address information.",
+                        "type": "object",
+                        "properties": {
+                          "addressType": {
+                            "type": "string",
+                            "description": "Address type."
+                          },
+                          "receiverName": {
+                            "type": "string",
+                            "description": "Name of the receiver."
+                          },
+                          "addressId": {
+                            "type": "string",
+                            "description": "Address ID.",
+                            "nullable": true
+                          },
+                          "isDisposable": {
+                            "type": "boolean",
+                            "description": "Indicates whether address is disposable."
+                          },
+                          "city": {
+                            "type": "string",
+                            "description": "City of the address."
+                          },
+                          "state": {
+                            "type": "string",
+                            "description": "State of the address."
+                          },
+                          "country": {
+                            "type": "string",
+                            "description": "Country of the address. ISO three-letter code."
+                          },
+                          "street": {
+                            "type": "string",
+                            "description": "Street of the address."
+                          },
+                          "number": {
+                            "type": "string",
+                            "description": "Number of the address."
+                          },
+                          "neighborhood": {
+                            "type": "string",
+                            "description": "Neighborhood of the address."
+                          },
+                          "complement": {
+                            "description": "Complement to the shipping address, in case it applies.",
+                            "type": "string",
+                            "nullable": true
+                          },
+                          "reference": {
+                            "type": "string",
+                            "description": "Reference that may help in the location of the address.",
+                            "nullable": true
+                          },
+                          "geoCoordinates": {
+                            "type": "array",
+                            "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                            "items": {
+                              "type": "number",
+                              "description": "Geocoordinates."
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "userType": {
+                      "type": "string",
+                      "description": "User type.",
+                      "nullable": true
+                    },
+                    "ignoreProfileData": {
+                      "type": "boolean",
+                      "description": "Ignore customer profile data."
+                    },
+                    "value": {
+                      "type": "integer",
+                      "description": "Total value of the order without separating cents. For example, $24.99 is represented as `2499`."
+                    },
+                    "messages": {
+                      "type": "array",
+                      "description": "Array containing an object for each message generated by our servers while processing the request.",
+                      "items": {
+                        "type": "string",
+                        "description": "Message."
+                      }
+                    },
+                    "items": {
+                      "type": "array",
+                      "description": "Information on each item in the order.",
+                      "items": {
+                        "description": "Item information.",
+                        "type": "object",
+                        "properties": {
+                          "uniqueId": {
+                            "type": "string",
+                            "description": "Unique ID."
+                          },
+                          "id": {
+                            "type": "string",
+                            "description": "ID of the item."
+                          },
+                          "productId": {
+                            "type": "string",
+                            "description": "Product ID."
+                          },
+                          "productRefId": {
+                            "type": "string",
+                            "description": "Product Ref ID."
+                          },
+                          "refId": {
+                            "type": "string",
+                            "description": "Ref ID."
+                          },
+                          "ean": {
+                            "type": "string",
+                            "description": "European Article Number.",
+                            "nullable": true
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Product name."
+                          },
+                          "skuName": {
+                            "type": "string",
+                            "description": "SKU name."
+                          },
+                          "modalType": {
+                            "type": "string",
+                            "description": "Modal type.",
+                            "nullable": true
+                          },
+                          "parentItemIndex": {
+                            "type": "integer",
+                            "description": "Parent item index.",
+                            "nullable": true
+                          },
+                          "parentAssemblyBinding": {
+                            "type": "string",
+                            "description": "Parent assembly binding.",
+                            "nullable": true
+                          },
+                          "priceValidUntil": {
+                            "type": "string",
+                            "description": "Price expiration date and time."
+                          },
+                          "tax": {
+                            "type": "integer",
+                            "description": "Tax value in cents."
+                          },
+                          "taxCode": {
+                            "type": "string",
+                            "description": "A unique identifier code assigned to a tax within the VTEX Admin."
+                          },
+                          "price": {
+                            "type": "integer",
+                            "description": "Price in cents."
+                          },
+                          "listPrice": {
+                            "type": "integer",
+                            "description": "List price in cents."
+                          },
+                          "manualPrice": {
+                            "type": "integer",
+                            "description": "Manual price in cents.",
+                            "nullable": true
+                          },
+                          "manualPriceAppliedBy": {
+                            "type": "string",
+                            "description": "User that applied the manual price, if that is the case.",
+                            "nullable": true
+                          },
+                          "sellingPrice": {
+                            "type": "integer",
+                            "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
+                          },
+                          "rewardValue": {
+                            "type": "integer",
+                            "description": "Reward value in cents."
+                          },
+                          "isGift": {
+                            "type": "boolean",
+                            "description": "Indicates whether item is a gift."
+                          },
+                          "additionalInfo": {
+                            "type": "object",
+                            "description": "Additional information.",
+                            "properties": {
+                              "dimension": {
+                                "type": "string",
+                                "description": "Dimension.",
+                                "nullable": true
+                              },
+                              "brandName": {
+                                "type": "string",
+                                "description": "Brand name."
+                              },
+                              "brandId": {
+                                "type": "string",
+                                "description": "Brand ID."
+                              },
+                              "offeringInfo": {
+                                "type": "string",
+                                "description": "Offering information.",
+                                "nullable": true
+                              },
+                              "offeringType": {
+                                "type": "string",
+                                "description": "Offering type.",
+                                "nullable": true
+                              },
+                              "offeringTypeId": {
+                                "type": "string",
+                                "description": "Offering type ID.",
+                                "nullable": true
+                              }
+                            }
+                          },
+                          "preSaleDate": {
+                            "type": "string",
+                            "description": "Presale date.",
+                            "nullable": true
+                          },
+                          "productCategoryIds": {
+                            "type": "string",
+                            "description": "Product category IDs."
+                          },
+                          "productCategories": {
+                            "type": "object",
+                            "description": "Object, where each field is an ID from `productCategoryIds`.",
+                            "properties": {
+                              "{ID}": {
+                                "type": "string",
+                                "description": "Product category corresponding to the ID in the field key."
+                              }
+                            }
+                          },
+                          "quantity": {
+                            "type": "integer",
+                            "description": "Quantity."
+                          },
+                          "seller": {
+                            "type": "string",
+                            "description": "Seller."
+                          },
+                          "sellerChain": {
+                            "type": "array",
+                            "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
+                            "items": {
+                              "type": "string",
+                              "description": "Seller."
+                            }
+                          },
+                          "imageUrl": {
+                            "type": "string",
+                            "description": "Image URL."
+                          },
+                          "detailUrl": {
+                            "type": "string",
+                            "description": "Detail URL."
+                          },
+                          "bundleItems": {
+                            "type": "array",
+                            "description": "Information on services sold along with the SKU. Example: a gift package.",
+                            "items": {
+                              "description": "Service information.",
+                              "type": "object",
+                              "properties": {
+                                "type": {
+                                  "type": "string",
+                                  "description": "Service type."
+                                },
+                                "id": {
+                                  "type": "integer",
+                                  "description": "Service identifier."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Service name."
+                                },
+                                "price": {
+                                  "type": "integer",
+                                  "description": "Service price in cents."
+                                }
+                              }
+                            }
+                          },
+                          "attachments": {
+                            "type": "array",
+                            "description": "Array containing information on attachments.",
+                            "items": {
+                              "type": "string",
+                              "description": "Attachment."
+                            }
+                          },
+                          "priceTags": {
+                            "type": "array",
+                            "description": "Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.",
+                            "items": {
+                              "description": "Price tag information.",
+                              "type": "object",
+                              "properties": {
+                                "identifier": {
+                                  "type": "string",
+                                  "description": "Promotion unique identifier.",
+                                  "nullable": true
+                                },
+                                "isPercentual": {
+                                  "type": "boolean",
+                                  "description": "Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\r\n- `type` indicates whether the tag refers to a discount or tax.\r\n- `where` specifies the context, either price or shipping.\r\n- `identifier` is the promotion ID.\r\n- `calculationId` is a hash that may vary with each price calculation."
+                                },
+                                "rawValue": {
+                                  "type": "number",
+                                  "description": "Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations."
+                                },
+                                "value": {
+                                  "type": "integer",
+                                  "description": "Price tag value representing either a promotion (value decrease) or a tax (value increase)."
+                                }
+                              }
+                            }
+                          },
+                          "availability": {
+                            "type": "string",
+                            "description": "Availability."
+                          },
+                          "measurementUnit": {
+                            "type": "string",
+                            "description": "Measurement unit."
+                          },
+                          "unitMultiplier": {
+                            "type": "integer",
+                            "description": "Unit multiplier."
+                          },
+                          "manufacturerCode": {
+                            "type": "string",
+                            "description": "Manufacturer code.",
+                            "nullable": true
+                          },
+                          "priceDefinition": {
+                            "type": "object",
+                            "description": "Price information for all units of a specific item.",
+                            "properties": {
+                              "calculatedSellingPrice": {
+                                "type": "integer",
+                                "description": "Item's calculated unitary selling price in cents."
+                              },
+                              "total": {
+                                "type": "integer",
+                                "description": "Total value for all units of the item in cents."
+                              },
+                              "sellingPrices": {
+                                "type": "array",
+                                "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
+                                "items": {
+                                  "description": "Rounding information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value in cents for that specific rounding."
+                                    },
+                                    "quantity": {
+                                      "type": "integer",
+                                      "description": "Rounding quantity, meaning how many items are rounded to this value."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "selectableGifts": {
+                      "type": "array",
+                      "description": "Array containing the data of the item selected as a gift.",
+                      "items": {
+                        "type": "string",
+                        "description": "Gift."
+                      }
+                    },
+                    "totalizers": {
+                      "type": "array",
+                      "description": "Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).",
+                      "items": {
+                        "type": "object",
+                        "description": "Totalizer of purchases."
+                      }
+                    },
+                    "shippingData": {
+                      "type": "object",
+                      "description": "Shipping information pertinent to the order.",
+                      "nullable": true,
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Address information.",
+                          "nullable": true,
+                          "properties": {
+                            "addressType": {
+                              "type": "string",
+                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                            },
+                            "receiverName": {
+                              "type": "string",
+                              "description": "Name of the person who is going to receive the order."
+                            },
+                            "addressId": {
+                              "type": "string",
+                              "description": "Address ID.",
+                              "nullable": true
+                            },
+                            "isDisposable": {
+                              "type": "boolean",
+                              "description": "Indicates whether address is disposable."
+                            },
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City of the shipping address."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State of the shipping address."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Three letter ISO code of the country of the shipping address."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street of the shipping address."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Number of the building, house or apartment in the shipping address."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood of the shipping address."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Complement to the shipping address, in case it applies.",
+                              "nullable": true
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                              "nullable": true
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                              "items": {
+                                "type": "number",
+                                "description": "Geocoordinates."
+                              }
+                            }
+                          }
+                        },
+                        "logisticsInfo": {
+                          "type": "array",
+                          "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.",
+                          "items": {
+                            "description": "Logistics information.",
+                            "type": "object",
+                            "properties": {
+                              "itemIndex": {
+                                "type": "integer",
+                                "description": "Index corresponding to the position of the object in the `items` array."
+                              },
+                              "selectedSla": {
+                                "type": "string",
+                                "description": "SLA selected by the customer.",
+                                "nullable": true
+                              },
+                              "selectedDeliveryChannel": {
+                                "type": "string",
+                                "description": "Delivery channel selected by the customer.",
+                                "nullable": true
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "slas": {
+                                "type": "array",
+                                "description": "Information on available SLAs.",
+                                "items": {
+                                  "description": "SLA information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "SLA ID."
+                                    },
+                                    "deliveryChannel": {
+                                      "type": "string",
+                                      "description": "Delivery channel."
+                                    },
+                                    "name": {
+                                      "type": "string",
+                                      "description": "SLA name."
+                                    },
+                                    "deliveryIds": {
+                                      "type": "array",
+                                      "description": "Information on each delivery ID.",
+                                      "items": {
+                                        "description": "Delivery ID information.",
+                                        "type": "object",
+                                        "properties": {
+                                          "courierId": {
+                                            "type": "string",
+                                            "description": "Courier ID."
+                                          },
+                                          "warehouseId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "dockId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "courierName": {
+                                            "type": "string",
+                                            "description": "Courier name."
+                                          },
+                                          "quantity": {
+                                            "type": "integer",
+                                            "description": "Quantity."
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "attachmentOfferings": {
+                                      "type": "array",
+                                      "description": "List of attachments details.",
+                                      "nullable": true,
+                                      "items": {
+                                        "description": "Attachment details.",
+                                        "type": "object",
+                                        "required": [
+                                          "name",
+                                          "required",
+                                          "schema"
+                                        ],
+                                        "properties": {
+                                          "name": {
+                                            "type": "string",
+                                            "description": "Name of the attachment.",
+                                            "nullable": true
+                                          },
+                                          "required": {
+                                            "type": "boolean",
+                                            "description": "Defines if the attachment is required (`true`) or not (`false`).",
+                                            "nullable": true
+                                          },
+                                          "schema": {
+                                            "type": "object",
+                                            "description": "Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).",
+                                            "nullable": true
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "shippingEstimate": {
+                                      "type": "string",
+                                      "description": "Shipping estimate. For instance, \"three business days\" will be represented as `3bd`."
+                                    },
+                                    "shippingEstimateDate": {
+                                      "type": "string",
+                                      "description": "When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.",
+                                      "nullable": true
+                                    },
+                                    "useIndividualShippingEstimates": {
+                                      "type": "boolean",
+                                      "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`."
+                                    },
+                                    "lockTTL": {
+                                      "type": "string",
+                                      "description": "Estimate date of delivery.",
+                                      "nullable": true
+                                    },
+                                    "price": {
+                                      "type": "integer",
+                                      "description": "Price in cents."
+                                    },
+                                    "listPrice": {
+                                      "type": "integer",
+                                      "description": "List price in cents."
+                                    },
+                                    "tax": {
+                                      "type": "integer",
+                                      "description": "Tax in cents."
+                                    },
+                                    "pickupStoreInfo": {
+                                      "type": "object",
+                                      "description": "Information on the pickup store.",
+                                      "properties": {
+                                        "isPickupStore": {
+                                          "type": "boolean",
+                                          "description": "Indicates whether it is the pickup store."
+                                        },
+                                        "friendlyName": {
+                                          "type": "string",
+                                          "description": "Friendly name.",
+                                          "nullable": true
+                                        },
+                                        "address": {
+                                          "type": "object",
+                                          "description": "Address information.",
+                                          "nullable": true,
+                                          "properties": {
+                                            "addressType": {
+                                              "type": "string",
+                                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                                            },
+                                            "postalCode": {
+                                              "type": "string",
+                                              "description": "Postal code."
+                                            },
+                                            "city": {
+                                              "type": "string",
+                                              "description": "City of the shipping address."
+                                            },
+                                            "state": {
+                                              "type": "string",
+                                              "description": "State of the shipping address."
+                                            },
+                                            "country": {
+                                              "type": "string",
+                                              "description": "Three letter ISO code of the country of the shipping address."
+                                            },
+                                            "street": {
+                                              "type": "string",
+                                              "description": "Street of the shipping address."
+                                            },
+                                            "number": {
+                                              "type": "string",
+                                              "description": "Number of the building, house or apartment in the shipping address."
+                                            },
+                                            "neighborhood": {
+                                              "type": "string",
+                                              "description": "Neighborhood of the shipping address."
+                                            },
+                                            "complement": {
+                                              "type": "string",
+                                              "description": "Complement to the shipping address, in case it applies.",
+                                              "nullable": true
+                                            },
+                                            "reference": {
+                                              "type": "string",
+                                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                              "nullable": true
+                                            },
+                                            "geoCoordinates": {
+                                              "type": "array",
+                                              "description": "Array with two strings that repesent geocoordinates: first latitude, then longitude.",
+                                              "items": {
+                                                "type": "number",
+                                                "description": "Geocoordinates."
+                                              }
+                                            }
+                                          }
+                                        },
+                                        "additionalInfo": {
+                                          "type": "string",
+                                          "description": "Additional information.",
+                                          "nullable": true
+                                        },
+                                        "dockId": {
+                                          "type": "string",
+                                          "description": "Corresponding dock ID.",
+                                          "nullable": true
+                                        }
+                                      }
+                                    },
+                                    "pickupPointId": {
+                                      "type": "string",
+                                      "description": "Pickup point ID.",
+                                      "nullable": true
+                                    },
+                                    "pickupDistance": {
+                                      "type": "integer",
+                                      "description": "Pickup point distance."
+                                    },
+                                    "polygonName": {
+                                      "type": "string",
+                                      "description": "Polygon name.",
+                                      "nullable": true
+                                    },
+                                    "transitTime": {
+                                      "type": "string",
+                                      "description": "Transit time. For instance, \"three business days\" is represented as `3bd`."
+                                    }
+                                  }
+                                }
+                              },
+                              "shipsTo": {
+                                "type": "array",
+                                "description": "List of countries that the item may be shipped to.",
+                                "items": {
+                                  "type": "string",
+                                  "description": "Three letter country code."
+                                }
+                              },
+                              "itemId": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "deliveryChannels": {
+                                "type": "array",
+                                "description": "List of available delivery channels.",
+                                "items": {
+                                  "description": "Delivery channel information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "Delivery channel ID."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "selectedAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the selected addresses for the order.",
+                          "items": {
+                            "description": "Selected address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "availableAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the available addresses for the order.",
+                          "items": {
+                            "description": "Available address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "clientProfileData": {
+                      "type": "object",
+                      "description": "Customer's profile information.",
+                      "nullable": true,
+                      "properties": {
+                        "email": {
+                          "type": "string",
+                          "description": "Email address.",
+                          "nullable": true
+                        },
+                        "firstName": {
+                          "type": "string",
+                          "description": "First name.",
+                          "nullable": true
+                        },
+                        "lastName": {
+                          "type": "string",
+                          "description": "Last name."
+                        },
+                        "documentType": {
+                          "type": "string",
+                          "description": "Type of the document informed by the customer."
+                        },
+                        "document": {
+                          "type": "string",
+                          "description": "Document informed by the customer."
+                        },
+                        "phone": {
+                          "type": "string",
+                          "description": "Phone number."
+                        },
+                        "corporateName": {
+                          "type": "string",
+                          "description": "Company name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "tradeName": {
+                          "type": "string",
+                          "description": "Trade name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporateDocument": {
+                          "type": "string",
+                          "description": "Corporate document, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "stateInscription": {
+                          "type": "string",
+                          "description": "State inscription, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporatePhone": {
+                          "type": "string",
+                          "description": "Corporate phone number, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "isCorporate": {
+                          "type": "boolean",
+                          "description": "Indicates whether the customer is a legal entity."
+                        },
+                        "profileCompleteOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile is complete on loading."
+                        },
+                        "profileErrorOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile presents error on loading.",
+                          "nullable": true
+                        },
+                        "customerClass": {
+                          "type": "string",
+                          "description": "Customer class.",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "paymentData": {
+                      "type": "object",
+                      "description": "Information on the order's payment.",
+                      "properties": {
+                        "giftCards": {
+                          "type": "array",
+                          "description": "Gift card information, if it applies to the order.",
+                          "items": {
+                            "description": "Gift card information.",
+                            "type": "object",
+                            "properties": {
+                              "redemptionCode": {
+                                "type": "string",
+                                "description": "Gift card redemption code."
+                              },
+                              "value": {
+                                "type": "integer",
+                                "description": "Gift card value in cents."
+                              },
+                              "balance": {
+                                "type": "integer",
+                                "description": "Gift card balance in cents."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Gift card name."
+                              },
+                              "id": {
+                                "type": "string",
+                                "description": "Gift card ID."
+                              },
+                              "inUse": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is in use."
+                              },
+                              "isSpecialCard": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is special."
+                              }
+                            }
+                          }
+                        },
+                        "transactions": {
+                          "type": "array",
+                          "description": "Information on each transaction pertinent to the order.",
+                          "items": {
+                            "description": "Transaction information.",
+                            "nullable": true,
+                            "type": "object",
+                            "properties": {
+                              "isActive": {
+                                "type": "boolean",
+                                "description": "Indicates whether transaction is active."
+                              },
+                              "transactionId": {
+                                "type": "string",
+                                "description": "Transaction ID."
+                              },
+                              "merchantName": {
+                                "type": "string",
+                                "description": "Merchant name."
+                              },
+                              "payments": {
+                                "type": "array",
+                                "description": "Information on each payment.",
+                                "items": {
+                                  "description": "Payment information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "accountId": {
+                                      "type": "string",
+                                      "description": "Account ID."
+                                    },
+                                    "bin": {
+                                      "type": "string",
+                                      "description": "Bin.",
+                                      "nullable": true
+                                    },
+                                    "installments": {
+                                      "type": "integer",
+                                      "description": "Number of installments."
+                                    },
+                                    "paymentSystem": {
+                                      "type": "string",
+                                      "description": "Payment system."
+                                    },
+                                    "referenceValue": {
+                                      "type": "integer",
+                                      "description": "Reference value for calculating interest rates, in case it applies. Displayed in cents."
+                                    },
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value including interest, in case it applies. Displayed in cents."
+                                    }
+                                  }
+                                }
+                              },
+                              "sharedTransaction": {
+                                "type": "boolean",
+                                "description": "Indicates whather transaction is shared."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "marketingData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Object containing promotion data such as coupon tracking information and internal or external UTMs.",
+                      "properties": {
+                        "coupon": {
+                          "type": "string",
+                          "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.",
+                          "example": "free-shipping"
+                        },
+                        "utmSource": {
+                          "type": "string",
+                          "description": "UTM source.",
+                          "example": "Facebook"
+                        },
+                        "utmMedium": {
+                          "type": "string",
+                          "description": "UTM medium.",
+                          "example": "CPC"
+                        },
+                        "utmCampaign": {
+                          "type": "string",
+                          "description": "UTM campaign.",
+                          "example": "Black friday"
+                        },
+                        "utmiPage": {
+                          "type": "string",
+                          "description": "utmi_page (internal utm).",
+                          "example": "utmi_page-example",
+                          "nullable": true
+                        },
+                        "utmiPart": {
+                          "type": "string",
+                          "description": "utmi_part (internal utm).",
+                          "example": "utmi_part-example",
+                          "nullable": true
+                        },
+                        "utmiCampaign": {
+                          "type": "string",
+                          "description": "utmi_campaign (internal utm).",
+                          "example": "utmi_campaign-example",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "sellers": {
+                      "type": "array",
+                      "description": "Information on each seller.",
+                      "items": {
+                        "description": "Seller information.",
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "Seller ID."
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Seller name."
+                          },
+                          "logo": {
+                            "type": "string",
+                            "description": "Seller logo.",
+                            "nullable": true
+                          }
+                        }
+                      }
+                    },
+                    "clientPreferencesData": {
+                      "type": "object",
+                      "description": "Object containing preferences from the client who placed the order.",
+                      "properties": {
+                        "locale": {
+                          "type": "string",
+                          "description": "Client's locale. Examples: `pt-BR` and `en-US`."
+                        },
+                        "optinNewsLetter": {
+                          "type": "boolean",
+                          "description": "`true` if the client opted to receive newsletter from the store.",
+                          "example": false,
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "commercialConditionData": {
+                      "type": "object",
+                      "description": "Object containing commercial condition information.",
+                      "nullable": true
+                    },
+                    "storePreferencesData": {
+                      "type": "object",
+                      "description": "Object containing data from the store's configuration (stored in VTEX's License Manager)."
+                    },
+                    "giftRegistryData": {
+                      "type": "object",
+                      "description": "Gift registry list information.",
+                      "nullable": true
+                    },
+                    "openTextField": {
+                      "type": "string",
+                      "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).",
+                      "example": "open-text-example",
+                      "nullable": true
+                    },
+                    "invoiceData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Invoice data including billing address.",
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Billing address.",
+                          "properties": {
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City name."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State name."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Country."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street name."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Street number."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Address complement."
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Reference for location."
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Geographic coordinates (latitude, longitude).",
+                              "items": {
+                                "type": "number"
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "customData": {
+                      "type": "object",
+                      "description": "Customer additional information.",
+                      "nullable": true
+                    },
+                    "itemMetadata": {
+                      "type": "object",
+                      "description": "Item metadata.",
+                      "properties": {
+                        "items": {
+                          "type": "array",
+                          "description": "List of objects containing metadata on each item in the order.",
+                          "items": {
+                            "description": "Item metadata.",
+                            "type": "object",
+                            "properties": {
+                              "id": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "seller": {
+                                "type": "string",
+                                "description": "Seller."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Product name."
+                              },
+                              "skuName": {
+                                "type": "string",
+                                "description": "SKU name."
+                              },
+                              "productId": {
+                                "type": "string",
+                                "description": "Product ID."
+                              },
+                              "refId": {
+                                "type": "string",
+                                "description": "Ref ID."
+                              },
+                              "ean": {
+                                "type": "string",
+                                "description": "European Article Number.",
+                                "nullable": true
+                              },
+                              "imageUrl": {
+                                "type": "string",
+                                "description": "Image URL."
+                              },
+                              "detailUrl": {
+                                "type": "string",
+                                "description": "Detail URL."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "hooksData": {
+                      "type": "object",
+                      "description": "Hooks information.",
+                      "nullable": true
+                    },
+                    "ratesAndBenefitsData": {
+                      "type": "object",
+                      "description": "Information on rates and benefits that apply to the order.",
+                      "properties": {
+                        "rateAndBenefitsIdentifiers": {
+                          "type": "array",
+                          "description": "List with rates and benefits identifiers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit identifier."
+                          }
+                        },
+                        "teaser": {
+                          "type": "array",
+                          "description": "List with rates and benefits teasers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit teaser."
+                          }
+                        }
+                      }
+                    },
+                    "subscriptionData": {
+                      "type": "object",
+                      "description": "Subscription information.",
+                      "nullable": true
+                    },
+                    "itemsOrdination": {
+                      "type": "object",
+                      "description": "Object containing information about the ordering of items within the `orderForm`.",
+                      "properties": {
+                        "criteria": {
+                          "type": "string",
+                          "description": "Criteria adopted to order the items in the list."
+                        },
+                        "ascending": {
+                          "type": "boolean",
+                          "description": "Indicates whether the ordering is ascending."
+                        }
+                      }
+                    }
+                  }
+                },
+                "example": {
+                  "orderFormId": "e66d440c15d0497692dffbec775cae2f",
+                  "salesChannel": "1",
+                  "loggedIn": true,
+                  "isCheckedIn": false,
+                  "storeId": null,
+                  "checkedInPickupPointId": null,
+                  "allowManualPrice": true,
+                  "canEditData": true,
+                  "userProfileId": null,
+                  "userType": null,
+                  "ignoreProfileData": false,
+                  "value": 0,
+                  "messages": [],
+                  "items": [],
+                  "selectableGifts": [],
+                  "totalizers": [],
+                  "shippingData": null,
+                  "clientProfileData": {
+                    "email": "karen.krieger@vtex.com",
+                    "firstName": null,
+                    "lastName": null,
+                    "document": null,
+                    "documentType": null,
+                    "phone": null,
+                    "corporateName": null,
+                    "tradeName": null,
+                    "corporateDocument": null,
+                    "stateInscription": null,
+                    "corporatePhone": null,
+                    "isCorporate": false,
+                    "profileCompleteOnLoading": false,
+                    "profileErrorOnLoading": false,
+                    "customerClass": null
+                  },
+                  "paymentData": {
+                    "updateStatus": "updated",
+                    "installmentOptions": [],
+                    "paymentSystems": [],
+                    "payments": [],
+                    "giftCards": [],
+                    "giftCardMessages": [],
+                    "availableAccounts": [],
+                    "availableTokens": [],
+                    "availableAssociations": {}
+                  },
+                  "marketingData": null,
+                  "sellers": [],
+                  "clientPreferencesData": {
+                    "locale": "pt-BR",
+                    "optinNewsLetter": null
+                  },
+                  "commercialConditionData": null,
+                  "storePreferencesData": {
+                    "countryCode": "BRA",
+                    "saveUserData": true,
+                    "timeZone": "E. South America Standard Time",
+                    "currencyCode": "BRL",
+                    "currencyLocale": 1046,
+                    "currencySymbol": "R$",
+                    "currencyFormatInfo": {
+                      "currencyDecimalDigits": 2,
+                      "currencyDecimalSeparator": ",",
+                      "currencyGroupSeparator": ".",
+                      "currencyGroupSize": 3,
+                      "startsWithCurrencySymbol": true
+                    }
+                  },
+                  "giftRegistryData": null,
+                  "openTextField": null,
+                  "invoiceData": {
+                    "address": {
+                      "postalCode": "10019",
+                      "city": "New York",
+                      "state": "NY",
+                      "country": "USA",
+                      "street": "North 110th Street",
+                      "number": "52",
+                      "neighborhood": "Manhattan",
+                      "complement": "101",
+                      "reference": "Between the Upper West Side and Upper East Side",
+                      "geoCoordinates": [
+                        40.7986877,
+                        -73.9534529
+                      ]
+                    }
+                  },
+                  "customData": null,
+                  "itemMetadata": null,
+                  "hooksData": null,
+                  "ratesAndBenefitsData": {
+                    "rateAndBenefitsIdentifiers": [],
+                    "teaser": []
+                  },
+                  "subscriptionData": null,
+                  "merchantContextData": null,
+                  "purchaseAgentsData": null,
+                  "itemsOrdination": null
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/checkout/pub/orderForm/{orderFormId}/customData/{appId}": {
+      "put": {
+        "tags": [
+          "Custom data"
+        ],
+        "summary": "Set multiple custom field values",
+        "description": "Your account may create `apps`, which contain custom fields, through the [Update orderForm configuration](https://developers.vtex.com/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.\n\r\n\rTo do that, you need to inform the ID of the app you created with the configuration API (`appId`).\n\r\n\rIn the body of the request, for each field created in this app (`appFieldName`) you will inform a value (`appFieldValue`).\r\n\r\nThe [orderForm](https://developers.vtex.com/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.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "SetMultipleCustomFieldValues",
+        "security": [],
+        "parameters": [
+          {
+            "name": "orderFormId",
+            "in": "path",
+            "description": "ID of the orderForm that will receive the new custom field values.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "29154e27383145cc8ce1f7a1df0d99c4"
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "appId",
+            "in": "path",
+            "description": "ID of the app created with the configuration API.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "appId"
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "description": "Here you must add the pairs of Field Name and Field Value.",
+                "type": "object",
+                "additionalProperties": true
+              },
+              "example": {
+                "fieldName": "fieldValue"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "orderFormId": {
+                      "type": "string",
+                      "description": "ID of the orderForm corresponding to a specific cart."
+                    },
+                    "salesChannel": {
+                      "type": "string",
+                      "description": "Attribute created by the seller, in their VTEX store configuration."
+                    },
+                    "loggedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether the user is logged into the store."
+                    },
+                    "isCheckedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether order is checked in."
+                    },
+                    "storeId": {
+                      "type": "string",
+                      "description": "ID of the store.",
+                      "nullable": true
+                    },
+                    "allowManualPrice": {
+                      "type": "boolean",
+                      "description": "Permission to modify item price manually."
+                    },
+                    "canEditData": {
+                      "type": "boolean",
+                      "description": "Data can be edited."
+                    },
+                    "userProfileId": {
+                      "type": "string",
+                      "description": "Unique ID associated with the customer profile."
+                    },
+                    "profileProvider": {
+                      "type": "string",
+                      "description": "Profile provider."
+                    },
+                    "availableAccounts": {
+                      "type": "array",
+                      "description": "Available accounts.",
+                      "items": {
+                        "type": "string",
+                        "description": "Account."
+                      }
+                    },
+                    "availableAddresses": {
+                      "type": "array",
+                      "description": "Information on each available address.",
+                      "items": {
+                        "description": "Address information.",
+                        "type": "object",
+                        "properties": {
+                          "addressType": {
+                            "type": "string",
+                            "description": "Address type."
+                          },
+                          "receiverName": {
+                            "type": "string",
+                            "description": "Name of the receiver."
+                          },
+                          "addressId": {
+                            "type": "string",
+                            "description": "Address ID.",
+                            "nullable": true
+                          },
+                          "isDisposable": {
+                            "type": "boolean",
+                            "description": "Indicates whether address is disposable."
+                          },
+                          "city": {
+                            "type": "string",
+                            "description": "City of the address."
+                          },
+                          "state": {
+                            "type": "string",
+                            "description": "State of the address."
+                          },
+                          "country": {
+                            "type": "string",
+                            "description": "Country of the address. ISO three-letter code."
+                          },
+                          "street": {
+                            "type": "string",
+                            "description": "Street of the address."
+                          },
+                          "number": {
+                            "type": "string",
+                            "description": "Number of the address."
+                          },
+                          "neighborhood": {
+                            "type": "string",
+                            "description": "Neighborhood of the address."
+                          },
+                          "complement": {
+                            "description": "Complement to the shipping address, in case it applies.",
+                            "type": "string",
+                            "nullable": true
+                          },
+                          "reference": {
+                            "type": "string",
+                            "description": "Reference that may help in the location of the address.",
+                            "nullable": true
+                          },
+                          "geoCoordinates": {
+                            "type": "array",
+                            "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                            "items": {
+                              "type": "number",
+                              "description": "Geocoordinates."
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "userType": {
+                      "type": "string",
+                      "description": "User type.",
+                      "nullable": true
+                    },
+                    "ignoreProfileData": {
+                      "type": "boolean",
+                      "description": "Ignore customer profile data."
+                    },
+                    "value": {
+                      "type": "integer",
+                      "description": "Total value of the order without separating cents. For example, $24.99 is represented as `2499`."
+                    },
+                    "messages": {
+                      "type": "array",
+                      "description": "Array containing an object for each message generated by our servers while processing the request.",
+                      "items": {
+                        "type": "string",
+                        "description": "Message."
+                      }
+                    },
+                    "items": {
+                      "type": "array",
+                      "description": "Information on each item in the order.",
+                      "items": {
+                        "description": "Item information.",
+                        "type": "object",
+                        "properties": {
+                          "uniqueId": {
+                            "type": "string",
+                            "description": "Unique ID."
+                          },
+                          "id": {
+                            "type": "string",
+                            "description": "ID of the item."
+                          },
+                          "productId": {
+                            "type": "string",
+                            "description": "Product ID."
+                          },
+                          "productRefId": {
+                            "type": "string",
+                            "description": "Product Ref ID."
+                          },
+                          "refId": {
+                            "type": "string",
+                            "description": "Ref ID."
+                          },
+                          "ean": {
+                            "type": "string",
+                            "description": "European Article Number.",
+                            "nullable": true
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Product name."
+                          },
+                          "skuName": {
+                            "type": "string",
+                            "description": "SKU name."
+                          },
+                          "modalType": {
+                            "type": "string",
+                            "description": "Modal type.",
+                            "nullable": true
+                          },
+                          "parentItemIndex": {
+                            "type": "integer",
+                            "description": "Parent item index.",
+                            "nullable": true
+                          },
+                          "parentAssemblyBinding": {
+                            "type": "string",
+                            "description": "Parent assembly binding.",
+                            "nullable": true
+                          },
+                          "priceValidUntil": {
+                            "type": "string",
+                            "description": "Price expiration date and time."
+                          },
+                          "tax": {
+                            "type": "integer",
+                            "description": "Tax value in cents."
+                          },
+                          "taxCode": {
+                            "type": "string",
+                            "description": "A unique identifier code assigned to a tax within the VTEX Admin."
+                          },
+                          "price": {
+                            "type": "integer",
+                            "description": "Price in cents."
+                          },
+                          "listPrice": {
+                            "type": "integer",
+                            "description": "List price in cents."
+                          },
+                          "manualPrice": {
+                            "type": "integer",
+                            "description": "Manual price in cents.",
+                            "nullable": true
+                          },
+                          "manualPriceAppliedBy": {
+                            "type": "string",
+                            "description": "User that applied the manual price, if that is the case.",
+                            "nullable": true
+                          },
+                          "sellingPrice": {
+                            "type": "integer",
+                            "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
+                          },
+                          "rewardValue": {
+                            "type": "integer",
+                            "description": "Reward value in cents."
+                          },
+                          "isGift": {
+                            "type": "boolean",
+                            "description": "Indicates whether item is a gift."
+                          },
+                          "additionalInfo": {
+                            "type": "object",
+                            "description": "Additional information.",
+                            "properties": {
+                              "dimension": {
+                                "type": "string",
+                                "description": "Dimension.",
+                                "nullable": true
+                              },
+                              "brandName": {
+                                "type": "string",
+                                "description": "Brand name."
+                              },
+                              "brandId": {
+                                "type": "string",
+                                "description": "Brand ID."
+                              },
+                              "offeringInfo": {
+                                "type": "string",
+                                "description": "Offering information.",
+                                "nullable": true
+                              },
+                              "offeringType": {
+                                "type": "string",
+                                "description": "Offering type.",
+                                "nullable": true
+                              },
+                              "offeringTypeId": {
+                                "type": "string",
+                                "description": "Offering type ID.",
+                                "nullable": true
+                              }
+                            }
+                          },
+                          "preSaleDate": {
+                            "type": "string",
+                            "description": "Presale date.",
+                            "nullable": true
+                          },
+                          "productCategoryIds": {
+                            "type": "string",
+                            "description": "Product category IDs."
+                          },
+                          "productCategories": {
+                            "type": "object",
+                            "description": "Object, where each field is an ID from `productCategoryIds`.",
+                            "properties": {
+                              "{ID}": {
+                                "type": "string",
+                                "description": "Product category corresponding to the ID in the field key."
+                              }
+                            }
+                          },
+                          "quantity": {
+                            "type": "integer",
+                            "description": "Quantity."
+                          },
+                          "seller": {
+                            "type": "string",
+                            "description": "Seller."
+                          },
+                          "sellerChain": {
+                            "type": "array",
+                            "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
+                            "items": {
+                              "type": "string",
+                              "description": "Seller."
+                            }
+                          },
+                          "imageUrl": {
+                            "type": "string",
+                            "description": "Image URL."
+                          },
+                          "detailUrl": {
+                            "type": "string",
+                            "description": "Detail URL."
+                          },
+                          "bundleItems": {
+                            "type": "array",
+                            "description": "Information on services sold along with the SKU. Example: a gift package.",
+                            "items": {
+                              "description": "Service information.",
+                              "type": "object",
+                              "properties": {
+                                "type": {
+                                  "type": "string",
+                                  "description": "Service type."
+                                },
+                                "id": {
+                                  "type": "integer",
+                                  "description": "Service identifier."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Service name."
+                                },
+                                "price": {
+                                  "type": "integer",
+                                  "description": "Service price in cents."
+                                }
+                              }
+                            }
+                          },
+                          "attachments": {
+                            "type": "array",
+                            "description": "Array containing information on attachments.",
+                            "items": {
+                              "type": "string",
+                              "description": "Attachment."
+                            }
+                          },
+                          "priceTags": {
+                            "type": "array",
+                            "description": "Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.",
+                            "items": {
+                              "description": "Price tag information.",
+                              "type": "object",
+                              "properties": {
+                                "identifier": {
+                                  "type": "string",
+                                  "description": "Promotion unique identifier.",
+                                  "nullable": true
+                                },
+                                "isPercentual": {
+                                  "type": "boolean",
+                                  "description": "Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\r\n- `type` indicates whether the tag refers to a discount or tax.\r\n- `where` specifies the context, either price or shipping.\r\n- `identifier` is the promotion ID.\r\n- `calculationId` is a hash that may vary with each price calculation."
+                                },
+                                "rawValue": {
+                                  "type": "number",
+                                  "description": "Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations."
+                                },
+                                "value": {
+                                  "type": "integer",
+                                  "description": "Price tag value representing either a promotion (value decrease) or a tax (value increase)."
+                                }
+                              }
+                            }
+                          },
+                          "availability": {
+                            "type": "string",
+                            "description": "Availability."
+                          },
+                          "measurementUnit": {
+                            "type": "string",
+                            "description": "Measurement unit."
+                          },
+                          "unitMultiplier": {
+                            "type": "integer",
+                            "description": "Unit multiplier."
+                          },
+                          "manufacturerCode": {
+                            "type": "string",
+                            "description": "Manufacturer code.",
+                            "nullable": true
+                          },
+                          "priceDefinition": {
+                            "type": "object",
+                            "description": "Price information for all units of a specific item.",
+                            "properties": {
+                              "calculatedSellingPrice": {
+                                "type": "integer",
+                                "description": "Item's calculated unitary selling price in cents."
+                              },
+                              "total": {
+                                "type": "integer",
+                                "description": "Total value for all units of the item in cents."
+                              },
+                              "sellingPrices": {
+                                "type": "array",
+                                "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
+                                "items": {
+                                  "description": "Rounding information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value in cents for that specific rounding."
+                                    },
+                                    "quantity": {
+                                      "type": "integer",
+                                      "description": "Rounding quantity, meaning how many items are rounded to this value."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "selectableGifts": {
+                      "type": "array",
+                      "description": "Array containing the data of the item selected as a gift.",
+                      "items": {
+                        "type": "string",
+                        "description": "Gift."
+                      }
+                    },
+                    "totalizers": {
+                      "type": "array",
+                      "description": "Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).",
+                      "items": {
+                        "type": "object",
+                        "description": "Totalizer of purchases."
+                      }
+                    },
+                    "shippingData": {
+                      "type": "object",
+                      "description": "Shipping information pertinent to the order.",
+                      "nullable": true,
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Address information.",
+                          "nullable": true,
+                          "properties": {
+                            "addressType": {
+                              "type": "string",
+                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                            },
+                            "receiverName": {
+                              "type": "string",
+                              "description": "Name of the person who is going to receive the order."
+                            },
+                            "addressId": {
+                              "type": "string",
+                              "description": "Address ID.",
+                              "nullable": true
+                            },
+                            "isDisposable": {
+                              "type": "boolean",
+                              "description": "Indicates whether address is disposable."
+                            },
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City of the shipping address."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State of the shipping address."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Three letter ISO code of the country of the shipping address."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street of the shipping address."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Number of the building, house or apartment in the shipping address."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood of the shipping address."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Complement to the shipping address, in case it applies.",
+                              "nullable": true
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                              "nullable": true
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                              "items": {
+                                "type": "number",
+                                "description": "Geocoordinates."
+                              }
+                            }
+                          }
+                        },
+                        "logisticsInfo": {
+                          "type": "array",
+                          "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.",
+                          "items": {
+                            "description": "Logistics information.",
+                            "type": "object",
+                            "properties": {
+                              "itemIndex": {
+                                "type": "integer",
+                                "description": "Index corresponding to the position of the object in the `items` array."
+                              },
+                              "selectedSla": {
+                                "type": "string",
+                                "description": "SLA selected by the customer.",
+                                "nullable": true
+                              },
+                              "selectedDeliveryChannel": {
+                                "type": "string",
+                                "description": "Delivery channel selected by the customer.",
+                                "nullable": true
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "slas": {
+                                "type": "array",
+                                "description": "Information on available SLAs.",
+                                "items": {
+                                  "description": "SLA information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "SLA ID."
+                                    },
+                                    "deliveryChannel": {
+                                      "type": "string",
+                                      "description": "Delivery channel."
+                                    },
+                                    "name": {
+                                      "type": "string",
+                                      "description": "SLA name."
+                                    },
+                                    "deliveryIds": {
+                                      "type": "array",
+                                      "description": "Information on each delivery ID.",
+                                      "items": {
+                                        "description": "Delivery ID information.",
+                                        "type": "object",
+                                        "properties": {
+                                          "courierId": {
+                                            "type": "string",
+                                            "description": "Courier ID."
+                                          },
+                                          "warehouseId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "dockId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "courierName": {
+                                            "type": "string",
+                                            "description": "Courier name."
+                                          },
+                                          "quantity": {
+                                            "type": "integer",
+                                            "description": "Quantity."
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "attachmentOfferings": {
+                                      "type": "array",
+                                      "description": "List of attachments details.",
+                                      "nullable": true,
+                                      "items": {
+                                        "description": "Attachment details.",
+                                        "type": "object",
+                                        "required": [
+                                          "name",
+                                          "required",
+                                          "schema"
+                                        ],
+                                        "properties": {
+                                          "name": {
+                                            "type": "string",
+                                            "description": "Name of the attachment.",
+                                            "nullable": true
+                                          },
+                                          "required": {
+                                            "type": "boolean",
+                                            "description": "Defines if the attachment is required (`true`) or not (`false`).",
+                                            "nullable": true
+                                          },
+                                          "schema": {
+                                            "type": "object",
+                                            "description": "Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).",
+                                            "nullable": true
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "shippingEstimate": {
+                                      "type": "string",
+                                      "description": "Shipping estimate. For instance, \"three business days\" will be represented as `3bd`."
+                                    },
+                                    "shippingEstimateDate": {
+                                      "type": "string",
+                                      "description": "When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.",
+                                      "nullable": true
+                                    },
+                                    "useIndividualShippingEstimates": {
+                                      "type": "boolean",
+                                      "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`."
+                                    },
+                                    "lockTTL": {
+                                      "type": "string",
+                                      "description": "Estimate date of delivery.",
+                                      "nullable": true
+                                    },
+                                    "price": {
+                                      "type": "integer",
+                                      "description": "Price in cents."
+                                    },
+                                    "listPrice": {
+                                      "type": "integer",
+                                      "description": "List price in cents."
+                                    },
+                                    "tax": {
+                                      "type": "integer",
+                                      "description": "Tax in cents."
+                                    },
+                                    "pickupStoreInfo": {
+                                      "type": "object",
+                                      "description": "Information on the pickup store.",
+                                      "properties": {
+                                        "isPickupStore": {
+                                          "type": "boolean",
+                                          "description": "Indicates whether it is the pickup store."
+                                        },
+                                        "friendlyName": {
+                                          "type": "string",
+                                          "description": "Friendly name.",
+                                          "nullable": true
+                                        },
+                                        "address": {
+                                          "type": "object",
+                                          "description": "Address information.",
+                                          "nullable": true,
+                                          "properties": {
+                                            "addressType": {
+                                              "type": "string",
+                                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                                            },
+                                            "postalCode": {
+                                              "type": "string",
+                                              "description": "Postal code."
+                                            },
+                                            "city": {
+                                              "type": "string",
+                                              "description": "City of the shipping address."
+                                            },
+                                            "state": {
+                                              "type": "string",
+                                              "description": "State of the shipping address."
+                                            },
+                                            "country": {
+                                              "type": "string",
+                                              "description": "Three letter ISO code of the country of the shipping address."
+                                            },
+                                            "street": {
+                                              "type": "string",
+                                              "description": "Street of the shipping address."
+                                            },
+                                            "number": {
+                                              "type": "string",
+                                              "description": "Number of the building, house or apartment in the shipping address."
+                                            },
+                                            "neighborhood": {
+                                              "type": "string",
+                                              "description": "Neighborhood of the shipping address."
+                                            },
+                                            "complement": {
+                                              "type": "string",
+                                              "description": "Complement to the shipping address, in case it applies.",
+                                              "nullable": true
+                                            },
+                                            "reference": {
+                                              "type": "string",
+                                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                              "nullable": true
+                                            },
+                                            "geoCoordinates": {
+                                              "type": "array",
+                                              "description": "Array with two strings that repesent geocoordinates: first latitude, then longitude.",
+                                              "items": {
+                                                "type": "number",
+                                                "description": "Geocoordinates."
+                                              }
+                                            }
+                                          }
+                                        },
+                                        "additionalInfo": {
+                                          "type": "string",
+                                          "description": "Additional information.",
+                                          "nullable": true
+                                        },
+                                        "dockId": {
+                                          "type": "string",
+                                          "description": "Corresponding dock ID.",
+                                          "nullable": true
+                                        }
+                                      }
+                                    },
+                                    "pickupPointId": {
+                                      "type": "string",
+                                      "description": "Pickup point ID.",
+                                      "nullable": true
+                                    },
+                                    "pickupDistance": {
+                                      "type": "integer",
+                                      "description": "Pickup point distance."
+                                    },
+                                    "polygonName": {
+                                      "type": "string",
+                                      "description": "Polygon name.",
+                                      "nullable": true
+                                    },
+                                    "transitTime": {
+                                      "type": "string",
+                                      "description": "Transit time. For instance, \"three business days\" is represented as `3bd`."
+                                    }
+                                  }
+                                }
+                              },
+                              "shipsTo": {
+                                "type": "array",
+                                "description": "List of countries that the item may be shipped to.",
+                                "items": {
+                                  "type": "string",
+                                  "description": "Three letter country code."
+                                }
+                              },
+                              "itemId": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "deliveryChannels": {
+                                "type": "array",
+                                "description": "List of available delivery channels.",
+                                "items": {
+                                  "description": "Delivery channel information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "Delivery channel ID."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "selectedAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the selected addresses for the order.",
+                          "items": {
+                            "description": "Selected address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "availableAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the available addresses for the order.",
+                          "items": {
+                            "description": "Available address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "clientProfileData": {
+                      "type": "object",
+                      "description": "Customer's profile information.",
+                      "nullable": true,
+                      "properties": {
+                        "email": {
+                          "type": "string",
+                          "description": "Email address.",
+                          "nullable": true
+                        },
+                        "firstName": {
+                          "type": "string",
+                          "description": "First name.",
+                          "nullable": true
+                        },
+                        "lastName": {
+                          "type": "string",
+                          "description": "Last name."
+                        },
+                        "documentType": {
+                          "type": "string",
+                          "description": "Type of the document informed by the customer."
+                        },
+                        "document": {
+                          "type": "string",
+                          "description": "Document informed by the customer."
+                        },
+                        "phone": {
+                          "type": "string",
+                          "description": "Phone number."
+                        },
+                        "corporateName": {
+                          "type": "string",
+                          "description": "Company name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "tradeName": {
+                          "type": "string",
+                          "description": "Trade name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporateDocument": {
+                          "type": "string",
+                          "description": "Corporate document, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "stateInscription": {
+                          "type": "string",
+                          "description": "State inscription, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporatePhone": {
+                          "type": "string",
+                          "description": "Corporate phone number, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "isCorporate": {
+                          "type": "boolean",
+                          "description": "Indicates whether the customer is a legal entity."
+                        },
+                        "profileCompleteOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile is complete on loading."
+                        },
+                        "profileErrorOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile presents error on loading.",
+                          "nullable": true
+                        },
+                        "customerClass": {
+                          "type": "string",
+                          "description": "Customer class.",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "paymentData": {
+                      "type": "object",
+                      "description": "Information on the order's payment.",
+                      "properties": {
+                        "giftCards": {
+                          "type": "array",
+                          "description": "Gift card information, if it applies to the order.",
+                          "items": {
+                            "description": "Gift card information.",
+                            "type": "object",
+                            "properties": {
+                              "redemptionCode": {
+                                "type": "string",
+                                "description": "Gift card redemption code."
+                              },
+                              "value": {
+                                "type": "integer",
+                                "description": "Gift card value in cents."
+                              },
+                              "balance": {
+                                "type": "integer",
+                                "description": "Gift card balance in cents."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Gift card name."
+                              },
+                              "id": {
+                                "type": "string",
+                                "description": "Gift card ID."
+                              },
+                              "inUse": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is in use."
+                              },
+                              "isSpecialCard": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is special."
+                              }
+                            }
+                          }
+                        },
+                        "transactions": {
+                          "type": "array",
+                          "description": "Information on each transaction pertinent to the order.",
+                          "items": {
+                            "description": "Transaction information.",
+                            "nullable": true,
+                            "type": "object",
+                            "properties": {
+                              "isActive": {
+                                "type": "boolean",
+                                "description": "Indicates whether transaction is active."
+                              },
+                              "transactionId": {
+                                "type": "string",
+                                "description": "Transaction ID."
+                              },
+                              "merchantName": {
+                                "type": "string",
+                                "description": "Merchant name."
+                              },
+                              "payments": {
+                                "type": "array",
+                                "description": "Information on each payment.",
+                                "items": {
+                                  "description": "Payment information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "accountId": {
+                                      "type": "string",
+                                      "description": "Account ID."
+                                    },
+                                    "bin": {
+                                      "type": "string",
+                                      "description": "Bin.",
+                                      "nullable": true
+                                    },
+                                    "installments": {
+                                      "type": "integer",
+                                      "description": "Number of installments."
+                                    },
+                                    "paymentSystem": {
+                                      "type": "string",
+                                      "description": "Payment system."
+                                    },
+                                    "referenceValue": {
+                                      "type": "integer",
+                                      "description": "Reference value for calculating interest rates, in case it applies. Displayed in cents."
+                                    },
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value including interest, in case it applies. Displayed in cents."
+                                    }
+                                  }
+                                }
+                              },
+                              "sharedTransaction": {
+                                "type": "boolean",
+                                "description": "Indicates whather transaction is shared."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "marketingData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Object containing promotion data such as coupon tracking information and internal or external UTMs.",
+                      "properties": {
+                        "coupon": {
+                          "type": "string",
+                          "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.",
+                          "example": "free-shipping"
+                        },
+                        "utmSource": {
+                          "type": "string",
+                          "description": "UTM source.",
+                          "example": "Facebook"
+                        },
+                        "utmMedium": {
+                          "type": "string",
+                          "description": "UTM medium.",
+                          "example": "CPC"
+                        },
+                        "utmCampaign": {
+                          "type": "string",
+                          "description": "UTM campaign.",
+                          "example": "Black friday"
+                        },
+                        "utmiPage": {
+                          "type": "string",
+                          "description": "utmi_page (internal utm).",
+                          "example": "utmi_page-example",
+                          "nullable": true
+                        },
+                        "utmiPart": {
+                          "type": "string",
+                          "description": "utmi_part (internal utm).",
+                          "example": "utmi_part-example",
+                          "nullable": true
+                        },
+                        "utmiCampaign": {
+                          "type": "string",
+                          "description": "utmi_campaign (internal utm).",
+                          "example": "utmi_campaign-example",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "sellers": {
+                      "type": "array",
+                      "description": "Information on each seller.",
+                      "items": {
+                        "description": "Seller information.",
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "Seller ID."
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Seller name."
+                          },
+                          "logo": {
+                            "type": "string",
+                            "description": "Seller logo.",
+                            "nullable": true
+                          }
+                        }
+                      }
+                    },
+                    "clientPreferencesData": {
+                      "type": "object",
+                      "description": "Object containing preferences from the client who placed the order.",
+                      "properties": {
+                        "locale": {
+                          "type": "string",
+                          "description": "Client's locale. Examples: `pt-BR` and `en-US`."
+                        },
+                        "optinNewsLetter": {
+                          "type": "boolean",
+                          "description": "`true` if the client opted to receive newsletter from the store.",
+                          "example": false,
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "commercialConditionData": {
+                      "type": "object",
+                      "description": "Object containing commercial condition information.",
+                      "nullable": true
+                    },
+                    "storePreferencesData": {
+                      "type": "object",
+                      "description": "Object containing data from the store's configuration (stored in VTEX's License Manager)."
+                    },
+                    "giftRegistryData": {
+                      "type": "object",
+                      "description": "Gift registry list information.",
+                      "nullable": true
+                    },
+                    "openTextField": {
+                      "type": "string",
+                      "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).",
+                      "example": "open-text-example",
+                      "nullable": true
+                    },
+                    "invoiceData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Invoice data including billing address.",
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Billing address.",
+                          "properties": {
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City name."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State name."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Country."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street name."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Street number."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Address complement."
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Reference for location."
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Geographic coordinates (latitude, longitude).",
+                              "items": {
+                                "type": "number"
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "customData": {
+                      "type": "object",
+                      "description": "Customer additional information.",
+                      "nullable": true
+                    },
+                    "itemMetadata": {
+                      "type": "object",
+                      "description": "Item metadata.",
+                      "properties": {
+                        "items": {
+                          "type": "array",
+                          "description": "List of objects containing metadata on each item in the order.",
+                          "items": {
+                            "description": "Item metadata.",
+                            "type": "object",
+                            "properties": {
+                              "id": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "seller": {
+                                "type": "string",
+                                "description": "Seller."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Product name."
+                              },
+                              "skuName": {
+                                "type": "string",
+                                "description": "SKU name."
+                              },
+                              "productId": {
+                                "type": "string",
+                                "description": "Product ID."
+                              },
+                              "refId": {
+                                "type": "string",
+                                "description": "Ref ID."
+                              },
+                              "ean": {
+                                "type": "string",
+                                "description": "European Article Number.",
+                                "nullable": true
+                              },
+                              "imageUrl": {
+                                "type": "string",
+                                "description": "Image URL."
+                              },
+                              "detailUrl": {
+                                "type": "string",
+                                "description": "Detail URL."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "hooksData": {
+                      "type": "object",
+                      "description": "Hooks information.",
+                      "nullable": true
+                    },
+                    "ratesAndBenefitsData": {
+                      "type": "object",
+                      "description": "Information on rates and benefits that apply to the order.",
+                      "properties": {
+                        "rateAndBenefitsIdentifiers": {
+                          "type": "array",
+                          "description": "List with rates and benefits identifiers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit identifier."
+                          }
+                        },
+                        "teaser": {
+                          "type": "array",
+                          "description": "List with rates and benefits teasers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit teaser."
+                          }
+                        }
+                      }
+                    },
+                    "subscriptionData": {
+                      "type": "object",
+                      "description": "Subscription information.",
+                      "nullable": true
+                    },
+                    "itemsOrdination": {
+                      "type": "object",
+                      "description": "Object containing information about the ordering of items within the `orderForm`.",
+                      "properties": {
+                        "criteria": {
+                          "type": "string",
+                          "description": "Criteria adopted to order the items in the list."
+                        },
+                        "ascending": {
+                          "type": "boolean",
+                          "description": "Indicates whether the ordering is ascending."
+                        }
+                      }
+                    }
+                  }
+                },
+                "example": {
+                  "orderFormId": "ede846222cd44046ba6c638442c3505a",
+                  "salesChannel": "1",
+                  "loggedIn": false,
+                  "isCheckedIn": false,
+                  "storeId": "1",
+                  "checkedInPickupPointId": "21",
+                  "allowManualPrice": false,
+                  "canEditData": true,
+                  "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
+                  "userType": "User type",
+                  "ignoreProfileData": false,
+                  "value": 10000,
+                  "messages": [],
+                  "items": [
+                    {
+                      "uniqueId": "E0F2B7AF5CD74D668F1E27537206912C",
+                      "id": "1",
+                      "productId": "1",
+                      "productRefId": "1",
+                      "refId": "0001",
+                      "ean": "123456789",
+                      "name": "Ração Royal Canin Feline Urinary 500g",
+                      "skuName": "Ração Royal Canin Feline Urinary 500g",
+                      "modalType": null,
+                      "parentItemIndex": null,
+                      "parentAssemblyBinding": null,
+                      "assemblies": [],
+                      "priceValidUntil": "2021-02-27T14:59:00.8288784Z",
+                      "tax": 0,
+                      "price": 15000,
+                      "listPrice": 30000,
+                      "manualPrice": 10000,
+                      "sellingPrice": 10000,
+                      "rewardValue": 0,
+                      "isGift": false,
+                      "additionalInfo": {
+                        "brandName": "Royal Canin",
+                        "brandId": "2000000",
+                        "offeringInfo": null,
+                        "offeringType": null,
+                        "offeringTypeId": null
+                      },
+                      "preSaleDate": null,
+                      "productCategoryIds": "/1/10/",
+                      "productCategories": {
+                        "1": "Alimentação",
+                        "10": "Ração Seca"
+                      },
+                      "quantity": 1,
+                      "seller": "1",
+                      "sellerChain": [
+                        "1"
+                      ],
+                      "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
+                      "detailUrl": "/racao-royal-canin-feline-urinary/p",
+                      "components": [],
+                      "bundleItems": [],
+                      "attachments": [],
+                      "attachmentOfferings": [
+                        {
+                          "name": "vtex.subscription.weekly",
+                          "required": false,
+                          "schema": {
+                            "vtex.subscription.key.frequency": {
+                              "MaximumNumberOfCharacters": 7,
+                              "Domain": [
+                                "1 week",
+                                "2 week",
+                                "3 week",
+                                "4 week"
+                              ]
+                            }
+                          }
+                        },
+                        {
+                          "name": "vtex.subscription.daily",
+                          "required": false,
+                          "schema": {
+                            "vtex.subscription.key.frequency": {
+                              "MaximumNumberOfCharacters": 5,
+                              "Domain": [
+                                "1 day"
+                              ]
+                            }
+                          }
+                        }
+                      ],
+                      "offerings": [],
+                      "priceTags": [
+                        {
+                          "name": "DISCOUNT@MANUALPRICE",
+                          "value": -5000,
+                          "rawValue": -50,
+                          "isPercentual": false,
+                          "identifier": null
+                        }
+                      ],
+                      "availability": "available",
+                      "measurementUnit": "un",
+                      "unitMultiplier": 1,
+                      "manufacturerCode": null
+                    }
+                  ],
+                  "selectableGifts": [],
+                  "totalizers": [
+                    {
+                      "id": "Items",
+                      "name": "Total dos Itens",
+                      "value": 15000
+                    },
+                    {
+                      "id": "Discounts",
+                      "name": "Total dos Descontos",
+                      "value": -5000
+                    }
+                  ],
+                  "shippingData": {
+                    "address": null,
+                    "logisticsInfo": [
+                      {
+                        "itemIndex": 0,
+                        "selectedSla": "Normal",
+                        "selectedDeliveryChannel": "delivery",
+                        "addressId": "666c2e830bd9474ab6f6cc53fb6dd2d2",
+                        "slas": [],
+                        "shipsTo": [
+                          "BRA"
+                        ],
+                        "itemId": "1",
+                        "deliveryChannels": [
+                          {
+                            "id": "pickup-in-point"
+                          },
+                          {
+                            "id": "delivery"
+                          }
+                        ]
+                      }
+                    ],
+                    "selectedAddresses": [],
+                    "availableAddresses": [],
+                    "pickupPoints": []
+                  },
+                  "clientProfileData": null,
+                  "paymentData": {
+                    "installmentOptions": [
+                      {
+                        "paymentSystem": 2,
+                        "bin": null,
+                        "paymentName": null,
+                        "paymentGroupName": null,
+                        "value": 10000,
+                        "installments": [
+                          {
+                            "count": 1,
+                            "hasInterestRate": false,
+                            "interestRate": 0,
+                            "value": 10000,
+                            "total": 10000,
+                            "sellerMerchantInstallments": [
+                              {
+                                "id": "LOJADOBRENO",
+                                "count": 1,
+                                "hasInterestRate": false,
+                                "interestRate": 0,
+                                "value": 10000,
+                                "total": 10000
+                              }
+                            ]
+                          },
+                          {
+                            "count": 2,
+                            "hasInterestRate": false,
+                            "interestRate": 0,
+                            "value": 5000,
+                            "total": 10000,
+                            "sellerMerchantInstallments": [
+                              {
+                                "id": "LOJADOBRENO",
+                                "count": 2,
+                                "hasInterestRate": false,
+                                "interestRate": 0,
+                                "value": 5000,
+                                "total": 10000
+                              }
+                            ]
+                          }
+                        ]
+                      }
+                    ],
+                    "paymentSystems": [
+                      {
+                        "id": 2,
+                        "name": "Visa",
+                        "groupName": "creditCardPaymentGroup",
+                        "validator": {
+                          "regex": "^4[0-9]{15}$",
+                          "mask": "9999 9999 9999 9999",
+                          "cardCodeRegex": "^[0-9]{3}$",
+                          "cardCodeMask": "999",
+                          "weights": [
+                            2,
+                            1,
+                            2,
+                            1
+                          ],
+                          "useCvv": true,
+                          "useExpirationDate": true,
+                          "useCardHolderName": true,
+                          "useBillingAddress": true
+                        },
+                        "stringId": "2",
+                        "template": "creditCardPaymentGroup-template",
+                        "requiresDocument": false,
+                        "isCustom": false,
+                        "description": "Payment description",
+                        "requiresAuthentication": false,
+                        "dueDate": "2020-03-05T16:42:31.7836281Z",
+                        "availablePayments": null
+                      }
+                    ],
+                    "payments": [
+                      {
+                        "paymentSystem": 6,
+                        "bin": null,
+                        "accountId": "12",
+                        "tokenId": null,
+                        "value": 34390,
+                        "referenceValue": 34390,
+                        "giftCardRedemptionCode": null,
+                        "giftCardProvider": null,
+                        "giftCardId": null
+                      }
+                    ],
+                    "giftCards": [],
+                    "giftCardMessages": [],
+                    "availableAccounts": [],
+                    "availableTokens": []
+                  },
+                  "marketingData": null,
+                  "sellers": [
+                    {
+                      "id": "1",
+                      "name": "lojadobreno",
+                      "logo": "Logo"
+                    }
+                  ],
+                  "clientPreferencesData": {
+                    "locale": "pt-BR",
+                    "optinNewsLetter": null
+                  },
+                  "commercialConditionData": null,
+                  "storePreferencesData": {
+                    "countryCode": "BRA",
+                    "saveUserData": true,
+                    "timeZone": "E. South America Standard Time",
+                    "currencyCode": "BRL",
+                    "currencyLocale": 1046,
+                    "currencySymbol": "R$",
+                    "currencyFormatInfo": {
+                      "currencyDecimalDigits": 2,
+                      "currencyDecimalSeparator": ",",
+                      "currencyGroupSeparator": ".",
+                      "currencyGroupSize": 3,
+                      "startsWithCurrencySymbol": true
+                    }
+                  },
+                  "giftRegistryData": null,
+                  "openTextField": null,
+                  "invoiceData": null,
+                  "customData": {
+                    "customApps": [
+                      {
+                        "fields": {
+                          "testField1": "testValue1",
+                          "testField2": "testValue2"
+                        },
+                        "id": "abcd",
+                        "major": 1
+                      }
+                    ]
+                  },
+                  "itemMetadata": {
+                    "items": [
+                      {
+                        "id": "1",
+                        "seller": "1",
+                        "name": "Ração Royal Canin Feline Urinary 500g",
+                        "skuName": "Ração Royal Canin Feline Urinary 500g",
+                        "productId": "1",
+                        "refId": "0001",
+                        "ean": "123456789",
+                        "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
+                        "detailUrl": "/racao-royal-canin-feline-urinary/p",
+                        "assemblyOptions": []
+                      }
+                    ]
+                  },
+                  "hooksData": null,
+                  "ratesAndBenefitsData": {
+                    "rateAndBenefitsIdentifiers": [],
+                    "teaser": []
+                  },
+                  "subscriptionData": null,
+                  "itemsOrdination": {
+                    "criteria": "NAME",
+                    "ascending": true
+                  }
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/api/checkout/pub/orderForm/{orderFormId}/customData/{appId}/{appFieldName}": {
+      "put": {
+        "tags": [
+          "Custom data"
+        ],
+        "summary": "Set single custom field value",
+        "description": "Your account may create `apps`, which contain custom fields, through the [Update orderForm configuration](https://developers.vtex.com/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.\n\r\n\rTo do that, you need to inform in the URL the ID of the app you created with the configuration API (`appId`).\n\r\n\rIn the body of the request, you will inform the new value (`appFieldValue`, passed through the body) of the specific field created in this app (identified by the `appFieldName` parameter, passed through the URL).\r\n\r\nThe [orderForm](https://developers.vtex.com/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.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "SetSingleCustomFieldValue",
+        "security": [],
+        "parameters": [
+          {
+            "name": "orderFormId",
+            "in": "path",
+            "description": "The ID of the orderForm whose custom field's value you want to change.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "29154e27383145cc8ce1f7a1df0d99c4"
+            }
+          },
+          {
+            "name": "appId",
+            "in": "path",
+            "description": "ID of the app created through the Update orderForm Configuration endpoint.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "appId"
+            }
+          },
+          {
+            "name": "appFieldName",
+            "in": "path",
+            "description": "Name of the app's field created through the Update orderForm Configuration endpoint.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "appFieldName"
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "required": [
+                  "value"
+                ],
+                "type": "object",
+                "properties": {
+                  "value": {
+                    "type": "string",
+                    "description": "The value you want to set to the specified field."
+                  }
+                }
+              },
+              "example": {
+                "value": "{appFieldValue}"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "example": {
+                  "orderFormId": "ede846222cd44046ba6c638442c3505a",
+                  "salesChannel": "1",
+                  "loggedIn": false,
+                  "isCheckedIn": false,
+                  "storeId": "1",
+                  "checkedInPickupPointId": "21",
+                  "allowManualPrice": false,
+                  "canEditData": true,
+                  "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
+                  "userType": "User type",
+                  "ignoreProfileData": false,
+                  "value": 10000,
+                  "messages": [],
+                  "items": [
+                    {
+                      "uniqueId": "E0F2B7AF5CD74D668F1E27537206912C",
+                      "id": "1",
+                      "productId": "1",
+                      "productRefId": "1",
+                      "refId": "0001",
+                      "ean": "123456789",
+                      "name": "Ração Royal Canin Feline Urinary 500g",
+                      "skuName": "Ração Royal Canin Feline Urinary 500g",
+                      "modalType": null,
+                      "parentItemIndex": null,
+                      "parentAssemblyBinding": null,
+                      "assemblies": [],
+                      "priceValidUntil": "2021-02-27T14:59:00.8288784Z",
+                      "tax": 0,
+                      "price": 15000,
+                      "listPrice": 30000,
+                      "manualPrice": 10000,
+                      "sellingPrice": 10000,
+                      "rewardValue": 0,
+                      "isGift": false,
+                      "additionalInfo": {
+                        "brandName": "Royal Canin",
+                        "brandId": "2000000",
+                        "offeringInfo": null,
+                        "offeringType": null,
+                        "offeringTypeId": null
+                      },
+                      "preSaleDate": null,
+                      "productCategoryIds": "/1/10/",
+                      "productCategories": {
+                        "1": "Alimentação",
+                        "10": "Ração Seca"
+                      },
+                      "quantity": 1,
+                      "seller": "1",
+                      "sellerChain": [
+                        "1"
+                      ],
+                      "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
+                      "detailUrl": "/racao-royal-canin-feline-urinary/p",
+                      "components": [],
+                      "bundleItems": [],
+                      "attachments": [],
+                      "attachmentOfferings": [
+                        {
+                          "name": "vtex.subscription.weekly",
+                          "required": false,
+                          "schema": {
+                            "vtex.subscription.key.frequency": {
+                              "MaximumNumberOfCharacters": 7,
+                              "Domain": [
+                                "1 week",
+                                "2 week",
+                                "3 week",
+                                "4 week"
+                              ]
+                            }
+                          }
+                        },
+                        {
+                          "name": "vtex.subscription.daily",
+                          "required": false,
+                          "schema": {
+                            "vtex.subscription.key.frequency": {
+                              "MaximumNumberOfCharacters": 5,
+                              "Domain": [
+                                "1 day"
+                              ]
+                            }
+                          }
+                        }
+                      ],
+                      "offerings": [],
+                      "priceTags": [
+                        {
+                          "name": "DISCOUNT@MANUALPRICE",
+                          "value": -5000,
+                          "rawValue": -50,
+                          "isPercentual": false,
+                          "identifier": null
+                        }
+                      ],
+                      "availability": "available",
+                      "measurementUnit": "un",
+                      "unitMultiplier": 1,
+                      "manufacturerCode": null
+                    }
+                  ],
+                  "selectableGifts": [],
+                  "totalizers": [
+                    {
+                      "id": "Items",
+                      "name": "Total dos Itens",
+                      "value": 15000
+                    },
+                    {
+                      "id": "Discounts",
+                      "name": "Total dos Descontos",
+                      "value": -5000
+                    }
+                  ],
+                  "shippingData": {
+                    "address": null,
+                    "logisticsInfo": [
+                      {
+                        "itemIndex": 0,
+                        "selectedSla": "Normal",
+                        "selectedDeliveryChannel": "delivery",
+                        "addressId": "666c2e830bd9474ab6f6cc53fb6dd2d2",
+                        "slas": [],
+                        "shipsTo": [
+                          "BRA"
+                        ],
+                        "itemId": "1",
+                        "deliveryChannels": [
+                          {
+                            "id": "pickup-in-point"
+                          },
+                          {
+                            "id": "delivery"
+                          }
+                        ]
+                      }
+                    ],
+                    "selectedAddresses": [],
+                    "availableAddresses": [],
+                    "pickupPoints": []
+                  },
+                  "clientProfileData": null,
+                  "paymentData": {
+                    "installmentOptions": [
+                      {
+                        "paymentSystem": 2,
+                        "bin": null,
+                        "paymentName": null,
+                        "paymentGroupName": null,
+                        "value": 10000,
+                        "installments": [
+                          {
+                            "count": 1,
+                            "hasInterestRate": false,
+                            "interestRate": 0,
+                            "value": 10000,
+                            "total": 10000,
+                            "sellerMerchantInstallments": [
+                              {
+                                "id": "LOJADOBRENO",
+                                "count": 1,
+                                "hasInterestRate": false,
+                                "interestRate": 0,
+                                "value": 10000,
+                                "total": 10000
+                              }
+                            ]
+                          },
+                          {
+                            "count": 2,
+                            "hasInterestRate": false,
+                            "interestRate": 0,
+                            "value": 5000,
+                            "total": 10000,
+                            "sellerMerchantInstallments": [
+                              {
+                                "id": "LOJADOBRENO",
+                                "count": 2,
+                                "hasInterestRate": false,
+                                "interestRate": 0,
+                                "value": 5000,
+                                "total": 10000
+                              }
+                            ]
+                          }
+                        ]
+                      }
+                    ],
+                    "paymentSystems": [
+                      {
+                        "id": 2,
+                        "name": "Visa",
+                        "groupName": "creditCardPaymentGroup",
+                        "validator": {
+                          "regex": "^4[0-9]{15}$",
+                          "mask": "9999 9999 9999 9999",
+                          "cardCodeRegex": "^[0-9]{3}$",
+                          "cardCodeMask": "999",
+                          "weights": [
+                            2,
+                            1,
+                            2,
+                            1,
+                            2
+                          ],
+                          "useCvv": true,
+                          "useExpirationDate": true,
+                          "useCardHolderName": true,
+                          "useBillingAddress": true
+                        },
+                        "stringId": "2",
+                        "template": "creditCardPaymentGroup-template",
+                        "requiresDocument": false,
+                        "isCustom": false,
+                        "description": "Payment description",
+                        "requiresAuthentication": false,
+                        "dueDate": "2020-03-05T16:42:31.7836281Z",
+                        "availablePayments": null
+                      }
+                    ],
+                    "payments": [
+                      {
+                        "paymentSystem": 6,
+                        "bin": null,
+                        "accountId": "12",
+                        "tokenId": null,
+                        "value": 34390,
+                        "referenceValue": 34390,
+                        "giftCardRedemptionCode": null,
+                        "giftCardProvider": null,
+                        "giftCardId": null
+                      }
+                    ],
+                    "giftCards": [],
+                    "giftCardMessages": [],
+                    "availableAccounts": [],
+                    "availableTokens": []
+                  },
+                  "marketingData": null,
+                  "sellers": [
+                    {
+                      "id": "1",
+                      "name": "lojadobreno",
+                      "logo": "Logo"
+                    }
+                  ],
+                  "clientPreferencesData": {
+                    "locale": "pt-BR",
+                    "optinNewsLetter": null
+                  },
+                  "commercialConditionData": null,
+                  "storePreferencesData": {
+                    "countryCode": "BRA",
+                    "saveUserData": true,
+                    "timeZone": "E. South America Standard Time",
+                    "currencyCode": "BRL",
+                    "currencyLocale": 1046,
+                    "currencySymbol": "R$",
+                    "currencyFormatInfo": {
+                      "currencyDecimalDigits": 2,
+                      "currencyDecimalSeparator": ",",
+                      "currencyGroupSeparator": ".",
+                      "currencyGroupSize": 3,
+                      "startsWithCurrencySymbol": true
+                    }
+                  },
+                  "giftRegistryData": null,
+                  "openTextField": null,
+                  "invoiceData": null,
+                  "customData": {
+                    "customApps": [
+                      {
+                        "fields": {
+                          "testField1": "Hello World",
+                          "testField2": "testValue2"
+                        },
+                        "id": "abcd",
+                        "major": 1
+                      }
+                    ]
+                  },
+                  "itemMetadata": {
+                    "items": [
+                      {
+                        "id": "1",
+                        "seller": "1",
+                        "name": "Ração Royal Canin Feline Urinary 500g",
+                        "skuName": "Ração Royal Canin Feline Urinary 500g",
+                        "productId": "1",
+                        "refId": "0001",
+                        "ean": "123456789",
+                        "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
+                        "detailUrl": "/racao-royal-canin-feline-urinary/p",
+                        "assemblyOptions": []
+                      }
+                    ]
+                  },
+                  "hooksData": null,
+                  "ratesAndBenefitsData": {
+                    "rateAndBenefitsIdentifiers": [],
+                    "teaser": []
+                  },
+                  "subscriptionData": null,
+                  "itemsOrdination": {
+                    "criteria": "NAME",
+                    "ascending": true
+                  }
+                },
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "orderFormId": {
+                      "type": "string",
+                      "description": "ID of the orderForm corresponding to a specific cart."
+                    },
+                    "salesChannel": {
+                      "type": "string",
+                      "description": "Attribute created by the seller, in their VTEX store configuration."
+                    },
+                    "loggedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether the user is logged into the store."
+                    },
+                    "isCheckedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether order is checked in."
+                    },
+                    "storeId": {
+                      "type": "string",
+                      "description": "ID of the store.",
+                      "nullable": true
+                    },
+                    "allowManualPrice": {
+                      "type": "boolean",
+                      "description": "Permission to modify item price manually."
+                    },
+                    "canEditData": {
+                      "type": "boolean",
+                      "description": "Data can be edited."
+                    },
+                    "userProfileId": {
+                      "type": "string",
+                      "description": "Unique ID associated with the customer profile."
+                    },
+                    "profileProvider": {
+                      "type": "string",
+                      "description": "Profile provider."
+                    },
+                    "availableAccounts": {
+                      "type": "array",
+                      "description": "Available accounts.",
+                      "items": {
+                        "type": "string",
+                        "description": "Account."
+                      }
+                    },
+                    "availableAddresses": {
+                      "type": "array",
+                      "description": "Information on each available address.",
+                      "items": {
+                        "description": "Address information.",
+                        "type": "object",
+                        "properties": {
+                          "addressType": {
+                            "type": "string",
+                            "description": "Address type."
+                          },
+                          "receiverName": {
+                            "type": "string",
+                            "description": "Name of the receiver."
+                          },
+                          "addressId": {
+                            "type": "string",
+                            "description": "Address ID.",
+                            "nullable": true
+                          },
+                          "isDisposable": {
+                            "type": "boolean",
+                            "description": "Indicates whether address is disposable."
+                          },
+                          "city": {
+                            "type": "string",
+                            "description": "City of the address."
+                          },
+                          "state": {
+                            "type": "string",
+                            "description": "State of the address."
+                          },
+                          "country": {
+                            "type": "string",
+                            "description": "Country of the address. ISO three-letter code."
+                          },
+                          "street": {
+                            "type": "string",
+                            "description": "Street of the address."
+                          },
+                          "number": {
+                            "type": "string",
+                            "description": "Number of the address."
+                          },
+                          "neighborhood": {
+                            "type": "string",
+                            "description": "Neighborhood of the address."
+                          },
+                          "complement": {
+                            "description": "Complement to the shipping address, in case it applies.",
+                            "type": "string",
+                            "nullable": true
+                          },
+                          "reference": {
+                            "type": "string",
+                            "description": "Reference that may help in the location of the address.",
+                            "nullable": true
+                          },
+                          "geoCoordinates": {
+                            "type": "array",
+                            "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                            "items": {
+                              "type": "number",
+                              "description": "Geocoordinates."
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "userType": {
+                      "type": "string",
+                      "description": "User type.",
+                      "nullable": true
+                    },
+                    "ignoreProfileData": {
+                      "type": "boolean",
+                      "description": "Ignore customer profile data."
+                    },
+                    "value": {
+                      "type": "integer",
+                      "description": "Total value of the order without separating cents. For example, $24.99 is represented as `2499`."
+                    },
+                    "messages": {
+                      "type": "array",
+                      "description": "Array containing an object for each message generated by our servers while processing the request.",
+                      "items": {
+                        "type": "string",
+                        "description": "Message."
+                      }
+                    },
+                    "items": {
+                      "type": "array",
+                      "description": "Information on each item in the order.",
+                      "items": {
+                        "description": "Item information.",
+                        "type": "object",
+                        "properties": {
+                          "uniqueId": {
+                            "type": "string",
+                            "description": "Unique ID."
+                          },
+                          "id": {
+                            "type": "string",
+                            "description": "ID of the item."
+                          },
+                          "productId": {
+                            "type": "string",
+                            "description": "Product ID."
+                          },
+                          "productRefId": {
+                            "type": "string",
+                            "description": "Product Ref ID."
+                          },
+                          "refId": {
+                            "type": "string",
+                            "description": "Ref ID."
+                          },
+                          "ean": {
+                            "type": "string",
+                            "description": "European Article Number.",
+                            "nullable": true
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Product name."
+                          },
+                          "skuName": {
+                            "type": "string",
+                            "description": "SKU name."
+                          },
+                          "modalType": {
+                            "type": "string",
+                            "description": "Modal type.",
+                            "nullable": true
+                          },
+                          "parentItemIndex": {
+                            "type": "integer",
+                            "description": "Parent item index.",
+                            "nullable": true
+                          },
+                          "parentAssemblyBinding": {
+                            "type": "string",
+                            "description": "Parent assembly binding.",
+                            "nullable": true
+                          },
+                          "priceValidUntil": {
+                            "type": "string",
+                            "description": "Price expiration date and time."
+                          },
+                          "tax": {
+                            "type": "integer",
+                            "description": "Tax value in cents."
+                          },
+                          "taxCode": {
+                            "type": "string",
+                            "description": "A unique identifier code assigned to a tax within the VTEX Admin."
+                          },
+                          "price": {
+                            "type": "integer",
+                            "description": "Price in cents."
+                          },
+                          "listPrice": {
+                            "type": "integer",
+                            "description": "List price in cents."
+                          },
+                          "manualPrice": {
+                            "type": "integer",
+                            "description": "Manual price in cents.",
+                            "nullable": true
+                          },
+                          "manualPriceAppliedBy": {
+                            "type": "string",
+                            "description": "User that applied the manual price, if that is the case.",
+                            "nullable": true
+                          },
+                          "sellingPrice": {
+                            "type": "integer",
+                            "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
+                          },
+                          "rewardValue": {
+                            "type": "integer",
+                            "description": "Reward value in cents."
+                          },
+                          "isGift": {
+                            "type": "boolean",
+                            "description": "Indicates whether item is a gift."
+                          },
+                          "additionalInfo": {
+                            "type": "object",
+                            "description": "Additional information.",
+                            "properties": {
+                              "dimension": {
+                                "type": "string",
+                                "description": "Dimension.",
+                                "nullable": true
+                              },
+                              "brandName": {
+                                "type": "string",
+                                "description": "Brand name."
+                              },
+                              "brandId": {
+                                "type": "string",
+                                "description": "Brand ID."
+                              },
+                              "offeringInfo": {
+                                "type": "string",
+                                "description": "Offering information.",
+                                "nullable": true
+                              },
+                              "offeringType": {
+                                "type": "string",
+                                "description": "Offering type.",
+                                "nullable": true
+                              },
+                              "offeringTypeId": {
+                                "type": "string",
+                                "description": "Offering type ID.",
+                                "nullable": true
+                              }
+                            }
+                          },
+                          "preSaleDate": {
+                            "type": "string",
+                            "description": "Presale date.",
+                            "nullable": true
+                          },
+                          "productCategoryIds": {
+                            "type": "string",
+                            "description": "Product category IDs."
+                          },
+                          "productCategories": {
+                            "type": "object",
+                            "description": "Object, where each field is an ID from `productCategoryIds`.",
+                            "properties": {
+                              "{ID}": {
+                                "type": "string",
+                                "description": "Product category corresponding to the ID in the field key."
+                              }
+                            }
+                          },
+                          "quantity": {
+                            "type": "integer",
+                            "description": "Quantity."
+                          },
+                          "seller": {
+                            "type": "string",
+                            "description": "Seller."
+                          },
+                          "sellerChain": {
+                            "type": "array",
+                            "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
+                            "items": {
+                              "type": "string",
+                              "description": "Seller."
+                            }
+                          },
+                          "imageUrl": {
+                            "type": "string",
+                            "description": "Image URL."
+                          },
+                          "detailUrl": {
+                            "type": "string",
+                            "description": "Detail URL."
+                          },
+                          "bundleItems": {
+                            "type": "array",
+                            "description": "Information on services sold along with the SKU. Example: a gift package.",
+                            "items": {
+                              "description": "Service information.",
+                              "type": "object",
+                              "properties": {
+                                "type": {
+                                  "type": "string",
+                                  "description": "Service type."
+                                },
+                                "id": {
+                                  "type": "integer",
+                                  "description": "Service identifier."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Service name."
+                                },
+                                "price": {
+                                  "type": "integer",
+                                  "description": "Service price in cents."
+                                }
+                              }
+                            }
+                          },
+                          "attachments": {
+                            "type": "array",
+                            "description": "Array containing information on attachments.",
+                            "items": {
+                              "type": "string",
+                              "description": "Attachment."
+                            }
+                          },
+                          "priceTags": {
+                            "type": "array",
+                            "description": "Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.",
+                            "items": {
+                              "description": "Price tag information.",
+                              "type": "object",
+                              "properties": {
+                                "identifier": {
+                                  "type": "string",
+                                  "description": "Promotion unique identifier.",
+                                  "nullable": true
+                                },
+                                "isPercentual": {
+                                  "type": "boolean",
+                                  "description": "Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\r\n- `type` indicates whether the tag refers to a discount or tax.\r\n- `where` specifies the context, either price or shipping.\r\n- `identifier` is the promotion ID.\r\n- `calculationId` is a hash that may vary with each price calculation."
+                                },
+                                "rawValue": {
+                                  "type": "number",
+                                  "description": "Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations."
+                                },
+                                "value": {
+                                  "type": "integer",
+                                  "description": "Price tag value representing either a promotion (value decrease) or a tax (value increase)."
+                                }
+                              }
+                            }
+                          },
+                          "availability": {
+                            "type": "string",
+                            "description": "Availability."
+                          },
+                          "measurementUnit": {
+                            "type": "string",
+                            "description": "Measurement unit."
+                          },
+                          "unitMultiplier": {
+                            "type": "integer",
+                            "description": "Unit multiplier."
+                          },
+                          "manufacturerCode": {
+                            "type": "string",
+                            "description": "Manufacturer code.",
+                            "nullable": true
+                          },
+                          "priceDefinition": {
+                            "type": "object",
+                            "description": "Price information for all units of a specific item.",
+                            "properties": {
+                              "calculatedSellingPrice": {
+                                "type": "integer",
+                                "description": "Item's calculated unitary selling price in cents."
+                              },
+                              "total": {
+                                "type": "integer",
+                                "description": "Total value for all units of the item in cents."
+                              },
+                              "sellingPrices": {
+                                "type": "array",
+                                "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
+                                "items": {
+                                  "description": "Rounding information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value in cents for that specific rounding."
+                                    },
+                                    "quantity": {
+                                      "type": "integer",
+                                      "description": "Rounding quantity, meaning how many items are rounded to this value."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "selectableGifts": {
+                      "type": "array",
+                      "description": "Array containing the data of the item selected as a gift.",
+                      "items": {
+                        "type": "string",
+                        "description": "Gift."
+                      }
+                    },
+                    "totalizers": {
+                      "type": "array",
+                      "description": "Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).",
+                      "items": {
+                        "type": "object",
+                        "description": "Totalizer of purchases."
+                      }
+                    },
+                    "shippingData": {
+                      "type": "object",
+                      "description": "Shipping information pertinent to the order.",
+                      "nullable": true,
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Address information.",
+                          "nullable": true,
+                          "properties": {
+                            "addressType": {
+                              "type": "string",
+                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                            },
+                            "receiverName": {
+                              "type": "string",
+                              "description": "Name of the person who is going to receive the order."
+                            },
+                            "addressId": {
+                              "type": "string",
+                              "description": "Address ID.",
+                              "nullable": true
+                            },
+                            "isDisposable": {
+                              "type": "boolean",
+                              "description": "Indicates whether address is disposable."
+                            },
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City of the shipping address."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State of the shipping address."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Three letter ISO code of the country of the shipping address."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street of the shipping address."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Number of the building, house or apartment in the shipping address."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood of the shipping address."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Complement to the shipping address, in case it applies.",
+                              "nullable": true
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                              "nullable": true
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                              "items": {
+                                "type": "number",
+                                "description": "Geocoordinates."
+                              }
+                            }
+                          }
+                        },
+                        "logisticsInfo": {
+                          "type": "array",
+                          "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.",
+                          "items": {
+                            "description": "Logistics information.",
+                            "type": "object",
+                            "properties": {
+                              "itemIndex": {
+                                "type": "integer",
+                                "description": "Index corresponding to the position of the object in the `items` array."
+                              },
+                              "selectedSla": {
+                                "type": "string",
+                                "description": "SLA selected by the customer.",
+                                "nullable": true
+                              },
+                              "selectedDeliveryChannel": {
+                                "type": "string",
+                                "description": "Delivery channel selected by the customer.",
+                                "nullable": true
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "slas": {
+                                "type": "array",
+                                "description": "Information on available SLAs.",
+                                "items": {
+                                  "description": "SLA information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "SLA ID."
+                                    },
+                                    "deliveryChannel": {
+                                      "type": "string",
+                                      "description": "Delivery channel."
+                                    },
+                                    "name": {
+                                      "type": "string",
+                                      "description": "SLA name."
+                                    },
+                                    "deliveryIds": {
+                                      "type": "array",
+                                      "description": "Information on each delivery ID.",
+                                      "items": {
+                                        "description": "Delivery ID information.",
+                                        "type": "object",
+                                        "properties": {
+                                          "courierId": {
+                                            "type": "string",
+                                            "description": "Courier ID."
+                                          },
+                                          "warehouseId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "dockId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "courierName": {
+                                            "type": "string",
+                                            "description": "Courier name."
+                                          },
+                                          "quantity": {
+                                            "type": "integer",
+                                            "description": "Quantity."
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "attachmentOfferings": {
+                                      "type": "array",
+                                      "description": "List of attachments details.",
+                                      "nullable": true,
+                                      "items": {
+                                        "description": "Attachment details.",
+                                        "type": "object",
+                                        "required": [
+                                          "name",
+                                          "required",
+                                          "schema"
+                                        ],
+                                        "properties": {
+                                          "name": {
+                                            "type": "string",
+                                            "description": "Name of the attachment.",
+                                            "nullable": true
+                                          },
+                                          "required": {
+                                            "type": "boolean",
+                                            "description": "Defines if the attachment is required (`true`) or not (`false`).",
+                                            "nullable": true
+                                          },
+                                          "schema": {
+                                            "type": "object",
+                                            "description": "Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).",
+                                            "nullable": true
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "shippingEstimate": {
+                                      "type": "string",
+                                      "description": "Shipping estimate. For instance, \"three business days\" will be represented as `3bd`."
+                                    },
+                                    "shippingEstimateDate": {
+                                      "type": "string",
+                                      "description": "When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.",
+                                      "nullable": true
+                                    },
+                                    "useIndividualShippingEstimates": {
+                                      "type": "boolean",
+                                      "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`."
+                                    },
+                                    "lockTTL": {
+                                      "type": "string",
+                                      "description": "Estimate date of delivery.",
+                                      "nullable": true
+                                    },
+                                    "price": {
+                                      "type": "integer",
+                                      "description": "Price in cents."
+                                    },
+                                    "listPrice": {
+                                      "type": "integer",
+                                      "description": "List price in cents."
+                                    },
+                                    "tax": {
+                                      "type": "integer",
+                                      "description": "Tax in cents."
+                                    },
+                                    "pickupStoreInfo": {
+                                      "type": "object",
+                                      "description": "Information on the pickup store.",
+                                      "properties": {
+                                        "isPickupStore": {
+                                          "type": "boolean",
+                                          "description": "Indicates whether it is the pickup store."
+                                        },
+                                        "friendlyName": {
+                                          "type": "string",
+                                          "description": "Friendly name.",
+                                          "nullable": true
+                                        },
+                                        "address": {
+                                          "type": "object",
+                                          "description": "Address information.",
+                                          "nullable": true,
+                                          "properties": {
+                                            "addressType": {
+                                              "type": "string",
+                                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                                            },
+                                            "postalCode": {
+                                              "type": "string",
+                                              "description": "Postal code."
+                                            },
+                                            "city": {
+                                              "type": "string",
+                                              "description": "City of the shipping address."
+                                            },
+                                            "state": {
+                                              "type": "string",
+                                              "description": "State of the shipping address."
+                                            },
+                                            "country": {
+                                              "type": "string",
+                                              "description": "Three letter ISO code of the country of the shipping address."
+                                            },
+                                            "street": {
+                                              "type": "string",
+                                              "description": "Street of the shipping address."
+                                            },
+                                            "number": {
+                                              "type": "string",
+                                              "description": "Number of the building, house or apartment in the shipping address."
+                                            },
+                                            "neighborhood": {
+                                              "type": "string",
+                                              "description": "Neighborhood of the shipping address."
+                                            },
+                                            "complement": {
+                                              "type": "string",
+                                              "description": "Complement to the shipping address, in case it applies.",
+                                              "nullable": true
+                                            },
+                                            "reference": {
+                                              "type": "string",
+                                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                              "nullable": true
+                                            },
+                                            "geoCoordinates": {
+                                              "type": "array",
+                                              "description": "Array with two strings that repesent geocoordinates: first latitude, then longitude.",
+                                              "items": {
+                                                "type": "number",
+                                                "description": "Geocoordinates."
+                                              }
+                                            }
+                                          }
+                                        },
+                                        "additionalInfo": {
+                                          "type": "string",
+                                          "description": "Additional information.",
+                                          "nullable": true
+                                        },
+                                        "dockId": {
+                                          "type": "string",
+                                          "description": "Corresponding dock ID.",
+                                          "nullable": true
+                                        }
+                                      }
+                                    },
+                                    "pickupPointId": {
+                                      "type": "string",
+                                      "description": "Pickup point ID.",
+                                      "nullable": true
+                                    },
+                                    "pickupDistance": {
+                                      "type": "integer",
+                                      "description": "Pickup point distance."
+                                    },
+                                    "polygonName": {
+                                      "type": "string",
+                                      "description": "Polygon name.",
+                                      "nullable": true
+                                    },
+                                    "transitTime": {
+                                      "type": "string",
+                                      "description": "Transit time. For instance, \"three business days\" is represented as `3bd`."
+                                    }
+                                  }
+                                }
+                              },
+                              "shipsTo": {
+                                "type": "array",
+                                "description": "List of countries that the item may be shipped to.",
+                                "items": {
+                                  "type": "string",
+                                  "description": "Three letter country code."
+                                }
+                              },
+                              "itemId": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "deliveryChannels": {
+                                "type": "array",
+                                "description": "List of available delivery channels.",
+                                "items": {
+                                  "description": "Delivery channel information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "Delivery channel ID."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "selectedAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the selected addresses for the order.",
+                          "items": {
+                            "description": "Selected address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "availableAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the available addresses for the order.",
+                          "items": {
+                            "description": "Available address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "clientProfileData": {
+                      "type": "object",
+                      "description": "Customer's profile information.",
+                      "nullable": true,
+                      "properties": {
+                        "email": {
+                          "type": "string",
+                          "description": "Email address.",
+                          "nullable": true
+                        },
+                        "firstName": {
+                          "type": "string",
+                          "description": "First name.",
+                          "nullable": true
+                        },
+                        "lastName": {
+                          "type": "string",
+                          "description": "Last name."
+                        },
+                        "documentType": {
+                          "type": "string",
+                          "description": "Type of the document informed by the customer."
+                        },
+                        "document": {
+                          "type": "string",
+                          "description": "Document informed by the customer."
+                        },
+                        "phone": {
+                          "type": "string",
+                          "description": "Phone number."
+                        },
+                        "corporateName": {
+                          "type": "string",
+                          "description": "Company name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "tradeName": {
+                          "type": "string",
+                          "description": "Trade name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporateDocument": {
+                          "type": "string",
+                          "description": "Corporate document, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "stateInscription": {
+                          "type": "string",
+                          "description": "State inscription, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporatePhone": {
+                          "type": "string",
+                          "description": "Corporate phone number, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "isCorporate": {
+                          "type": "boolean",
+                          "description": "Indicates whether the customer is a legal entity."
+                        },
+                        "profileCompleteOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile is complete on loading."
+                        },
+                        "profileErrorOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile presents error on loading.",
+                          "nullable": true
+                        },
+                        "customerClass": {
+                          "type": "string",
+                          "description": "Customer class.",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "paymentData": {
+                      "type": "object",
+                      "description": "Information on the order's payment.",
+                      "properties": {
+                        "giftCards": {
+                          "type": "array",
+                          "description": "Gift card information, if it applies to the order.",
+                          "items": {
+                            "description": "Gift card information.",
+                            "type": "object",
+                            "properties": {
+                              "redemptionCode": {
+                                "type": "string",
+                                "description": "Gift card redemption code."
+                              },
+                              "value": {
+                                "type": "integer",
+                                "description": "Gift card value in cents."
+                              },
+                              "balance": {
+                                "type": "integer",
+                                "description": "Gift card balance in cents."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Gift card name."
+                              },
+                              "id": {
+                                "type": "string",
+                                "description": "Gift card ID."
+                              },
+                              "inUse": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is in use."
+                              },
+                              "isSpecialCard": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is special."
+                              }
+                            }
+                          }
+                        },
+                        "transactions": {
+                          "type": "array",
+                          "description": "Information on each transaction pertinent to the order.",
+                          "items": {
+                            "description": "Transaction information.",
+                            "nullable": true,
+                            "type": "object",
+                            "properties": {
+                              "isActive": {
+                                "type": "boolean",
+                                "description": "Indicates whether transaction is active."
+                              },
+                              "transactionId": {
+                                "type": "string",
+                                "description": "Transaction ID."
+                              },
+                              "merchantName": {
+                                "type": "string",
+                                "description": "Merchant name."
+                              },
+                              "payments": {
+                                "type": "array",
+                                "description": "Information on each payment.",
+                                "items": {
+                                  "description": "Payment information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "accountId": {
+                                      "type": "string",
+                                      "description": "Account ID."
+                                    },
+                                    "bin": {
+                                      "type": "string",
+                                      "description": "Bin.",
+                                      "nullable": true
+                                    },
+                                    "installments": {
+                                      "type": "integer",
+                                      "description": "Number of installments."
+                                    },
+                                    "paymentSystem": {
+                                      "type": "string",
+                                      "description": "Payment system."
+                                    },
+                                    "referenceValue": {
+                                      "type": "integer",
+                                      "description": "Reference value for calculating interest rates, in case it applies. Displayed in cents."
+                                    },
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value including interest, in case it applies. Displayed in cents."
+                                    }
+                                  }
+                                }
+                              },
+                              "sharedTransaction": {
+                                "type": "boolean",
+                                "description": "Indicates whather transaction is shared."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "marketingData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Object containing promotion data such as coupon tracking information and internal or external UTMs.",
+                      "properties": {
+                        "coupon": {
+                          "type": "string",
+                          "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.",
+                          "example": "free-shipping"
+                        },
+                        "utmSource": {
+                          "type": "string",
+                          "description": "UTM source.",
+                          "example": "Facebook"
+                        },
+                        "utmMedium": {
+                          "type": "string",
+                          "description": "UTM medium.",
+                          "example": "CPC"
+                        },
+                        "utmCampaign": {
+                          "type": "string",
+                          "description": "UTM campaign.",
+                          "example": "Black friday"
+                        },
+                        "utmiPage": {
+                          "type": "string",
+                          "description": "utmi_page (internal utm).",
+                          "example": "utmi_page-example",
+                          "nullable": true
+                        },
+                        "utmiPart": {
+                          "type": "string",
+                          "description": "utmi_part (internal utm).",
+                          "example": "utmi_part-example",
+                          "nullable": true
+                        },
+                        "utmiCampaign": {
+                          "type": "string",
+                          "description": "utmi_campaign (internal utm).",
+                          "example": "utmi_campaign-example",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "sellers": {
+                      "type": "array",
+                      "description": "Information on each seller.",
+                      "items": {
+                        "description": "Seller information.",
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "Seller ID."
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Seller name."
+                          },
+                          "logo": {
+                            "type": "string",
+                            "description": "Seller logo.",
+                            "nullable": true
+                          }
+                        }
+                      }
+                    },
+                    "clientPreferencesData": {
+                      "type": "object",
+                      "description": "Object containing preferences from the client who placed the order.",
+                      "properties": {
+                        "locale": {
+                          "type": "string",
+                          "description": "Client's locale. Examples: `pt-BR` and `en-US`."
+                        },
+                        "optinNewsLetter": {
+                          "type": "boolean",
+                          "description": "`true` if the client opted to receive newsletter from the store.",
+                          "example": false,
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "commercialConditionData": {
+                      "type": "object",
+                      "description": "Object containing commercial condition information.",
+                      "nullable": true
+                    },
+                    "storePreferencesData": {
+                      "type": "object",
+                      "description": "Object containing data from the store's configuration (stored in VTEX's License Manager)."
+                    },
+                    "giftRegistryData": {
+                      "type": "object",
+                      "description": "Gift registry list information.",
+                      "nullable": true
+                    },
+                    "openTextField": {
+                      "type": "string",
+                      "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).",
+                      "example": "open-text-example",
+                      "nullable": true
+                    },
+                    "invoiceData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Invoice data including billing address.",
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Billing address.",
+                          "properties": {
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City name."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State name."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Country."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street name."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Street number."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Address complement."
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Reference for location."
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Geographic coordinates (latitude, longitude).",
+                              "items": {
+                                "type": "number"
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "customData": {
+                      "type": "object",
+                      "description": "Customer additional information.",
+                      "nullable": true
+                    },
+                    "itemMetadata": {
+                      "type": "object",
+                      "description": "Item metadata.",
+                      "properties": {
+                        "items": {
+                          "type": "array",
+                          "description": "List of objects containing metadata on each item in the order.",
+                          "items": {
+                            "description": "Item metadata.",
+                            "type": "object",
+                            "properties": {
+                              "id": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "seller": {
+                                "type": "string",
+                                "description": "Seller."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Product name."
+                              },
+                              "skuName": {
+                                "type": "string",
+                                "description": "SKU name."
+                              },
+                              "productId": {
+                                "type": "string",
+                                "description": "Product ID."
+                              },
+                              "refId": {
+                                "type": "string",
+                                "description": "Ref ID."
+                              },
+                              "ean": {
+                                "type": "string",
+                                "description": "European Article Number.",
+                                "nullable": true
+                              },
+                              "imageUrl": {
+                                "type": "string",
+                                "description": "Image URL."
+                              },
+                              "detailUrl": {
+                                "type": "string",
+                                "description": "Detail URL."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "hooksData": {
+                      "type": "object",
+                      "description": "Hooks information.",
+                      "nullable": true
+                    },
+                    "ratesAndBenefitsData": {
+                      "type": "object",
+                      "description": "Information on rates and benefits that apply to the order.",
+                      "properties": {
+                        "rateAndBenefitsIdentifiers": {
+                          "type": "array",
+                          "description": "List with rates and benefits identifiers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit identifier."
+                          }
+                        },
+                        "teaser": {
+                          "type": "array",
+                          "description": "List with rates and benefits teasers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit teaser."
+                          }
+                        }
+                      }
+                    },
+                    "subscriptionData": {
+                      "type": "object",
+                      "description": "Subscription information.",
+                      "nullable": true
+                    },
+                    "itemsOrdination": {
+                      "type": "object",
+                      "description": "Object containing information about the ordering of items within the `orderForm`.",
+                      "properties": {
+                        "criteria": {
+                          "type": "string",
+                          "description": "Criteria adopted to order the items in the list."
+                        },
+                        "ascending": {
+                          "type": "boolean",
+                          "description": "Indicates whether the ordering is ascending."
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "delete": {
+        "tags": [
+          "Custom data"
+        ],
+        "summary": "Remove single custom field value",
+        "description": "Your account may create `apps`, which contain custom fields, through the [Update orderForm configuration](https://developers.vtex.com/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.\n\r\n\rTo do that, you need to inform in the URL the ID of the app you created with the configuration API (`appId`).\n\r\n\rYou also need to iform the specific field created in this app (identified by the `appFieldName` parameter, also passed through the URL) whose value you want to remove.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "Removesinglecustomfieldvalue",
+        "security": [],
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "orderFormId",
+            "in": "path",
+            "description": "The ID of the orderForm from which you want to remove the custom field value.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "29154e27383145cc8ce1f7a1df0d99c4"
+            }
+          },
+          {
+            "name": "appId",
+            "in": "path",
+            "description": "ID of the app created through the Update orderForm Configuration endpoint.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "appId"
+            }
+          },
+          {
+            "name": "appFieldName",
+            "in": "path",
+            "description": "Name of the app's field created through the Update orderForm Configuration endpoint and which will be deleted.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "appFieldName"
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "example": {
+                  "orderFormId": "ede846222cd44046ba6c638442c3505a",
+                  "salesChannel": "1",
+                  "loggedIn": false,
+                  "isCheckedIn": false,
+                  "storeId": "1",
+                  "checkedInPickupPointId": "21",
+                  "allowManualPrice": false,
+                  "canEditData": true,
+                  "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
+                  "userType": "User type",
+                  "ignoreProfileData": false,
+                  "value": 10000,
+                  "messages": [],
+                  "items": [
+                    {
+                      "uniqueId": "E0F2B7AF5CD74D668F1E27537206912C",
+                      "id": "1",
+                      "productId": "1",
+                      "productRefId": "1",
+                      "refId": "0001",
+                      "ean": "123456789",
+                      "name": "Ração Royal Canin Feline Urinary 500g",
+                      "skuName": "Ração Royal Canin Feline Urinary 500g",
+                      "modalType": null,
+                      "parentItemIndex": null,
+                      "parentAssemblyBinding": null,
+                      "assemblies": [],
+                      "priceValidUntil": "2021-02-27T14:59:00.8288784Z",
+                      "tax": 0,
+                      "price": 15000,
+                      "listPrice": 30000,
+                      "manualPrice": 10000,
+                      "sellingPrice": 10000,
+                      "rewardValue": 0,
+                      "isGift": false,
+                      "additionalInfo": {
+                        "brandName": "Royal Canin",
+                        "brandId": "2000000",
+                        "offeringInfo": null,
+                        "offeringType": null,
+                        "offeringTypeId": null
+                      },
+                      "preSaleDate": null,
+                      "productCategoryIds": "/1/10/",
+                      "productCategories": {
+                        "1": "Alimentação",
+                        "10": "Ração Seca"
+                      },
+                      "quantity": 1,
+                      "seller": "1",
+                      "sellerChain": [
+                        "1"
+                      ],
+                      "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
+                      "detailUrl": "/racao-royal-canin-feline-urinary/p",
+                      "components": [],
+                      "bundleItems": [],
+                      "attachments": [],
+                      "attachmentOfferings": [
+                        {
+                          "name": "vtex.subscription.weekly",
+                          "required": false,
+                          "schema": {
+                            "vtex.subscription.key.frequency": {
+                              "MaximumNumberOfCharacters": 7,
+                              "Domain": [
+                                "1 week",
+                                "2 week",
+                                "3 week",
+                                "4 week"
+                              ]
+                            }
+                          }
+                        },
+                        {
+                          "name": "vtex.subscription.daily",
+                          "required": false,
+                          "schema": {
+                            "vtex.subscription.key.frequency": {
+                              "MaximumNumberOfCharacters": 5,
+                              "Domain": [
+                                "1 day"
+                              ]
+                            }
+                          }
+                        }
+                      ],
+                      "offerings": [],
+                      "priceTags": [
+                        {
+                          "name": "DISCOUNT@MANUALPRICE",
+                          "value": -5000,
+                          "rawValue": -50,
+                          "isPercentual": false,
+                          "identifier": null
+                        }
+                      ],
+                      "availability": "available",
+                      "measurementUnit": "un",
+                      "unitMultiplier": 1,
+                      "manufacturerCode": null
+                    }
+                  ],
+                  "selectableGifts": [],
+                  "totalizers": [
+                    {
+                      "id": "Items",
+                      "name": "Total dos Itens",
+                      "value": 15000
+                    },
+                    {
+                      "id": "Discounts",
+                      "name": "Total dos Descontos",
+                      "value": -5000
+                    }
+                  ],
+                  "shippingData": {
+                    "address": null,
+                    "logisticsInfo": [
+                      {
+                        "itemIndex": 0,
+                        "selectedSla": "Normal",
+                        "selectedDeliveryChannel": "delivery",
+                        "addressId": "666c2e830bd9474ab6f6cc53fb6dd2d2",
+                        "slas": [],
+                        "shipsTo": [
+                          "BRA"
+                        ],
+                        "itemId": "1",
+                        "deliveryChannels": [
+                          {
+                            "id": "pickup-in-point"
+                          },
+                          {
+                            "id": "delivery"
+                          }
+                        ]
+                      }
+                    ],
+                    "selectedAddresses": [],
+                    "availableAddresses": [],
+                    "pickupPoints": []
+                  },
+                  "clientProfileData": null,
+                  "paymentData": {
+                    "installmentOptions": [
+                      {
+                        "paymentSystem": 2,
+                        "bin": null,
+                        "paymentName": null,
+                        "paymentGroupName": null,
+                        "value": 10000,
+                        "installments": [
+                          {
+                            "count": 1,
+                            "hasInterestRate": false,
+                            "interestRate": 0,
+                            "value": 10000,
+                            "total": 10000,
+                            "sellerMerchantInstallments": [
+                              {
+                                "id": "LOJADOBRENO",
+                                "count": 1,
+                                "hasInterestRate": false,
+                                "interestRate": 0,
+                                "value": 10000,
+                                "total": 10000
+                              }
+                            ]
+                          },
+                          {
+                            "count": 2,
+                            "hasInterestRate": false,
+                            "interestRate": 0,
+                            "value": 5000,
+                            "total": 10000,
+                            "sellerMerchantInstallments": [
+                              {
+                                "id": "LOJADOBRENO",
+                                "count": 2,
+                                "hasInterestRate": false,
+                                "interestRate": 0,
+                                "value": 5000,
+                                "total": 10000
+                              }
+                            ]
+                          }
+                        ]
+                      }
+                    ],
+                    "paymentSystems": [
+                      {
+                        "id": 2,
+                        "name": "Visa",
+                        "groupName": "creditCardPaymentGroup",
+                        "validator": {
+                          "regex": "^4[0-9]{15}$",
+                          "mask": "9999 9999 9999 9999",
+                          "cardCodeRegex": "^[0-9]{3}$",
+                          "cardCodeMask": "999",
+                          "weights": [
+                            2,
+                            1,
+                            2,
+                            1,
+                            2
+                          ],
+                          "useCvv": true,
+                          "useExpirationDate": true,
+                          "useCardHolderName": true,
+                          "useBillingAddress": true
+                        },
+                        "stringId": "2",
+                        "template": "creditCardPaymentGroup-template",
+                        "requiresDocument": false,
+                        "isCustom": false,
+                        "description": "Payment description",
+                        "requiresAuthentication": false,
+                        "dueDate": "2020-03-05T16:42:31.7836281Z",
+                        "availablePayments": null
+                      }
+                    ],
+                    "payments": [
+                      {
+                        "paymentSystem": 6,
+                        "bin": null,
+                        "accountId": "12",
+                        "tokenId": null,
+                        "value": 34390,
+                        "referenceValue": 34390,
+                        "giftCardRedemptionCode": null,
+                        "giftCardProvider": null,
+                        "giftCardId": null
+                      }
+                    ],
+                    "giftCards": [],
+                    "giftCardMessages": [],
+                    "availableAccounts": [],
+                    "availableTokens": []
+                  },
+                  "marketingData": null,
+                  "sellers": [
+                    {
+                      "id": "1",
+                      "name": "lojadobreno",
+                      "logo": "Logo"
+                    }
+                  ],
+                  "clientPreferencesData": {
+                    "locale": "pt-BR",
+                    "optinNewsLetter": null
+                  },
+                  "commercialConditionData": null,
+                  "storePreferencesData": {
+                    "countryCode": "BRA",
+                    "saveUserData": true,
+                    "timeZone": "E. South America Standard Time",
+                    "currencyCode": "BRL",
+                    "currencyLocale": 1046,
+                    "currencySymbol": "R$",
+                    "currencyFormatInfo": {
+                      "currencyDecimalDigits": 2,
+                      "currencyDecimalSeparator": ",",
+                      "currencyGroupSeparator": ".",
+                      "currencyGroupSize": 3,
+                      "startsWithCurrencySymbol": true
+                    }
+                  },
+                  "giftRegistryData": null,
+                  "openTextField": null,
+                  "invoiceData": null,
+                  "customData": {
+                    "customApps": [
+                      {
+                        "fields": {
+                          "testField2": "testValue2"
+                        },
+                        "id": "abcd",
+                        "major": 1
+                      }
+                    ]
+                  },
+                  "itemMetadata": {
+                    "items": [
+                      {
+                        "id": "1",
+                        "seller": "1",
+                        "name": "Ração Royal Canin Feline Urinary 500g",
+                        "skuName": "Ração Royal Canin Feline Urinary 500g",
+                        "productId": "1",
+                        "refId": "0001",
+                        "ean": "123456789",
+                        "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
+                        "detailUrl": "/racao-royal-canin-feline-urinary/p",
+                        "assemblyOptions": []
+                      }
+                    ]
+                  },
+                  "hooksData": null,
+                  "ratesAndBenefitsData": {
+                    "rateAndBenefitsIdentifiers": [],
+                    "teaser": []
+                  },
+                  "subscriptionData": null,
+                  "itemsOrdination": {
+                    "criteria": "NAME",
+                    "ascending": true
+                  }
+                },
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "orderFormId": {
+                      "type": "string",
+                      "description": "ID of the orderForm corresponding to a specific cart."
+                    },
+                    "salesChannel": {
+                      "type": "string",
+                      "description": "Attribute created by the seller, in their VTEX store configuration."
+                    },
+                    "loggedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether the user is logged into the store."
+                    },
+                    "isCheckedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether order is checked in."
+                    },
+                    "storeId": {
+                      "type": "string",
+                      "description": "ID of the store.",
+                      "nullable": true
+                    },
+                    "allowManualPrice": {
+                      "type": "boolean",
+                      "description": "Permission to modify item price manually."
+                    },
+                    "canEditData": {
+                      "type": "boolean",
+                      "description": "Data can be edited."
+                    },
+                    "userProfileId": {
+                      "type": "string",
+                      "description": "Unique ID associated with the customer profile."
+                    },
+                    "profileProvider": {
+                      "type": "string",
+                      "description": "Profile provider."
+                    },
+                    "availableAccounts": {
+                      "type": "array",
+                      "description": "Available accounts.",
+                      "items": {
+                        "type": "string",
+                        "description": "Account."
+                      }
+                    },
+                    "availableAddresses": {
+                      "type": "array",
+                      "description": "Information on each available address.",
+                      "items": {
+                        "description": "Address information.",
+                        "type": "object",
+                        "properties": {
+                          "addressType": {
+                            "type": "string",
+                            "description": "Address type."
+                          },
+                          "receiverName": {
+                            "type": "string",
+                            "description": "Name of the receiver."
+                          },
+                          "addressId": {
+                            "type": "string",
+                            "description": "Address ID.",
+                            "nullable": true
+                          },
+                          "isDisposable": {
+                            "type": "boolean",
+                            "description": "Indicates whether address is disposable."
+                          },
+                          "city": {
+                            "type": "string",
+                            "description": "City of the address."
+                          },
+                          "state": {
+                            "type": "string",
+                            "description": "State of the address."
+                          },
+                          "country": {
+                            "type": "string",
+                            "description": "Country of the address. ISO three-letter code."
+                          },
+                          "street": {
+                            "type": "string",
+                            "description": "Street of the address."
+                          },
+                          "number": {
+                            "type": "string",
+                            "description": "Number of the address."
+                          },
+                          "neighborhood": {
+                            "type": "string",
+                            "description": "Neighborhood of the address."
+                          },
+                          "complement": {
+                            "description": "Complement to the shipping address, in case it applies.",
+                            "type": "string",
+                            "nullable": true
+                          },
+                          "reference": {
+                            "type": "string",
+                            "description": "Reference that may help in the location of the address.",
+                            "nullable": true
+                          },
+                          "geoCoordinates": {
+                            "type": "array",
+                            "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                            "items": {
+                              "type": "number",
+                              "description": "Geocoordinates."
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "userType": {
+                      "type": "string",
+                      "description": "User type.",
+                      "nullable": true
+                    },
+                    "ignoreProfileData": {
+                      "type": "boolean",
+                      "description": "Ignore customer profile data."
+                    },
+                    "value": {
+                      "type": "integer",
+                      "description": "Total value of the order without separating cents. For example, $24.99 is represented as `2499`."
+                    },
+                    "messages": {
+                      "type": "array",
+                      "description": "Array containing an object for each message generated by our servers while processing the request.",
+                      "items": {
+                        "type": "string",
+                        "description": "Message."
+                      }
+                    },
+                    "items": {
+                      "type": "array",
+                      "description": "Information on each item in the order.",
+                      "items": {
+                        "description": "Item information.",
+                        "type": "object",
+                        "properties": {
+                          "uniqueId": {
+                            "type": "string",
+                            "description": "Unique ID."
+                          },
+                          "id": {
+                            "type": "string",
+                            "description": "ID of the item."
+                          },
+                          "productId": {
+                            "type": "string",
+                            "description": "Product ID."
+                          },
+                          "productRefId": {
+                            "type": "string",
+                            "description": "Product Ref ID."
+                          },
+                          "refId": {
+                            "type": "string",
+                            "description": "Ref ID."
+                          },
+                          "ean": {
+                            "type": "string",
+                            "description": "European Article Number.",
+                            "nullable": true
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Product name."
+                          },
+                          "skuName": {
+                            "type": "string",
+                            "description": "SKU name."
+                          },
+                          "modalType": {
+                            "type": "string",
+                            "description": "Modal type.",
+                            "nullable": true
+                          },
+                          "parentItemIndex": {
+                            "type": "integer",
+                            "description": "Parent item index.",
+                            "nullable": true
+                          },
+                          "parentAssemblyBinding": {
+                            "type": "string",
+                            "description": "Parent assembly binding.",
+                            "nullable": true
+                          },
+                          "priceValidUntil": {
+                            "type": "string",
+                            "description": "Price expiration date and time."
+                          },
+                          "tax": {
+                            "type": "integer",
+                            "description": "Tax value in cents."
+                          },
+                          "taxCode": {
+                            "type": "string",
+                            "description": "A unique identifier code assigned to a tax within the VTEX Admin."
+                          },
+                          "price": {
+                            "type": "integer",
+                            "description": "Price in cents."
+                          },
+                          "listPrice": {
+                            "type": "integer",
+                            "description": "List price in cents."
+                          },
+                          "manualPrice": {
+                            "type": "integer",
+                            "description": "Manual price in cents.",
+                            "nullable": true
+                          },
+                          "manualPriceAppliedBy": {
+                            "type": "string",
+                            "description": "User that applied the manual price, if that is the case.",
+                            "nullable": true
+                          },
+                          "sellingPrice": {
+                            "type": "integer",
+                            "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
+                          },
+                          "rewardValue": {
+                            "type": "integer",
+                            "description": "Reward value in cents."
+                          },
+                          "isGift": {
+                            "type": "boolean",
+                            "description": "Indicates whether item is a gift."
+                          },
+                          "additionalInfo": {
+                            "type": "object",
+                            "description": "Additional information.",
+                            "properties": {
+                              "dimension": {
+                                "type": "string",
+                                "description": "Dimension.",
+                                "nullable": true
+                              },
+                              "brandName": {
+                                "type": "string",
+                                "description": "Brand name."
+                              },
+                              "brandId": {
+                                "type": "string",
+                                "description": "Brand ID."
+                              },
+                              "offeringInfo": {
+                                "type": "string",
+                                "description": "Offering information.",
+                                "nullable": true
+                              },
+                              "offeringType": {
+                                "type": "string",
+                                "description": "Offering type.",
+                                "nullable": true
+                              },
+                              "offeringTypeId": {
+                                "type": "string",
+                                "description": "Offering type ID.",
+                                "nullable": true
+                              }
+                            }
+                          },
+                          "preSaleDate": {
+                            "type": "string",
+                            "description": "Presale date.",
+                            "nullable": true
+                          },
+                          "productCategoryIds": {
+                            "type": "string",
+                            "description": "Product category IDs."
+                          },
+                          "productCategories": {
+                            "type": "object",
+                            "description": "Object, where each field is an ID from `productCategoryIds`.",
+                            "properties": {
+                              "{ID}": {
+                                "type": "string",
+                                "description": "Product category corresponding to the ID in the field key."
+                              }
+                            }
+                          },
+                          "quantity": {
+                            "type": "integer",
+                            "description": "Quantity."
+                          },
+                          "seller": {
+                            "type": "string",
+                            "description": "Seller."
+                          },
+                          "sellerChain": {
+                            "type": "array",
+                            "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
+                            "items": {
+                              "type": "string",
+                              "description": "Seller."
+                            }
+                          },
+                          "imageUrl": {
+                            "type": "string",
+                            "description": "Image URL."
+                          },
+                          "detailUrl": {
+                            "type": "string",
+                            "description": "Detail URL."
+                          },
+                          "bundleItems": {
+                            "type": "array",
+                            "description": "Information on services sold along with the SKU. Example: a gift package.",
+                            "items": {
+                              "description": "Service information.",
+                              "type": "object",
+                              "properties": {
+                                "type": {
+                                  "type": "string",
+                                  "description": "Service type."
+                                },
+                                "id": {
+                                  "type": "integer",
+                                  "description": "Service identifier."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Service name."
+                                },
+                                "price": {
+                                  "type": "integer",
+                                  "description": "Service price in cents."
+                                }
+                              }
+                            }
+                          },
+                          "attachments": {
+                            "type": "array",
+                            "description": "Array containing information on attachments.",
+                            "items": {
+                              "type": "string",
+                              "description": "Attachment."
+                            }
+                          },
+                          "priceTags": {
+                            "type": "array",
+                            "description": "Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.",
+                            "items": {
+                              "description": "Price tag information.",
+                              "type": "object",
+                              "properties": {
+                                "identifier": {
+                                  "type": "string",
+                                  "description": "Promotion unique identifier.",
+                                  "nullable": true
+                                },
+                                "isPercentual": {
+                                  "type": "boolean",
+                                  "description": "Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\r\n- `type` indicates whether the tag refers to a discount or tax.\r\n- `where` specifies the context, either price or shipping.\r\n- `identifier` is the promotion ID.\r\n- `calculationId` is a hash that may vary with each price calculation."
+                                },
+                                "rawValue": {
+                                  "type": "number",
+                                  "description": "Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations."
+                                },
+                                "value": {
+                                  "type": "integer",
+                                  "description": "Price tag value representing either a promotion (value decrease) or a tax (value increase)."
+                                }
+                              }
+                            }
+                          },
+                          "availability": {
+                            "type": "string",
+                            "description": "Availability."
+                          },
+                          "measurementUnit": {
+                            "type": "string",
+                            "description": "Measurement unit."
+                          },
+                          "unitMultiplier": {
+                            "type": "integer",
+                            "description": "Unit multiplier."
+                          },
+                          "manufacturerCode": {
+                            "type": "string",
+                            "description": "Manufacturer code.",
+                            "nullable": true
+                          },
+                          "priceDefinition": {
+                            "type": "object",
+                            "description": "Price information for all units of a specific item.",
+                            "properties": {
+                              "calculatedSellingPrice": {
+                                "type": "integer",
+                                "description": "Item's calculated unitary selling price in cents."
+                              },
+                              "total": {
+                                "type": "integer",
+                                "description": "Total value for all units of the item in cents."
+                              },
+                              "sellingPrices": {
+                                "type": "array",
+                                "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
+                                "items": {
+                                  "description": "Rounding information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value in cents for that specific rounding."
+                                    },
+                                    "quantity": {
+                                      "type": "integer",
+                                      "description": "Rounding quantity, meaning how many items are rounded to this value."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "selectableGifts": {
+                      "type": "array",
+                      "description": "Array containing the data of the item selected as a gift.",
+                      "items": {
+                        "type": "string",
+                        "description": "Gift."
+                      }
+                    },
+                    "totalizers": {
+                      "type": "array",
+                      "description": "Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).",
+                      "items": {
+                        "type": "object",
+                        "description": "Totalizer of purchases."
+                      }
+                    },
+                    "shippingData": {
+                      "type": "object",
+                      "description": "Shipping information pertinent to the order.",
+                      "nullable": true,
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Address information.",
+                          "nullable": true,
+                          "properties": {
+                            "addressType": {
+                              "type": "string",
+                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                            },
+                            "receiverName": {
+                              "type": "string",
+                              "description": "Name of the person who is going to receive the order."
+                            },
+                            "addressId": {
+                              "type": "string",
+                              "description": "Address ID.",
+                              "nullable": true
+                            },
+                            "isDisposable": {
+                              "type": "boolean",
+                              "description": "Indicates whether address is disposable."
+                            },
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City of the shipping address."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State of the shipping address."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Three letter ISO code of the country of the shipping address."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street of the shipping address."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Number of the building, house or apartment in the shipping address."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood of the shipping address."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Complement to the shipping address, in case it applies.",
+                              "nullable": true
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                              "nullable": true
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                              "items": {
+                                "type": "number",
+                                "description": "Geocoordinates."
+                              }
+                            }
+                          }
+                        },
+                        "logisticsInfo": {
+                          "type": "array",
+                          "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.",
+                          "items": {
+                            "description": "Logistics information.",
+                            "type": "object",
+                            "properties": {
+                              "itemIndex": {
+                                "type": "integer",
+                                "description": "Index corresponding to the position of the object in the `items` array."
+                              },
+                              "selectedSla": {
+                                "type": "string",
+                                "description": "SLA selected by the customer.",
+                                "nullable": true
+                              },
+                              "selectedDeliveryChannel": {
+                                "type": "string",
+                                "description": "Delivery channel selected by the customer.",
+                                "nullable": true
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "slas": {
+                                "type": "array",
+                                "description": "Information on available SLAs.",
+                                "items": {
+                                  "description": "SLA information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "SLA ID."
+                                    },
+                                    "deliveryChannel": {
+                                      "type": "string",
+                                      "description": "Delivery channel."
+                                    },
+                                    "name": {
+                                      "type": "string",
+                                      "description": "SLA name."
+                                    },
+                                    "deliveryIds": {
+                                      "type": "array",
+                                      "description": "Information on each delivery ID.",
+                                      "items": {
+                                        "description": "Delivery ID information.",
+                                        "type": "object",
+                                        "properties": {
+                                          "courierId": {
+                                            "type": "string",
+                                            "description": "Courier ID."
+                                          },
+                                          "warehouseId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "dockId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "courierName": {
+                                            "type": "string",
+                                            "description": "Courier name."
+                                          },
+                                          "quantity": {
+                                            "type": "integer",
+                                            "description": "Quantity."
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "attachmentOfferings": {
+                                      "type": "array",
+                                      "description": "List of attachments details.",
+                                      "nullable": true,
+                                      "items": {
+                                        "description": "Attachment details.",
+                                        "type": "object",
+                                        "required": [
+                                          "name",
+                                          "required",
+                                          "schema"
+                                        ],
+                                        "properties": {
+                                          "name": {
+                                            "type": "string",
+                                            "description": "Name of the attachment.",
+                                            "nullable": true
+                                          },
+                                          "required": {
+                                            "type": "boolean",
+                                            "description": "Defines if the attachment is required (`true`) or not (`false`).",
+                                            "nullable": true
+                                          },
+                                          "schema": {
+                                            "type": "object",
+                                            "description": "Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).",
+                                            "nullable": true
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "shippingEstimate": {
+                                      "type": "string",
+                                      "description": "Shipping estimate. For instance, \"three business days\" will be represented as `3bd`."
+                                    },
+                                    "shippingEstimateDate": {
+                                      "type": "string",
+                                      "description": "When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.",
+                                      "nullable": true
+                                    },
+                                    "useIndividualShippingEstimates": {
+                                      "type": "boolean",
+                                      "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`."
+                                    },
+                                    "lockTTL": {
+                                      "type": "string",
+                                      "description": "Estimate date of delivery.",
+                                      "nullable": true
+                                    },
+                                    "price": {
+                                      "type": "integer",
+                                      "description": "Price in cents."
+                                    },
+                                    "listPrice": {
+                                      "type": "integer",
+                                      "description": "List price in cents."
+                                    },
+                                    "tax": {
+                                      "type": "integer",
+                                      "description": "Tax in cents."
+                                    },
+                                    "pickupStoreInfo": {
+                                      "type": "object",
+                                      "description": "Information on the pickup store.",
+                                      "properties": {
+                                        "isPickupStore": {
+                                          "type": "boolean",
+                                          "description": "Indicates whether it is the pickup store."
+                                        },
+                                        "friendlyName": {
+                                          "type": "string",
+                                          "description": "Friendly name.",
+                                          "nullable": true
+                                        },
+                                        "address": {
+                                          "type": "object",
+                                          "description": "Address information.",
+                                          "nullable": true,
+                                          "properties": {
+                                            "addressType": {
+                                              "type": "string",
+                                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                                            },
+                                            "postalCode": {
+                                              "type": "string",
+                                              "description": "Postal code."
+                                            },
+                                            "city": {
+                                              "type": "string",
+                                              "description": "City of the shipping address."
+                                            },
+                                            "state": {
+                                              "type": "string",
+                                              "description": "State of the shipping address."
+                                            },
+                                            "country": {
+                                              "type": "string",
+                                              "description": "Three letter ISO code of the country of the shipping address."
+                                            },
+                                            "street": {
+                                              "type": "string",
+                                              "description": "Street of the shipping address."
+                                            },
+                                            "number": {
+                                              "type": "string",
+                                              "description": "Number of the building, house or apartment in the shipping address."
+                                            },
+                                            "neighborhood": {
+                                              "type": "string",
+                                              "description": "Neighborhood of the shipping address."
+                                            },
+                                            "complement": {
+                                              "type": "string",
+                                              "description": "Complement to the shipping address, in case it applies.",
+                                              "nullable": true
+                                            },
+                                            "reference": {
+                                              "type": "string",
+                                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                              "nullable": true
+                                            },
+                                            "geoCoordinates": {
+                                              "type": "array",
+                                              "description": "Array with two strings that repesent geocoordinates: first latitude, then longitude.",
+                                              "items": {
+                                                "type": "number",
+                                                "description": "Geocoordinates."
+                                              }
+                                            }
+                                          }
+                                        },
+                                        "additionalInfo": {
+                                          "type": "string",
+                                          "description": "Additional information.",
+                                          "nullable": true
+                                        },
+                                        "dockId": {
+                                          "type": "string",
+                                          "description": "Corresponding dock ID.",
+                                          "nullable": true
+                                        }
+                                      }
+                                    },
+                                    "pickupPointId": {
+                                      "type": "string",
+                                      "description": "Pickup point ID.",
+                                      "nullable": true
+                                    },
+                                    "pickupDistance": {
+                                      "type": "integer",
+                                      "description": "Pickup point distance."
+                                    },
+                                    "polygonName": {
+                                      "type": "string",
+                                      "description": "Polygon name.",
+                                      "nullable": true
+                                    },
+                                    "transitTime": {
+                                      "type": "string",
+                                      "description": "Transit time. For instance, \"three business days\" is represented as `3bd`."
+                                    }
+                                  }
+                                }
+                              },
+                              "shipsTo": {
+                                "type": "array",
+                                "description": "List of countries that the item may be shipped to.",
+                                "items": {
+                                  "type": "string",
+                                  "description": "Three letter country code."
+                                }
+                              },
+                              "itemId": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "deliveryChannels": {
+                                "type": "array",
+                                "description": "List of available delivery channels.",
+                                "items": {
+                                  "description": "Delivery channel information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "Delivery channel ID."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "selectedAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the selected addresses for the order.",
+                          "items": {
+                            "description": "Selected address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "availableAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the available addresses for the order.",
+                          "items": {
+                            "description": "Available address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "clientProfileData": {
+                      "type": "object",
+                      "description": "Customer's profile information.",
+                      "nullable": true,
+                      "properties": {
+                        "email": {
+                          "type": "string",
+                          "description": "Email address.",
+                          "nullable": true
+                        },
+                        "firstName": {
+                          "type": "string",
+                          "description": "First name.",
+                          "nullable": true
+                        },
+                        "lastName": {
+                          "type": "string",
+                          "description": "Last name."
+                        },
+                        "documentType": {
+                          "type": "string",
+                          "description": "Type of the document informed by the customer."
+                        },
+                        "document": {
+                          "type": "string",
+                          "description": "Document informed by the customer."
+                        },
+                        "phone": {
+                          "type": "string",
+                          "description": "Phone number."
+                        },
+                        "corporateName": {
+                          "type": "string",
+                          "description": "Company name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "tradeName": {
+                          "type": "string",
+                          "description": "Trade name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporateDocument": {
+                          "type": "string",
+                          "description": "Corporate document, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "stateInscription": {
+                          "type": "string",
+                          "description": "State inscription, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporatePhone": {
+                          "type": "string",
+                          "description": "Corporate phone number, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "isCorporate": {
+                          "type": "boolean",
+                          "description": "Indicates whether the customer is a legal entity."
+                        },
+                        "profileCompleteOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile is complete on loading."
+                        },
+                        "profileErrorOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile presents error on loading.",
+                          "nullable": true
+                        },
+                        "customerClass": {
+                          "type": "string",
+                          "description": "Customer class.",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "paymentData": {
+                      "type": "object",
+                      "description": "Information on the order's payment.",
+                      "properties": {
+                        "giftCards": {
+                          "type": "array",
+                          "description": "Gift card information, if it applies to the order.",
+                          "items": {
+                            "description": "Gift card information.",
+                            "type": "object",
+                            "properties": {
+                              "redemptionCode": {
+                                "type": "string",
+                                "description": "Gift card redemption code."
+                              },
+                              "value": {
+                                "type": "integer",
+                                "description": "Gift card value in cents."
+                              },
+                              "balance": {
+                                "type": "integer",
+                                "description": "Gift card balance in cents."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Gift card name."
+                              },
+                              "id": {
+                                "type": "string",
+                                "description": "Gift card ID."
+                              },
+                              "inUse": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is in use."
+                              },
+                              "isSpecialCard": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is special."
+                              }
+                            }
+                          }
+                        },
+                        "transactions": {
+                          "type": "array",
+                          "description": "Information on each transaction pertinent to the order.",
+                          "items": {
+                            "description": "Transaction information.",
+                            "nullable": true,
+                            "type": "object",
+                            "properties": {
+                              "isActive": {
+                                "type": "boolean",
+                                "description": "Indicates whether transaction is active."
+                              },
+                              "transactionId": {
+                                "type": "string",
+                                "description": "Transaction ID."
+                              },
+                              "merchantName": {
+                                "type": "string",
+                                "description": "Merchant name."
+                              },
+                              "payments": {
+                                "type": "array",
+                                "description": "Information on each payment.",
+                                "items": {
+                                  "description": "Payment information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "accountId": {
+                                      "type": "string",
+                                      "description": "Account ID."
+                                    },
+                                    "bin": {
+                                      "type": "string",
+                                      "description": "Bin.",
+                                      "nullable": true
+                                    },
+                                    "installments": {
+                                      "type": "integer",
+                                      "description": "Number of installments."
+                                    },
+                                    "paymentSystem": {
+                                      "type": "string",
+                                      "description": "Payment system."
+                                    },
+                                    "referenceValue": {
+                                      "type": "integer",
+                                      "description": "Reference value for calculating interest rates, in case it applies. Displayed in cents."
+                                    },
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value including interest, in case it applies. Displayed in cents."
+                                    }
+                                  }
+                                }
+                              },
+                              "sharedTransaction": {
+                                "type": "boolean",
+                                "description": "Indicates whather transaction is shared."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "marketingData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Object containing promotion data such as coupon tracking information and internal or external UTMs.",
+                      "properties": {
+                        "coupon": {
+                          "type": "string",
+                          "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.",
+                          "example": "free-shipping"
+                        },
+                        "utmSource": {
+                          "type": "string",
+                          "description": "UTM source.",
+                          "example": "Facebook"
+                        },
+                        "utmMedium": {
+                          "type": "string",
+                          "description": "UTM medium.",
+                          "example": "CPC"
+                        },
+                        "utmCampaign": {
+                          "type": "string",
+                          "description": "UTM campaign.",
+                          "example": "Black friday"
+                        },
+                        "utmiPage": {
+                          "type": "string",
+                          "description": "utmi_page (internal utm).",
+                          "example": "utmi_page-example",
+                          "nullable": true
+                        },
+                        "utmiPart": {
+                          "type": "string",
+                          "description": "utmi_part (internal utm).",
+                          "example": "utmi_part-example",
+                          "nullable": true
+                        },
+                        "utmiCampaign": {
+                          "type": "string",
+                          "description": "utmi_campaign (internal utm).",
+                          "example": "utmi_campaign-example",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "sellers": {
+                      "type": "array",
+                      "description": "Information on each seller.",
+                      "items": {
+                        "description": "Seller information.",
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "Seller ID."
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Seller name."
+                          },
+                          "logo": {
+                            "type": "string",
+                            "description": "Seller logo.",
+                            "nullable": true
+                          }
+                        }
+                      }
+                    },
+                    "clientPreferencesData": {
+                      "type": "object",
+                      "description": "Object containing preferences from the client who placed the order.",
+                      "properties": {
+                        "locale": {
+                          "type": "string",
+                          "description": "Client's locale. Examples: `pt-BR` and `en-US`."
+                        },
+                        "optinNewsLetter": {
+                          "type": "boolean",
+                          "description": "`true` if the client opted to receive newsletter from the store.",
+                          "example": false,
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "commercialConditionData": {
+                      "type": "object",
+                      "description": "Object containing commercial condition information.",
+                      "nullable": true
+                    },
+                    "storePreferencesData": {
+                      "type": "object",
+                      "description": "Object containing data from the store's configuration (stored in VTEX's License Manager)."
+                    },
+                    "giftRegistryData": {
+                      "type": "object",
+                      "description": "Gift registry list information.",
+                      "nullable": true
+                    },
+                    "openTextField": {
+                      "type": "string",
+                      "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).",
+                      "example": "open-text-example",
+                      "nullable": true
+                    },
+                    "invoiceData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Invoice data including billing address.",
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Billing address.",
+                          "properties": {
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City name."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State name."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Country."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street name."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Street number."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Address complement."
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Reference for location."
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Geographic coordinates (latitude, longitude).",
+                              "items": {
+                                "type": "number"
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "customData": {
+                      "type": "object",
+                      "description": "Customer additional information.",
+                      "nullable": true
+                    },
+                    "itemMetadata": {
+                      "type": "object",
+                      "description": "Item metadata.",
+                      "properties": {
+                        "items": {
+                          "type": "array",
+                          "description": "List of objects containing metadata on each item in the order.",
+                          "items": {
+                            "description": "Item metadata.",
+                            "type": "object",
+                            "properties": {
+                              "id": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "seller": {
+                                "type": "string",
+                                "description": "Seller."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Product name."
+                              },
+                              "skuName": {
+                                "type": "string",
+                                "description": "SKU name."
+                              },
+                              "productId": {
+                                "type": "string",
+                                "description": "Product ID."
+                              },
+                              "refId": {
+                                "type": "string",
+                                "description": "Ref ID."
+                              },
+                              "ean": {
+                                "type": "string",
+                                "description": "European Article Number.",
+                                "nullable": true
+                              },
+                              "imageUrl": {
+                                "type": "string",
+                                "description": "Image URL."
+                              },
+                              "detailUrl": {
+                                "type": "string",
+                                "description": "Detail URL."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "hooksData": {
+                      "type": "object",
+                      "description": "Hooks information.",
+                      "nullable": true
+                    },
+                    "ratesAndBenefitsData": {
+                      "type": "object",
+                      "description": "Information on rates and benefits that apply to the order.",
+                      "properties": {
+                        "rateAndBenefitsIdentifiers": {
+                          "type": "array",
+                          "description": "List with rates and benefits identifiers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit identifier."
+                          }
+                        },
+                        "teaser": {
+                          "type": "array",
+                          "description": "List with rates and benefits teasers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit teaser."
+                          }
+                        }
+                      }
+                    },
+                    "subscriptionData": {
+                      "type": "object",
+                      "description": "Subscription information.",
+                      "nullable": true
+                    },
+                    "itemsOrdination": {
+                      "type": "object",
+                      "description": "Object containing information about the ordering of items within the `orderForm`.",
+                      "properties": {
+                        "criteria": {
+                          "type": "string",
+                          "description": "Criteria adopted to order the items in the list."
+                        },
+                        "ascending": {
+                          "type": "boolean",
+                          "description": "Indicates whether the ordering is ascending."
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/api/checkout/pvt/configuration/orderForm": {
+      "get": {
+        "tags": [
+          "Configuration"
+        ],
+        "summary": "Get orderForm configuration",
+        "description": "Retrieves the settings that are currently applied to every orderForm in the account.\n\r\n\rThese settings are defined by the request [Update orderForm configuration](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pvt/configuration/orderForm).\n\r\n\rAlways use this request to retrieve the current configuration before performing an update. By doing so you ensure that you are modifying only the properties you want.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Save OrderForm Configuration** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "GetorderFormconfiguration",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "paymentConfiguration": {
+                      "type": "object",
+                      "description": "Payment configuration information.",
+                      "properties": {
+                        "requiresAuthenticationForPreAuthorizedPaymentOption": {
+                          "type": "boolean",
+                          "description": "Determines whether pre-authorized payments require authentication."
+                        },
+                        "allowInstallmentsMerge": {
+                          "type": "boolean",
+                          "description": "By default (when `false`), on a multi-seller purchase is on the run, a simple intersection with installment options configured by every seller will be available. When indicated as `true`, this option allows a more complex but flexible installment option, since it considers max installments of every seller configuration, even if those do not match. Installment values may not be equal in this case."
+                        }
+                      }
+                    },
+                    "taxConfiguration": {
+                      "type": "object",
+                      "description": "External tax service configuration information.",
+                      "nullable": true,
+                      "properties": {
+                        "url": {
+                          "type": "string",
+                          "description": "Endpoint URL.",
+                          "nullable": true
+                        },
+                        "authorizationHeader": {
+                          "type": "string",
+                          "description": "Authorization header.",
+                          "nullable": true
+                        },
+                        "appId": {
+                          "type": "string",
+                          "description": "Custom data ID sent to the tax system."
+                        },
+                        "isMarketplaceResponsibleForTaxes": {
+                          "type": "boolean",
+                          "description": "Indicates whether the marketplace is responsible for the products taxes."
+                        }
+                      }
+                    },
+                    "minimumQuantityAccumulatedForItems": {
+                      "type": "integer",
+                      "description": "Minimum SKU quantity by cart."
+                    },
+                    "decimalDigitsPrecision": {
+                      "type": "integer",
+                      "description": "Number of price digits."
+                    },
+                    "minimumValueAccumulated": {
+                      "type": "integer",
+                      "description": "Minimum cart value.",
+                      "nullable": true
+                    },
+                    "apps": {
+                      "type": "array",
+                      "nullable": true,
+                      "description": "Array of objects containing Apps configuration information.",
+                      "items": {
+                        "description": "App configuration information.",
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "App ID."
+                          },
+                          "fields": {
+                            "type": "array",
+                            "description": "Array of fields available to the app.",
+                            "items": {
+                              "type": "string",
+                              "description": "Available fieldValue name."
+                            }
+                          },
+                          "major": {
+                            "type": "integer",
+                            "description": "App major version."
+                          }
+                        }
+                      }
+                    },
+                    "allowMultipleDeliveries": {
+                      "type": "boolean",
+                      "description": "On the same purchase, allows the selection of items from multiple delivery channels.",
+                      "nullable": true
+                    },
+                    "allowManualPrice": {
+                      "type": "boolean",
+                      "description": "Allows the editing of SKU prices right in the cart.",
+                      "nullable": true
+                    },
+                    "savePersonalDataAsOptIn": {
+                      "type": "boolean",
+                      "description": "Allows users to select whether they want the store to keep their personal and payment data saved.",
+                      "nullable": true
+                    },
+                    "maxNumberOfWhiteLabelSellers": {
+                      "type": "integer",
+                      "description": "Allows the input of a limit of white label sellers involved on the cart.",
+                      "nullable": true
+                    },
+                    "maskFirstPurchaseData": {
+                      "type": "boolean",
+                      "description": "Allows, on a first purchase, masking client's data. It could be useful when a shared cart is used and the client does not want to share its data.",
+                      "nullable": true
+                    },
+                    "recaptchaValidation": {
+                      "type": "string",
+                      "description": "Configures reCAPTCHA validation for the account, defining in which situations the shopper will be prompted to validate a purchase with reCAPTCHA. Learn more about [reCAPTCHA validation for VTEX stores](https://help.vtex.com/en/tutorial/using-recaptcha-at-checkout--18Te3oDd7f4qcjKu9jhNzP)\n\r\n\rPossible values are:\n\r- `\"never\"`: no purchases are validated with reCAPTCHA.\n\r- `\"always\"`: every purchase is validated with reCAPTCHA.\n\r- `\"vtexCriteria\"`: only some purchases are validated with reCAPTCHA in order to minimize friction and improve shopping experience. VTEX's algorithm determines which sessions are trustworthy and which should be validated with reCAPTCHA. This is the recommended option.",
+                      "example": "vtexCriteria"
+                    }
+                  }
+                },
+                "example": {
+                  "paymentConfiguration": {
+                    "requiresAuthenticationForPreAuthorizedPaymentOption": false,
+                    "allowInstallmentsMerge": false,
+                    "blockPaymentSession": null
+                  },
+                  "taxConfiguration": null,
+                  "minimumQuantityAccumulatedForItems": 1,
+                  "decimalDigitsPrecision": 2,
+                  "minimumValueAccumulated": null,
+                  "apps": [
+                    {
+                      "fields": [
+                        "name",
+                        "age"
+                      ],
+                      "id": "abcd",
+                      "major": 1
+                    }
+                  ],
+                  "allowMultipleDeliveries": false,
+                  "allowManualPrice": true,
+                  "savePersonalDataAsOptIn": false,
+                  "maxNumberOfWhiteLabelSellers": null,
+                  "maskFirstPurchaseData": null,
+                  "recaptchaValidation": "vtexCriteria"
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "post": {
+        "tags": [
+          "Configuration"
+        ],
+        "summary": "Update orderForm configuration",
+        "description": "Determines settings that will apply to every orderForm in the account.\n\r\n\rFor example, if you create an app using this request, every orderForm of this account will have the custom fields created though it.\n\r\n\r>ℹ️ 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).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Save OrderForm Configuration** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "UpdateorderFormconfiguration",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "required": [
+                  "paymentConfiguration",
+                  "taxConfiguration",
+                  "minimumQuantityAccumulatedForItems",
+                  "decimalDigitsPrecision",
+                  "minimumValueAccumulated",
+                  "apps",
+                  "allowMultipleDeliveries",
+                  "allowManualPrice"
+                ],
+                "type": "object",
+                "properties": {
+                  "paymentConfiguration": {
+                    "title": "PaymentConfiguration",
+                    "description": "Payment Configuration object.",
+                    "required": [
+                      "requiresAuthenticationForPreAuthorizedPaymentOption"
+                    ],
+                    "type": "object",
+                    "properties": {
+                      "requiresAuthenticationForPreAuthorizedPaymentOption": {
+                        "type": "boolean",
+                        "description": "Determines whether pre-authorized payments require authentication."
+                      },
+                      "allowInstallmentsMerge": {
+                        "type": "boolean",
+                        "description": "By default (when `false`), on a multi-seller purchase is on the run, a simple intersection with installments options configured by every seller will be available. When `true`, this option allows a more complex but flexible installment option, since it considers max installments of every seller configuration, even if those don't match. Installment values ​​may not be equal in this case."
+                      },
+                      "blockPaymentSession": {
+                        "type": "boolean",
+                        "description": "Indicates whether shoppers can add credit cards in your store's `My Account` section."
+                      }
+                    },
+                    "example": {
+                      "requiresAuthenticationForPreAuthorizedPaymentOption": false,
+                      "allowInstallmentsMerge": false,
+                      "blockPaymentSession": false
+                    }
+                  },
+                  "taxConfiguration": {
+                    "type": "object",
+                    "description": "External tax service configuration.",
+                    "nullable": true,
+                    "properties": {
+                      "url": {
+                        "type": "string",
+                        "nullable": true,
+                        "description": "Endpoint URL."
+                      },
+                      "authorizationHeader": {
+                        "type": "string",
+                        "description": "Authorization header.",
+                        "nullable": true
+                      },
+                      "appId": {
+                        "type": "string",
+                        "description": "Custom data ID sent to the tax system.",
+                        "example": "12345"
+                      },
+                      "isMarketplaceResponsibleForTaxes": {
+                        "description": "Indicates whether the marketplace is responsible for the products taxes."
+                      }
+                    }
+                  },
+                  "minimumQuantityAccumulatedForItems": {
+                    "type": "integer",
+                    "format": "int32",
+                    "description": "Minimum SKU quantity by cart."
+                  },
+                  "decimalDigitsPrecision": {
+                    "type": "integer",
+                    "format": "int32",
+                    "description": "Number of price digits."
+                  },
+                  "minimumValueAccumulated": {
+                    "type": "integer",
+                    "nullable": true,
+                    "description": "Minimum cart value."
+                  },
+                  "apps": {
+                    "type": "array",
+                    "nullable": true,
+                    "description": "Array of objects containing Apps configuration information.",
+                    "items": {
+                      "type": "object",
+                      "description": "App configuration information.",
+                      "properties": {
+                        "id": {
+                          "type": "string",
+                          "description": "App ID.",
+                          "example": "birthdayApp"
+                        },
+                        "fields": {
+                          "type": "array",
+                          "description": "Array of fields available to the app.",
+                          "items": {
+                            "type": "string",
+                            "example": "birthdayField",
+                            "description": "Available field."
+                          }
+                        },
+                        "major": {
+                          "type": "integer",
+                          "description": "App major version.",
+                          "example": 1
+                        }
+                      }
+                    }
+                  },
+                  "allowMultipleDeliveries": {
+                    "type": "boolean",
+                    "nullable": true,
+                    "description": "On the same purchase, allows the selection of items from multiple delivery channels."
+                  },
+                  "allowManualPrice": {
+                    "type": "boolean",
+                    "nullable": true,
+                    "description": "Allows the editing of SKU prices right in the cart."
+                  },
+                  "maxNumberOfWhiteLabelSellers": {
+                    "type": "integer",
+                    "description": "Allows the input of a limit of white label sellers involved on the cart."
+                  },
+                  "maskFirstPurchaseData": {
+                    "type": "boolean",
+                    "description": "Allows, on a first purchase, masking client's data. It could be useful when a shared cart is used and the client doesn't want to share its data."
+                  },
+                  "maskStateOnAddress": {
+                    "type": "boolean",
+                    "description": "If the response body is masked, on a first purchase, this flag causes the state (UF) to be masked. The default behavior is to be masked.",
+                    "default": true
+                  },
+                  "recaptchaValidation": {
+                    "type": "string",
+                    "nullable": true,
+                    "description": "Configures reCAPTCHA validation for the account, defining in which situations the shopper will be prompted to validate a purchase with reCAPTCHA. Learn more about [reCAPTCHA validation for VTEX stores](https://help.vtex.com/tutorial/recaptcha-no-checkout--18Te3oDd7f4qcjKu9jhNzP)\r\n\r\nPossible values are:\r\n\r\n- `\"never\"`: no purchases are validated with reCAPTCHA.\r\n- `null`: no purchases are validated with reCAPTCHA. The same as `never`.\r\n- `\"always\"`: every purchase is validated with reCAPTCHA.\r\n- `\"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.",
+                    "example": "vtexCriteria"
+                  },
+                  "paymentSystemToCheckFirstInstallment": {
+                    "type": "string",
+                    "description": "If you want to apply a first installment discount to a particular payment system, set this field to that payment system's ID. Learn more: [Configuring a discount for orders prepaid in full](https://help.vtex.com/en/tutorial/configurar-desconto-de-preco-a-vista--7Lfcj9Wb5dpYfA2gKkACIt).",
+                    "example": "6"
+                  }
+                },
+                "example": {
+                  "paymentConfiguration": {
+                    "requiresAuthenticationForPreAuthorizedPaymentOption": false
+                  },
+                  "taxConfiguration": null,
+                  "minimumQuantityAccumulatedForItems": 1,
+                  "decimalDigitsPrecision": 2,
+                  "minimumValueAccumulated": null,
+                  "apps": null,
+                  "allowMultipleDeliveries": null,
+                  "allowManualPrice": null
+                }
+              },
+              "example": {
+                "paymentConfiguration": {
+                  "requiresAuthenticationForPreAuthorizedPaymentOption": false
+                },
+                "taxConfiguration": null,
+                "minimumQuantityAccumulatedForItems": 1,
+                "decimalDigitsPrecision": 2,
+                "minimumValueAccumulated": null,
+                "apps": null,
+                "allowMultipleDeliveries": null,
+                "allowManualPrice": null
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "204": {
+            "description": "No Content. The request has succeeded."
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/api/checkout/pvt/configuration/window-to-change-seller": {
+      "get": {
+        "tags": [
+          "Configuration"
+        ],
+        "summary": "Get window to change seller",
+        "description": "Retrieves a marketplace's window to change seller, that is, the period when it is possible to choose another seller to fulfill a given order after the original seller has canceled it.\n\r\n\r> The default period for this window is of 2 days, but it can be configured by the request Update window to change seller.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Save OrderForm Configuration** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "GetWindowToChangeSeller",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "type": "string",
+                  "description": "Window to change seller in days."
+                },
+                "example": "2"
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "post": {
+        "tags": [
+          "Configuration"
+        ],
+        "summary": "Update window to change seller",
+        "description": "Updates a marketplace's window to change seller, that is, the period when it is possible to choose another seller to fulfill a given order after the original seller has canceled it.\n\r\n\r> It is possible to check the current window using the request Get window to change seller.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Save OrderForm Configuration** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "UpdateWindowToChangeSeller",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "description": "Object containing the days after order cancelation by a seller.",
+                "required": [
+                  "waitingTime"
+                ],
+                "properties": {
+                  "waitingTime": {
+                    "type": "integer",
+                    "description": "Number of days after order cancelation by a seller, during which another seller may be assigned to fulfill the order."
+                  }
+                }
+              },
+              "example": {
+                "waitingTime": 4
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "Created"
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/api/checkout/pub/orderForm/{orderFormId}/messages/clear": {
+      "post": {
+        "tags": [
+          "Configuration"
+        ],
+        "summary": "Clear orderForm messages",
+        "description": "This request removes all messages from the `messages` field of the orderForm , leaving it empty.\r\n\r\nYou must send an empty JSON in the body of the request.\r\n\r\nThe [orderForm](https://developers.vtex.com/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.\r\n\r\n**Important**: **Request Body** must always be sent with empty value \"{ }\" in this endpoint.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "ClearorderFormMessages",
+        "security": [],
+        "parameters": [
+          {
+            "name": "orderFormId",
+            "in": "path",
+            "description": "ID of the orderForm corresponding to the cart whose messages you want to remove.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "ede846222cd44046ba6c638442c3505a"
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "description": "This object must be empty.",
+                "default": {}
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "orderFormId": {
+                      "type": "string",
+                      "description": "ID of the orderForm corresponding to a specific cart."
+                    },
+                    "salesChannel": {
+                      "type": "string",
+                      "description": "Attribute created by the seller, in their VTEX store configuration."
+                    },
+                    "loggedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether the user is logged into the store."
+                    },
+                    "isCheckedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether order is checked in."
+                    },
+                    "storeId": {
+                      "type": "string",
+                      "description": "ID of the store.",
+                      "nullable": true
+                    },
+                    "allowManualPrice": {
+                      "type": "boolean",
+                      "description": "Permission to modify item price manually."
+                    },
+                    "canEditData": {
+                      "type": "boolean",
+                      "description": "Data can be edited."
+                    },
+                    "userProfileId": {
+                      "type": "string",
+                      "description": "Unique ID associated with the customer profile."
+                    },
+                    "profileProvider": {
+                      "type": "string",
+                      "description": "Profile provider."
+                    },
+                    "availableAccounts": {
+                      "type": "array",
+                      "description": "Available accounts.",
+                      "items": {
+                        "type": "string",
+                        "description": "Available account."
+                      }
+                    },
+                    "availableAddresses": {
+                      "type": "array",
+                      "description": "Information on each available address.",
+                      "items": {
+                        "description": "Available address information.",
+                        "type": "object",
+                        "properties": {
+                          "addressType": {
+                            "type": "string",
+                            "description": "Address type."
+                          },
+                          "receiverName": {
+                            "type": "string",
+                            "description": "Name of the receiver."
+                          },
+                          "addressId": {
+                            "type": "string",
+                            "description": "Address ID.",
+                            "nullable": true
+                          },
+                          "isDisposable": {
+                            "type": "boolean",
+                            "description": "Indicates whether address is disposable."
+                          },
+                          "city": {
+                            "type": "string",
+                            "description": "City of the address."
+                          },
+                          "state": {
+                            "type": "string",
+                            "description": "State of the address."
+                          },
+                          "country": {
+                            "type": "string",
+                            "description": "Country of the address. ISO three-letter code."
+                          },
+                          "street": {
+                            "type": "string",
+                            "description": "Street of the address."
+                          },
+                          "number": {
+                            "type": "string",
+                            "description": "Number of the address."
+                          },
+                          "neighborhood": {
+                            "type": "string",
+                            "description": "Neighborhood of the address."
+                          },
+                          "complement": {
+                            "type": "string",
+                            "description": "Complement to the address.",
+                            "nullable": true
+                          },
+                          "reference": {
+                            "type": "string",
+                            "description": "Reference that may help in the location of the address.",
+                            "nullable": true
+                          },
+                          "geoCoordinates": {
+                            "type": "array",
+                            "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
+                            "items": {
+                              "type": "number",
+                              "description": "Geocoordinates numbers."
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "userType": {
+                      "type": "string",
+                      "description": "User type.",
+                      "nullable": true
+                    },
+                    "ignoreProfileData": {
+                      "type": "boolean",
+                      "description": "Ignore customer profile data."
+                    },
+                    "value": {
+                      "type": "integer",
+                      "description": "Total value of the order without separating cents. For example, $24.99 is represented `2499`."
+                    },
+                    "messages": {
+                      "type": "array",
+                      "description": "Array containing an object for each message generated by our servers while processing the request.",
+                      "items": {
+                        "type": "string",
+                        "description": "Message."
+                      }
+                    },
+                    "items": {
+                      "type": "array",
+                      "description": "Information on each item in the order.",
+                      "items": {
+                        "description": "Item information.",
+                        "type": "object",
+                        "properties": {
+                          "uniqueId": {
+                            "type": "string",
+                            "description": "Unique ID."
+                          },
+                          "id": {
+                            "type": "string",
+                            "description": "ID of the item."
+                          },
+                          "productId": {
+                            "type": "string",
+                            "description": "Product ID."
+                          },
+                          "productRefId": {
+                            "type": "string",
+                            "description": "Product Ref ID."
+                          },
+                          "refId": {
+                            "type": "string",
+                            "description": "Ref ID."
+                          },
+                          "ean": {
+                            "type": "string",
+                            "description": "European Article Number.",
+                            "nullable": true
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Product name."
+                          },
+                          "skuName": {
+                            "type": "string",
+                            "description": "SKU name."
+                          },
+                          "modalType": {
+                            "type": "string",
+                            "description": "Modal type.",
+                            "nullable": true
+                          },
+                          "parentItemIndex": {
+                            "type": "integer",
+                            "description": "Parent item index.",
+                            "nullable": true
+                          },
+                          "parentAssemblyBinding": {
+                            "type": "string",
+                            "description": "Parent assembly binding.",
+                            "nullable": true
+                          },
+                          "priceValidUntil": {
+                            "type": "string",
+                            "description": "Price expiration date and time."
+                          },
+                          "tax": {
+                            "type": "integer",
+                            "description": "Tax value in cents."
+                          },
+                          "price": {
+                            "type": "integer",
+                            "description": "Price in cents."
+                          },
+                          "listPrice": {
+                            "type": "integer",
+                            "description": "List price in cents."
+                          },
+                          "manualPrice": {
+                            "type": "integer",
+                            "description": "Manual price in cents.",
+                            "nullable": true
+                          },
+                          "manualPriceAppliedBy": {
+                            "type": "string",
+                            "description": "User that applied the manual price, if that is the case.",
+                            "nullable": true
+                          },
+                          "sellingPrice": {
+                            "type": "integer",
+                            "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
+                          },
+                          "rewardValue": {
+                            "type": "integer",
+                            "description": "Reward value in cents."
+                          },
+                          "isGift": {
+                            "type": "boolean",
+                            "description": "Indicates whether item is a gift."
+                          },
+                          "additionalInfo": {
+                            "type": "object",
+                            "description": "Additional information.",
+                            "properties": {
+                              "dimension": {
+                                "type": "string",
+                                "description": "Dimension.",
+                                "nullable": true
+                              },
+                              "brandName": {
+                                "type": "string",
+                                "description": "Brand name."
+                              },
+                              "brandId": {
+                                "type": "string",
+                                "description": "Brand ID."
+                              },
+                              "offeringInfo": {
+                                "type": "string",
+                                "description": "Offering information.",
+                                "nullable": true
+                              },
+                              "offeringType": {
+                                "type": "string",
+                                "description": "Offering type.",
+                                "nullable": true
+                              },
+                              "offeringTypeId": {
+                                "type": "string",
+                                "description": "Offering type ID.",
+                                "nullable": true
+                              }
+                            }
+                          },
+                          "preSaleDate": {
+                            "type": "string",
+                            "description": "Presale date.",
+                            "nullable": true
+                          },
+                          "productCategoryIds": {
+                            "type": "string",
+                            "description": "Product category IDs."
+                          },
+                          "productCategories": {
+                            "type": "object",
+                            "description": "Object, where each field is an ID from `productCategoryIds`.",
+                            "properties": {
+                              "{ID}": {
+                                "type": "string",
+                                "description": "Product category corresponding to the ID in the field key."
+                              }
+                            }
+                          },
+                          "quantity": {
+                            "type": "integer",
+                            "description": "Quantity."
+                          },
+                          "seller": {
+                            "type": "string",
+                            "description": "Seller."
+                          },
+                          "sellerChain": {
+                            "type": "array",
+                            "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
+                            "items": {
+                              "type": "string",
+                              "description": "Seller."
+                            }
+                          },
+                          "imageUrl": {
+                            "type": "string",
+                            "description": "Image URL."
+                          },
+                          "detailUrl": {
+                            "type": "string",
+                            "description": "Detail URL."
+                          },
+                          "bundleItems": {
+                            "type": "array",
+                            "description": "Information on services sold along with the SKU. Example: a gift package.",
+                            "items": {
+                              "description": "Service information.",
+                              "type": "object",
+                              "properties": {
+                                "type": {
+                                  "type": "string",
+                                  "description": "Service type."
+                                },
+                                "id": {
+                                  "type": "integer",
+                                  "description": "Service identifier."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Service name."
+                                },
+                                "price": {
+                                  "type": "integer",
+                                  "description": "Service price in cents."
+                                }
+                              }
+                            }
+                          },
+                          "attachments": {
+                            "type": "array",
+                            "description": "Array containing information on attachments.",
+                            "items": {
+                              "type": "string",
+                              "description": "Attachment information."
+                            }
+                          },
+                          "priceTags": {
+                            "type": "array",
+                            "description": "Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.",
+                            "items": {
+                              "description": "Price tag information.",
+                              "type": "object",
+                              "properties": {
+                                "identifier": {
+                                  "type": "string",
+                                  "description": "Promotion unique identifier.",
+                                  "nullable": true
+                                },
+                                "isPercentual": {
+                                  "type": "boolean",
+                                  "description": "Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\r\n- `type` indicates whether the tag refers to a discount or tax.\r\n- `where` specifies the context, either price or shipping.\r\n- `identifier` is the promotion ID.\r\n- `calculationId` is a hash that may vary with each price calculation."
+                                },
+                                "rawValue": {
+                                  "type": "number",
+                                  "description": "Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations."
+                                },
+                                "value": {
+                                  "type": "integer",
+                                  "description": "Price tag value representing either a promotion (value decrease) or a tax (value increase)."
+                                }
+                              }
+                            }
+                          },
+                          "availability": {
+                            "type": "string",
+                            "description": "Availability."
+                          },
+                          "measurementUnit": {
+                            "type": "string",
+                            "description": "Measurement unit."
+                          },
+                          "unitMultiplier": {
+                            "type": "integer",
+                            "description": "Unit multiplier."
+                          },
+                          "manufacturerCode": {
+                            "type": "string",
+                            "description": "Manufacturer code.",
+                            "nullable": true
+                          },
+                          "priceDefinition": {
+                            "type": "object",
+                            "description": "Price information for all units of a specific item.",
+                            "properties": {
+                              "calculatedSellingPrice": {
+                                "type": "integer",
+                                "description": "Item's calculated unitary selling price in cents."
+                              },
+                              "total": {
+                                "type": "integer",
+                                "description": "Total value for all units of the item in cents."
+                              },
+                              "sellingPrices": {
+                                "type": "array",
+                                "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
+                                "items": {
+                                  "description": "Rounding information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value in cents for that specific rounding."
+                                    },
+                                    "quantity": {
+                                      "type": "integer",
+                                      "description": "Rounding quantity, meaning how many items are rounded to this value."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "selectableGifts": {
+                      "type": "array",
+                      "description": "Array containing the data of the item selected as a gift.",
+                      "items": {
+                        "type": "string",
+                        "description": "Gift."
+                      }
+                    },
+                    "totalizers": {
+                      "type": "array",
+                      "description": "Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).",
+                      "items": {
+                        "type": "object",
+                        "description": "Totalizer of purchases."
+                      }
+                    },
+                    "shippingData": {
+                      "type": "object",
+                      "description": "Shipping information pertinent to the order.",
+                      "nullable": true,
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Address information.",
+                          "nullable": true,
+                          "properties": {
+                            "addressType": {
+                              "type": "string",
+                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                            },
+                            "receiverName": {
+                              "type": "string",
+                              "description": "Name of the person who is going to receive the order."
+                            },
+                            "addressId": {
+                              "type": "string",
+                              "description": "Address ID.",
+                              "nullable": true
+                            },
+                            "isDisposable": {
+                              "type": "boolean",
+                              "description": "Indicates whether address is disposable."
+                            },
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City of the shipping address."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State of the shipping address."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Three letter ISO code of the country of the shipping address."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street of the shipping address."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Number of the building, house or apartment in the shipping address."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood of the shipping address."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Complement to the shipping address, in case it applies.",
+                              "nullable": true
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                              "nullable": true
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
+                              "items": {
+                                "type": "number",
+                                "description": "Geocoordinates numbers."
+                              }
+                            }
+                          }
+                        },
+                        "logisticsInfo": {
+                          "type": "array",
+                          "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.",
+                          "items": {
+                            "description": "Logistics information.",
+                            "type": "object",
+                            "properties": {
+                              "itemIndex": {
+                                "type": "integer",
+                                "description": "Index corresponding to the position of the object in the `items` array."
+                              },
+                              "selectedSla": {
+                                "type": "string",
+                                "description": "SLA selected by the customer.",
+                                "nullable": true
+                              },
+                              "selectedDeliveryChannel": {
+                                "type": "string",
+                                "description": "Delivery channel selected by the customer.",
+                                "nullable": true
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "slas": {
+                                "type": "array",
+                                "description": "Information on available SLAs.",
+                                "items": {
+                                  "description": "SLA information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "SLA ID."
+                                    },
+                                    "deliveryChannel": {
+                                      "type": "string",
+                                      "description": "Delivery channel."
+                                    },
+                                    "name": {
+                                      "type": "string",
+                                      "description": "SLA name."
+                                    },
+                                    "deliveryIds": {
+                                      "type": "array",
+                                      "description": "Information on each delivery ID.",
+                                      "items": {
+                                        "description": "Delivery ID information.",
+                                        "type": "object",
+                                        "properties": {
+                                          "courierId": {
+                                            "type": "string",
+                                            "description": "Courier ID."
+                                          },
+                                          "warehouseId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "dockId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "courierName": {
+                                            "type": "string",
+                                            "description": "Courier name."
+                                          },
+                                          "quantity": {
+                                            "type": "integer",
+                                            "description": "Quantity."
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "attachmentOfferings": {
+                                      "type": "array",
+                                      "description": "List of attachments details.",
+                                      "nullable": true,
+                                      "items": {
+                                        "description": "Attachment details.",
+                                        "type": "object",
+                                        "required": [
+                                          "name",
+                                          "required",
+                                          "schema"
+                                        ],
+                                        "properties": {
+                                          "name": {
+                                            "type": "string",
+                                            "description": "Name of the attachment.",
+                                            "nullable": true
+                                          },
+                                          "required": {
+                                            "type": "boolean",
+                                            "description": "Defines if the attachment is required (`true`) or not (`false`).",
+                                            "nullable": true
+                                          },
+                                          "schema": {
+                                            "type": "object",
+                                            "description": "Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).",
+                                            "nullable": true
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "shippingEstimate": {
+                                      "type": "string",
+                                      "description": "Shipping estimate. For instance, Three business days will be represented `3bd`."
+                                    },
+                                    "shippingEstimateDate": {
+                                      "type": "string",
+                                      "description": "When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.",
+                                      "nullable": true
+                                    },
+                                    "useIndividualShippingEstimates": {
+                                      "type": "boolean",
+                                      "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`."
+                                    },
+                                    "lockTTL": {
+                                      "type": "string",
+                                      "description": "Estimate date of delivery.",
+                                      "nullable": true
+                                    },
+                                    "price": {
+                                      "type": "integer",
+                                      "description": "Price in cents."
+                                    },
+                                    "listPrice": {
+                                      "type": "integer",
+                                      "description": "List price in cents."
+                                    },
+                                    "tax": {
+                                      "type": "integer",
+                                      "description": "Tax in cents."
+                                    },
+                                    "pickupStoreInfo": {
+                                      "type": "object",
+                                      "description": "Information on the pickup store.",
+                                      "properties": {
+                                        "isPickupStore": {
+                                          "type": "boolean",
+                                          "description": "Indicates whether it is the pickup store."
+                                        },
+                                        "friendlyName": {
+                                          "type": "string",
+                                          "description": "Friendly name.",
+                                          "nullable": true
+                                        },
+                                        "address": {
+                                          "type": "object",
+                                          "description": "Address information.",
+                                          "nullable": true,
+                                          "properties": {
+                                            "addressType": {
+                                              "type": "string",
+                                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                                            },
+                                            "postalCode": {
+                                              "type": "string",
+                                              "description": "Postal code."
+                                            },
+                                            "city": {
+                                              "type": "string",
+                                              "description": "City of the shipping address."
+                                            },
+                                            "state": {
+                                              "type": "string",
+                                              "description": "State of the shipping address."
+                                            },
+                                            "country": {
+                                              "type": "string",
+                                              "description": "Three letter ISO code of the country of the shipping address."
+                                            },
+                                            "street": {
+                                              "type": "string",
+                                              "description": "Street of the shipping address."
+                                            },
+                                            "number": {
+                                              "type": "string",
+                                              "description": "Number of the building, house or apartment in the shipping address."
+                                            },
+                                            "neighborhood": {
+                                              "type": "string",
+                                              "description": "Neighborhood of the shipping address."
+                                            },
+                                            "complement": {
+                                              "type": "string",
+                                              "description": "Complement to the shipping address, in case it applies.",
+                                              "nullable": true
+                                            },
+                                            "reference": {
+                                              "type": "string",
+                                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                              "nullable": true
+                                            },
+                                            "geoCoordinates": {
+                                              "type": "array",
+                                              "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
+                                              "items": {
+                                                "type": "number",
+                                                "description": "Geocoordinates numbers."
+                                              }
+                                            }
+                                          }
+                                        },
+                                        "additionalInfo": {
+                                          "type": "string",
+                                          "description": "Additional information.",
+                                          "nullable": true
+                                        },
+                                        "dockId": {
+                                          "type": "string",
+                                          "description": "Corresponding dock ID.",
+                                          "nullable": true
+                                        }
+                                      }
+                                    },
+                                    "pickupPointId": {
+                                      "type": "string",
+                                      "description": "Pickup point ID.",
+                                      "nullable": true
+                                    },
+                                    "pickupDistance": {
+                                      "type": "integer",
+                                      "description": "Pickup point distance."
+                                    },
+                                    "polygonName": {
+                                      "type": "string",
+                                      "description": "Polygon name.",
+                                      "nullable": true
+                                    },
+                                    "transitTime": {
+                                      "type": "string",
+                                      "description": "Transit time. For instance, \"three business days\" is represented `3bd`."
+                                    }
+                                  }
+                                }
+                              },
+                              "shipsTo": {
+                                "type": "array",
+                                "description": "List of countries that the item may be shipped to.",
+                                "items": {
+                                  "type": "string",
+                                  "description": "Three letter country code."
+                                }
+                              },
+                              "itemId": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "deliveryChannels": {
+                                "type": "array",
+                                "description": "List of available delivery channels.",
+                                "items": {
+                                  "description": "Delivery channel information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "Delivery channel ID."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "selectedAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the selected addresses for the order.",
+                          "items": {
+                            "description": "Selected address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates numbers."
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "availableAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the available addresses for the order.",
+                          "items": {
+                            "description": "Available address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates numbers."
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "clientProfileData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Customer's profile information.",
+                      "properties": {
+                        "email": {
+                          "type": "string",
+                          "description": "Email address.",
+                          "nullable": true
+                        },
+                        "firstName": {
+                          "type": "string",
+                          "description": "First name.",
+                          "nullable": true
+                        },
+                        "lastName": {
+                          "type": "string",
+                          "description": "Last name."
+                        },
+                        "documentType": {
+                          "type": "string",
+                          "description": "Type of the document informed by the customer."
+                        },
+                        "document": {
+                          "type": "string",
+                          "description": "Document informed by the customer."
+                        },
+                        "phone": {
+                          "type": "string",
+                          "description": "Phone number."
+                        },
+                        "corporateName": {
+                          "type": "string",
+                          "description": "Company name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "tradeName": {
+                          "type": "string",
+                          "description": "Trade name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporateDocument": {
+                          "type": "string",
+                          "description": "Corporate document, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "stateInscription": {
+                          "type": "string",
+                          "description": "State inscription, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporatePhone": {
+                          "type": "string",
+                          "description": "Corporate phone number, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "isCorporate": {
+                          "type": "boolean",
+                          "description": "Indicates whether the customer is a legal entity."
+                        },
+                        "profileCompleteOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile is complete on loading."
+                        },
+                        "profileErrorOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile presents error on loading.",
+                          "nullable": true
+                        },
+                        "customerClass": {
+                          "type": "string",
+                          "description": "Customer class.",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "paymentData": {
+                      "type": "object",
+                      "description": "Information on the order's payment.",
+                      "properties": {
+                        "giftCards": {
+                          "type": "array",
+                          "description": "Gift card information, if it applies to the order.",
+                          "items": {
+                            "description": "Gift card information.",
+                            "type": "object",
+                            "properties": {
+                              "redemptionCode": {
+                                "type": "string",
+                                "description": "Gift card redemption code."
+                              },
+                              "value": {
+                                "type": "integer",
+                                "description": "Gift card value in cents."
+                              },
+                              "balance": {
+                                "type": "integer",
+                                "description": "Gift card balance in cents."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Gift card name."
+                              },
+                              "id": {
+                                "type": "string",
+                                "description": "Gift card ID."
+                              },
+                              "inUse": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is in use."
+                              },
+                              "isSpecialCard": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is special."
+                              }
+                            }
+                          }
+                        },
+                        "transactions": {
+                          "type": "array",
+                          "description": "Information on each transaction pertinent to the order.",
+                          "items": {
+                            "description": "Transaction information.",
+                            "type": "object",
+                            "properties": {
+                              "isActive": {
+                                "type": "boolean",
+                                "description": "Indicates whether transaction is active."
+                              },
+                              "transactionId": {
+                                "type": "string",
+                                "description": "Transaction ID."
+                              },
+                              "merchantName": {
+                                "type": "string",
+                                "description": "Merchant name."
+                              },
+                              "payments": {
+                                "type": "array",
+                                "description": "Information on each payment.",
+                                "items": {
+                                  "description": "Payment information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "accountId": {
+                                      "type": "string",
+                                      "description": "Account ID.",
+                                      "nullable": true
+                                    },
+                                    "bin": {
+                                      "type": "string",
+                                      "description": "Bin.",
+                                      "nullable": true
+                                    },
+                                    "installments": {
+                                      "type": "integer",
+                                      "description": "Number of installments."
+                                    },
+                                    "paymentSystem": {
+                                      "type": "integer",
+                                      "description": "Payment system."
+                                    },
+                                    "referenceValue": {
+                                      "type": "integer",
+                                      "description": "Reference value for calculating interest rates, in case it applies. Displayed in cents."
+                                    },
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value including interest, in case it applies. Displayed in cents."
+                                    }
+                                  }
+                                }
+                              },
+                              "sharedTransaction": {
+                                "type": "boolean",
+                                "description": "Indicates whather transaction is shared."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "marketingData": {
+                      "type": "object",
+                      "description": "Object containing promotion data such as coupon tracking information and internal or external UTMs.",
+                      "nullable": true,
+                      "properties": {
+                        "coupon": {
+                          "type": "string",
+                          "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.",
+                          "example": "free-shipping"
+                        },
+                        "utmSource": {
+                          "type": "string",
+                          "description": "UTM source.",
+                          "example": "Facebook"
+                        },
+                        "utmMedium": {
+                          "type": "string",
+                          "description": "UTM medium.",
+                          "example": "CPC"
+                        },
+                        "utmCampaign": {
+                          "type": "string",
+                          "description": "UTM campaign.",
+                          "example": "Black friday"
+                        },
+                        "utmiPage": {
+                          "type": "string",
+                          "description": "utmi_page (internal utm).",
+                          "example": "utmi_page-example",
+                          "nullable": true
+                        },
+                        "utmiPart": {
+                          "type": "string",
+                          "description": "utmi_part (internal utm).",
+                          "example": "utmi_part-example",
+                          "nullable": true
+                        },
+                        "utmiCampaign": {
+                          "type": "string",
+                          "description": "utmi_campaign (internal utm).",
+                          "example": "utmi_campaign-example",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "sellers": {
+                      "type": "array",
+                      "description": "Information on each seller.",
+                      "items": {
+                        "description": "Seller information.",
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "Seller ID."
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Seller name."
+                          },
+                          "logo": {
+                            "type": "string",
+                            "description": "Seller logo.",
+                            "nullable": true
+                          }
+                        }
+                      }
+                    },
+                    "clientPreferencesData": {
+                      "type": "object",
+                      "description": "Object containing preferences from the client who placed the order.",
+                      "properties": {
+                        "locale": {
+                          "type": "string",
+                          "description": "Client's locale. Examples: `pt-BR` and `en-US`."
+                        },
+                        "optinNewsLetter": {
+                          "type": "boolean",
+                          "description": "`true` if the client opted to receive newsletter from the store.",
+                          "example": false,
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "commercialConditionData": {
+                      "type": "object",
+                      "description": "Object containing commercial condition information.",
+                      "nullable": true
+                    },
+                    "storePreferencesData": {
+                      "type": "object",
+                      "description": "Object containing data from the store's configuration (stored in VTEX's License Manager)."
+                    },
+                    "giftRegistryData": {
+                      "type": "object",
+                      "description": "Gift registry list information.",
+                      "nullable": true
+                    },
+                    "openTextField": {
+                      "type": "string",
+                      "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).",
+                      "example": "open-text-example",
+                      "nullable": true
+                    },
+                    "invoiceData": {
+                      "type": "object",
+                      "description": "Object containing information pertinent to the order's invoice.",
+                      "nullable": true
+                    },
+                    "customData": {
+                      "type": "object",
+                      "description": "Customer additional information.",
+                      "nullable": true
+                    },
+                    "itemMetadata": {
+                      "type": "object",
+                      "description": "Item metadata.",
+                      "properties": {
+                        "items": {
+                          "type": "array",
+                          "description": "List of objects containing metadata on each item in the order.",
+                          "items": {
+                            "description": "Item metadata.",
+                            "type": "object",
+                            "properties": {
+                              "id": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "seller": {
+                                "type": "string",
+                                "description": "Seller."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Product name."
+                              },
+                              "skuName": {
+                                "type": "string",
+                                "description": "SKU name."
+                              },
+                              "productId": {
+                                "type": "string",
+                                "description": "Product ID."
+                              },
+                              "refId": {
+                                "type": "string",
+                                "description": "Ref ID."
+                              },
+                              "ean": {
+                                "type": "string",
+                                "description": "European Article Number.",
+                                "nullable": true
+                              },
+                              "imageUrl": {
+                                "type": "string",
+                                "description": "Image URL."
+                              },
+                              "detailUrl": {
+                                "type": "string",
+                                "description": "Detail URL."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "hooksData": {
+                      "type": "object",
+                      "description": "Hooks information.",
+                      "nullable": true
+                    },
+                    "ratesAndBenefitsData": {
+                      "type": "object",
+                      "description": "Information on rates and benefits that apply to the order.",
+                      "properties": {
+                        "rateAndBenefitsIdentifiers": {
+                          "type": "array",
+                          "description": "List with rates and benefits identifiers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit identifier."
+                          }
+                        },
+                        "teaser": {
+                          "type": "array",
+                          "description": "List with rates and benefits teasers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit teaser."
+                          }
+                        }
+                      }
+                    },
+                    "subscriptionData": {
+                      "type": "object",
+                      "description": "Subscription information.",
+                      "nullable": true
+                    },
+                    "itemsOrdination": {
+                      "type": "object",
+                      "description": "Object containing information about the ordering of items within the orderForm.",
+                      "properties": {
+                        "criteria": {
+                          "type": "string",
+                          "description": "Criteria adopted to order the items in the list."
+                        },
+                        "ascending": {
+                          "type": "boolean",
+                          "description": "Indicates whether the ordering is ascending."
+                        }
+                      }
+                    }
+                  }
+                },
+                "example": {
+                  "orderFormId": "ede846222cd44046ba6c638442c3505a",
+                  "salesChannel": "1",
+                  "loggedIn": false,
+                  "isCheckedIn": false,
+                  "storeId": "1",
+                  "allowManualPrice": false,
+                  "canEditData": true,
+                  "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
+                  "profileProvider": "VTEX",
+                  "availableAccounts": [],
+                  "availableAddresses": [
+                    {
+                      "addressType": "residential",
+                      "receiverName": "Clark Kent",
+                      "addressId": "666c2e830bd9474ab6f6cc53fb6dd2d2",
+                      "isDisposable": true,
+                      "postalCode": "70386000",
+                      "city": "Brasília",
+                      "state": "DF",
+                      "country": "BRA",
+                      "street": "Rua da minha casa",
+                      "number": "123",
+                      "neighborhood": "Copacabana",
+                      "complement": "15º andar",
+                      "reference": null,
+                      "geoCoordinates": [
+                        -47.924747467041016,
+                        -15.832582473754883
+                      ]
+                    }
+                  ],
+                  "userType": "User type",
+                  "ignoreProfileData": false,
+                  "value": 34390,
+                  "messages": [],
+                  "items": [
+                    {
+                      "uniqueId": "9D6E447B3FF64CEDA33B17C01379C119",
+                      "id": "2",
+                      "productId": "2",
+                      "productRefId": "1",
+                      "refId": "CBC30L",
+                      "ean": null,
+                      "name": "Chopp Brahma Claro 30L",
+                      "skuName": "Chopp Brahma Claro 30L",
+                      "modalType": null,
+                      "parentItemIndex": null,
+                      "parentAssemblyBinding": null,
+                      "assemblies": [],
+                      "priceValidUntil": "2022-07-13T18:30:46Z",
+                      "tax": 0,
+                      "price": 32890,
+                      "listPrice": 49900,
+                      "manualPrice": null,
+                      "manualPriceAppliedBy": null,
+                      "sellingPrice": 32890,
+                      "rewardValue": 0,
+                      "isGift": false,
+                      "additionalInfo": {
+                        "dimension": null,
+                        "brandName": "Brahma",
+                        "brandId": "2000000",
+                        "offeringInfo": null,
+                        "offeringType": null,
+                        "offeringTypeId": null
+                      },
+                      "preSaleDate": null,
+                      "productCategoryIds": "/1/",
+                      "productCategories": {
+                        "1": "Bebidas"
+                      },
+                      "quantity": 1,
+                      "seller": "1",
+                      "sellerChain": [
+                        "1"
+                      ],
+                      "imageUrl": "http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000",
+                      "detailUrl": "/chopp-brahma-claro-30l/p",
+                      "components": [],
+                      "bundleItems": [],
+                      "attachments": [],
+                      "attachmentOfferings": [
+                        {
+                          "name": "vtex.subscription.weekly",
+                          "required": false,
+                          "schema": {
+                            "vtex.subscription.key.frequency": {
+                              "MaximumNumberOfCharacters": 7,
+                              "Domain": [
+                                "1 week",
+                                "2 week",
+                                "3 week",
+                                "4 week"
+                              ]
+                            }
+                          }
+                        },
+                        {
+                          "name": "vtex.subscription.daily",
+                          "required": false,
+                          "schema": {
+                            "vtex.subscription.key.frequency": {
+                              "MaximumNumberOfCharacters": 5,
+                              "Domain": [
+                                "1 day"
+                              ]
+                            }
+                          }
+                        }
+                      ],
+                      "offerings": [],
+                      "priceTags": [
+                        {
+                          "name": "DISCOUNT@MANUALPRICE",
+                          "value": -5000,
+                          "rawValue": -50,
+                          "isPercentual": false,
+                          "identifier": "1234abc-5678b-1234c"
+                        }
+                      ],
+                      "availability": "available",
+                      "measurementUnit": "un",
+                      "unitMultiplier": 1,
+                      "manufacturerCode": null,
+                      "priceDefinition": {
+                        "calculatedSellingPrice": 32890,
+                        "total": 32890,
+                        "sellingPrices": [
+                          {
+                            "value": 32890,
+                            "quantity": 1
+                          }
+                        ]
+                      }
+                    }
+                  ],
+                  "selectableGifts": [],
+                  "totalizers": [
+                    {
+                      "id": "Items",
+                      "name": "Total Items",
+                      "value": 32890
+                    }
+                  ],
+                  "shippingData": {
+                    "address": {
+                      "addressType": "residential",
+                      "receiverName": "Clark Kent",
+                      "addressId": "teste",
+                      "isDisposable": true,
+                      "postalCode": "70386000",
+                      "city": "Brasília",
+                      "state": "DF",
+                      "country": "BRA",
+                      "street": "Rua da minha casa",
+                      "number": "123",
+                      "neighborhood": "Copacabana",
+                      "complement": "15º andar",
+                      "reference": null,
+                      "geoCoordinates": [
+                        -47.924747467041016,
+                        -15.832582473754883
+                      ]
+                    },
+                    "logisticsInfo": [
+                      {
+                        "itemIndex": 0,
+                        "selectedSla": "Normal",
+                        "selectedDeliveryChannel": "delivery",
+                        "addressId": "teste",
+                        "slas": [
+                          {
+                            "id": "Normal",
+                            "deliveryChannel": "delivery",
+                            "name": "Normal",
+                            "deliveryIds": [
+                              {
+                                "courierId": "1",
+                                "warehouseId": "1_1",
+                                "dockId": "1",
+                                "courierName": "Transportadora",
+                                "quantity": 1,
+                                "kitItemDetails": []
+                              }
+                            ],
+                            "shippingEstimate": "3bd",
+                            "shippingEstimateDate": null,
+                            "lockTTL": "10d",
+                            "availableDeliveryWindows": [],
+                            "deliveryWindow": null,
+                            "price": 1500,
+                            "listPrice": 1500,
+                            "tax": 0,
+                            "pickupStoreInfo": {
+                              "isPickupStore": false,
+                              "friendlyName": null,
+                              "address": null,
+                              "additionalInfo": null,
+                              "dockId": null
+                            },
+                            "pickupPointId": null,
+                            "pickupDistance": 0,
+                            "polygonName": null,
+                            "transitTime": "3bd"
+                          }
+                        ],
+                        "shipsTo": [
+                          "BRA",
+                          "COL",
+                          "USA"
+                        ],
+                        "itemId": "2",
+                        "deliveryChannels": [
+                          {
+                            "id": "delivery"
+                          },
+                          {
+                            "id": "pickup-in-point"
+                          }
+                        ]
+                      }
+                    ],
+                    "selectedAddresses": [
+                      {
+                        "addressType": "residential",
+                        "receiverName": "Clark Kent",
+                        "addressId": "teste",
+                        "isDisposable": true,
+                        "postalCode": "12345000",
+                        "city": "Rio de Janeiro",
+                        "state": "RJ",
+                        "country": "BRA",
+                        "street": "Rua da minha casa",
+                        "number": "123",
+                        "neighborhood": "Copacabana",
+                        "complement": "15º andar",
+                        "reference": null,
+                        "geoCoordinates": [
+                          -47.924747467041016,
+                          -15.832582473754883
+                        ]
+                      }
+                    ],
+                    "availableAddresses": [
+                      {
+                        "addressType": "residential",
+                        "receiverName": "Clark Kent",
+                        "addressId": "teste",
+                        "isDisposable": true,
+                        "postalCode": "12345000",
+                        "city": "Rio de Janeiro",
+                        "state": "RJ",
+                        "country": "BRA",
+                        "street": "Rua da minha casa",
+                        "number": "123",
+                        "neighborhood": "Copacabana",
+                        "complement": "15º andar",
+                        "reference": null,
+                        "geoCoordinates": [
+                          -47.924747467041016,
+                          -15.832582473754883
+                        ]
+                      }
+                    ],
+                    "pickupPoints": []
+                  },
+                  "clientProfileData": {
+                    "email": "clark.kent@example.com",
+                    "firstName": "Clark",
+                    "lastName": "Kent",
+                    "document": "12345678900",
+                    "documentType": "cpf",
+                    "phone": "+5521998765432",
+                    "corporateName": "company-name",
+                    "tradeName": "trade-name",
+                    "corporateDocument": "12345678000100",
+                    "stateInscription": "12345678",
+                    "corporatePhone": "551100988887777",
+                    "isCorporate": false,
+                    "profileCompleteOnLoading": false,
+                    "profileErrorOnLoading": false,
+                    "customerClass": null
+                  },
+                  "paymentData": {
+                    "giftCards": [],
+                    "transactions": [
+                      {
+                        "isActive": true,
+                        "transactionId": "296D6D245C17437E823EB77E403FC88D",
+                        "merchantName": "MYSTORE",
+                        "payments": [
+                          {
+                            "paymentSystem": 6,
+                            "bin": null,
+                            "accountId": "12",
+                            "tokenId": null,
+                            "value": 34390,
+                            "referenceValue": 34390,
+                            "giftCardRedemptionCode": null,
+                            "giftCardProvider": null,
+                            "giftCardId": null
+                          }
+                        ],
+                        "sharedTransaction": false
+                      }
+                    ]
+                  },
+                  "marketingData": {
+                    "coupon": "free-shipping",
+                    "utmSource": "app",
+                    "utmMedium": "CPC",
+                    "utmCampaign": "Black friday",
+                    "utmipage": null,
+                    "utmiPart": null,
+                    "utmiCampaign": null
+                  },
+                  "sellers": [
+                    {
+                      "id": "1",
+                      "name": "lojadobreno",
+                      "logo": "Logo"
+                    }
+                  ],
+                  "clientPreferencesData": {
+                    "locale": "pt-BR",
+                    "optinNewsLetter": false
+                  },
+                  "commercialConditionData": null,
+                  "storePreferencesData": {},
+                  "giftRegistryData": null,
+                  "openTextField": null,
+                  "invoiceData": null,
+                  "customData": null,
+                  "itemMetadata": {
+                    "items": [
+                      {
+                        "id": "2",
+                        "seller": "1",
+                        "name": "Chopp Brahma Claro 30L",
+                        "skuName": "Chopp Brahma Claro 30L",
+                        "productId": "2",
+                        "refId": "CBC30L",
+                        "ean": null,
+                        "imageUrl": "http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000",
+                        "detailUrl": "/chopp-brahma-claro-30l/p",
+                        "assemblyOptions": []
+                      }
+                    ]
+                  },
+                  "hooksData": null,
+                  "ratesAndBenefitsData": {
+                    "rateAndBenefitsIdentifiers": [],
+                    "teaser": []
+                  },
+                  "subscriptionData": null,
+                  "itemsOrdination": {
+                    "criteria": "NAME",
+                    "ascending": true
+                  }
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/api/checkout/pub/orderForm/{orderFormId}/installments": {
+      "get": {
+        "tags": [
+          "Shopping cart"
+        ],
+        "summary": "Cart installments",
+        "description": "Retrieves possible amount of installments and respective values for a given cart with a given payment method.\r\n\r\nThe [orderForm](https://developers.vtex.com/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.\n\r\n\rThis endpoint can be used to get the installment options for only one payment method at a time.\n\r\n\rThis endpoint should be called only after the selected `orderForm` already has a `paymentData`.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "GetCartInstallments",
+        "security": [],
+        "parameters": [
+          {
+            "name": "orderFormId",
+            "in": "path",
+            "required": true,
+            "description": "ID of the `orderForm` to be consulted for installments.",
+            "schema": {
+              "type": "string",
+              "example": "ede846222cd44046ba6c638442c3505a"
+            }
+          },
+          {
+            "name": "paymentSystem",
+            "in": "query",
+            "description": "ID of the payment method to be consulted for installments.",
+            "required": true,
+            "style": "form",
+            "explode": true,
+            "schema": {
+              "type": "integer",
+              "example": 2
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "example": {
+                  "paymentSystem": 2,
+                  "bin": null,
+                  "paymentName": null,
+                  "paymentGroupName": null,
+                  "value": 32000,
+                  "installments": [
+                    {
+                      "count": 1,
+                      "hasInterestRate": false,
+                      "interestRate": 0,
+                      "value": 32000,
+                      "total": 32000,
+                      "sellerMerchantInstallments": [
+                        {
+                          "id": "MyStore",
+                          "count": 1,
+                          "hasInterestRate": false,
+                          "interestRate": 0,
+                          "value": 32000,
+                          "total": 32000
+                        }
+                      ]
+                    },
+                    {
+                      "count": 2,
+                      "hasInterestRate": false,
+                      "interestRate": 0,
+                      "value": 1600,
+                      "total": 32000,
+                      "sellerMerchantInstallments": [
+                        {
+                          "id": "MyStore",
+                          "count": 2,
+                          "hasInterestRate": false,
+                          "interestRate": 0,
+                          "value": 1600,
+                          "total": 32000
+                        }
+                      ]
+                    },
+                    {
+                      "count": 3,
+                      "hasInterestRate": false,
+                      "interestRate": 0,
+                      "value": 10666,
+                      "total": 32000,
+                      "sellerMerchantInstallments": [
+                        {
+                          "id": "MyStore",
+                          "count": 3,
+                          "hasInterestRate": false,
+                          "interestRate": 0,
+                          "value": 10666,
+                          "total": 32000
+                        }
+                      ]
+                    }
+                  ]
+                },
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "bin": {
+                      "type": "string",
+                      "description": "Bin.",
+                      "nullable": true
+                    },
+                    "installments": {
+                      "type": "array",
+                      "description": "Array of installments.",
+                      "items": {
+                        "description": "Object with installments information.",
+                        "type": "object",
+                        "properties": {
+                          "count": {
+                            "description": "An explanation about the purpose of this instance.",
+                            "type": "integer"
+                          },
+                          "hasInterestRate": {
+                            "description": "An explanation about the purpose of this instance.",
+                            "type": "boolean"
+                          },
+                          "interestRate": {
+                            "description": "An explanation about the purpose of this instance.",
+                            "type": "integer"
+                          },
+                          "value": {
+                            "description": "An explanation about the purpose of this instance.",
+                            "type": "integer"
+                          },
+                          "total": {
+                            "description": "An explanation about the purpose of this instance.",
+                            "type": "integer"
+                          },
+                          "sellerMerchantInstallments": {
+                            "description": "An explanation about the purpose of this instance.",
+                            "type": "array",
+                            "items": {
+                              "description": "An explanation about the purpose of this instance.",
+                              "type": "object",
+                              "properties": {
+                                "id": {
+                                  "description": "Installment ID.",
+                                  "type": "string"
+                                },
+                                "count": {
+                                  "description": "Count.",
+                                  "type": "integer"
+                                },
+                                "hasInterestRate": {
+                                  "description": "If the installment has an interest rate.",
+                                  "type": "boolean"
+                                },
+                                "interestRate": {
+                                  "description": "Interest rate number.",
+                                  "type": "integer"
+                                },
+                                "value": {
+                                  "description": "Installment value.",
+                                  "type": "integer"
+                                },
+                                "total": {
+                                  "description": "Installment total.",
+                                  "type": "integer"
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "paymentSystem": {
+                      "type": "integer",
+                      "description": "Payment system."
+                    },
+                    "value": {
+                      "type": "integer",
+                      "description": "Value including interest, in case it applies. Displayed in cents."
+                    },
+                    "paymentName": {
+                      "type": "string",
+                      "description": "Payment name.",
+                      "nullable": true
+                    },
+                    "paymentGroupName": {
+                      "type": "string",
+                      "description": "Payment group name.",
+                      "nullable": true
+                    }
+                  }
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/api/checkout/pub/orderForm/{orderFormId}/coupons": {
+      "post": {
+        "tags": [
+          "Shopping cart"
+        ],
+        "summary": "Add coupons to the cart",
+        "description": "Use this request to add coupons to a given shopping cart.\n\r\n\rTo add multiple coupons to the same cart, you need to:\n\r\n\r1. 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.\n\r2. Submit all coupon codes in the same requisition separated by commas. E.g.: {\"text\": \"freeshipping, discount10, holiday30\"}.\r\n\r\nFor more information on multiple coupons, access the [coupons tutorial](https://help.vtex.com/en/tutorial/creating-a-coupon-beta--7lMk3MmhNp2IEccyGApxU).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "AddCoupons",
+        "security": [],
+        "parameters": [
+          {
+            "name": "orderFormId",
+            "in": "path",
+            "required": true,
+            "description": "ID of the orderForm that will receive coupon information.",
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "ede846222cd44046ba6c638442c3505a"
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "text": {
+                    "type": "string",
+                    "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase."
+                  }
+                }
+              },
+              "example": "freeshipping"
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "orderFormId": {
+                      "type": "string",
+                      "description": "ID of the orderForm corresponding to a specific cart."
+                    },
+                    "salesChannel": {
+                      "type": "string",
+                      "description": "Attribute created by the seller, in their VTEX store configuration."
+                    },
+                    "loggedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether the user is logged into the store."
+                    },
+                    "isCheckedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether order is checked in."
+                    },
+                    "storeId": {
+                      "type": "string",
+                      "description": "ID of the store.",
+                      "nullable": true
+                    },
+                    "allowManualPrice": {
+                      "type": "boolean",
+                      "description": "Permission to modify item price manually."
+                    },
+                    "canEditData": {
+                      "type": "boolean",
+                      "description": "Data can be edited."
+                    },
+                    "userProfileId": {
+                      "type": "string",
+                      "description": "Unique ID associated with the customer profile."
+                    },
+                    "profileProvider": {
+                      "type": "string",
+                      "description": "Profile provider."
+                    },
+                    "availableAccounts": {
+                      "type": "array",
+                      "description": "Available accounts.",
+                      "items": {
+                        "type": "string",
+                        "description": "Available account."
+                      }
+                    },
+                    "availableAddresses": {
+                      "type": "array",
+                      "description": "Information on each available address.",
+                      "items": {
+                        "description": "Address information.",
+                        "type": "object",
+                        "properties": {
+                          "addressType": {
+                            "type": "string",
+                            "description": "Address type."
+                          },
+                          "receiverName": {
+                            "type": "string",
+                            "description": "Name of the receiver."
+                          },
+                          "addressId": {
+                            "type": "string",
+                            "description": "Address ID.",
+                            "nullable": true
+                          },
+                          "isDisposable": {
+                            "type": "boolean",
+                            "description": "Indicates whether address is disposable."
+                          },
+                          "city": {
+                            "type": "string",
+                            "description": "City of the address."
+                          },
+                          "state": {
+                            "type": "string",
+                            "description": "State of the address."
+                          },
+                          "country": {
+                            "type": "string",
+                            "description": "Country of the address. ISO three-letter code."
+                          },
+                          "street": {
+                            "type": "string",
+                            "description": "Street of the address."
+                          },
+                          "number": {
+                            "type": "string",
+                            "description": "Number of the address."
+                          },
+                          "neighborhood": {
+                            "type": "string",
+                            "description": "Neighborhood of the address."
+                          },
+                          "complement": {
+                            "type": "string",
+                            "description": "Complement to the address.",
+                            "nullable": true
+                          },
+                          "reference": {
+                            "type": "string",
+                            "description": "Reference that may help in the location of the address.",
+                            "nullable": true
+                          },
+                          "geoCoordinates": {
+                            "type": "array",
+                            "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
+                            "items": {
+                              "type": "number",
+                              "description": "Geocoordinates numbers."
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "userType": {
+                      "type": "string",
+                      "description": "User type.",
+                      "nullable": true
+                    },
+                    "ignoreProfileData": {
+                      "type": "boolean",
+                      "description": "Ignore customer profile data."
+                    },
+                    "value": {
+                      "type": "integer",
+                      "description": "Total value of the order without separating cents. For example, $24.99 is represented `2499`."
+                    },
+                    "messages": {
+                      "type": "array",
+                      "description": "Array containing an object for each message generated by our servers while processing the request.",
+                      "items": {
+                        "type": "string",
+                        "description": "Message."
+                      }
+                    },
+                    "items": {
+                      "type": "array",
+                      "description": "Information on each item in the order.",
+                      "items": {
+                        "description": "Item information.",
+                        "type": "object",
+                        "properties": {
+                          "uniqueId": {
+                            "type": "string",
+                            "description": "Unique ID."
+                          },
+                          "id": {
+                            "type": "string",
+                            "description": "ID of the item."
+                          },
+                          "productId": {
+                            "type": "string",
+                            "description": "Product ID."
+                          },
+                          "productRefId": {
+                            "type": "string",
+                            "description": "Product Ref ID."
+                          },
+                          "refId": {
+                            "type": "string",
+                            "description": "Ref ID."
+                          },
+                          "ean": {
+                            "type": "string",
+                            "description": "European Article Number.",
+                            "nullable": true
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Product name."
+                          },
+                          "skuName": {
+                            "type": "string",
+                            "description": "SKU name."
+                          },
+                          "modalType": {
+                            "type": "string",
+                            "description": "Modal type.",
+                            "nullable": true
+                          },
+                          "parentItemIndex": {
+                            "type": "integer",
+                            "description": "Parent item index.",
+                            "nullable": true
+                          },
+                          "parentAssemblyBinding": {
+                            "type": "string",
+                            "description": "Parent assembly binding.",
+                            "nullable": true
+                          },
+                          "priceValidUntil": {
+                            "type": "string",
+                            "description": "Price expiration date and time."
+                          },
+                          "tax": {
+                            "type": "integer",
+                            "description": "Tax value in cents."
+                          },
+                          "price": {
+                            "type": "integer",
+                            "description": "Price in cents."
+                          },
+                          "listPrice": {
+                            "type": "integer",
+                            "description": "List price in cents."
+                          },
+                          "manualPrice": {
+                            "type": "integer",
+                            "description": "Manual price in cents.",
+                            "nullable": true
+                          },
+                          "manualPriceAppliedBy": {
+                            "type": "string",
+                            "description": "User that applied the manual price, if that is the case.",
+                            "nullable": true
+                          },
+                          "sellingPrice": {
+                            "type": "integer",
+                            "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
+                          },
+                          "rewardValue": {
+                            "type": "integer",
+                            "description": "Reward value in cents."
+                          },
+                          "isGift": {
+                            "type": "boolean",
+                            "description": "Indicates whether item is a gift."
+                          },
+                          "additionalInfo": {
+                            "type": "object",
+                            "description": "Additional information.",
+                            "properties": {
+                              "dimension": {
+                                "type": "string",
+                                "description": "Dimension.",
+                                "nullable": true
+                              },
+                              "brandName": {
+                                "type": "string",
+                                "description": "Brand name."
+                              },
+                              "brandId": {
+                                "type": "string",
+                                "description": "Brand ID."
+                              },
+                              "offeringInfo": {
+                                "type": "string",
+                                "description": "Offering information.",
+                                "nullable": true
+                              },
+                              "offeringType": {
+                                "type": "string",
+                                "description": "Offering type.",
+                                "nullable": true
+                              },
+                              "offeringTypeId": {
+                                "type": "string",
+                                "description": "Offering type ID.",
+                                "nullable": true
+                              }
+                            }
+                          },
+                          "preSaleDate": {
+                            "type": "string",
+                            "description": "Presale date.",
+                            "nullable": true
+                          },
+                          "productCategoryIds": {
+                            "type": "string",
+                            "description": "Product category IDs."
+                          },
+                          "productCategories": {
+                            "type": "object",
+                            "description": "Object, where each field is an ID from `productCategoryIds`.",
+                            "properties": {
+                              "{ID}": {
+                                "type": "string",
+                                "description": "Product category corresponding to the ID in the field key."
+                              }
+                            }
+                          },
+                          "quantity": {
+                            "type": "integer",
+                            "description": "Quantity."
+                          },
+                          "seller": {
+                            "type": "string",
+                            "description": "Seller."
+                          },
+                          "sellerChain": {
+                            "type": "array",
+                            "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
+                            "items": {
+                              "type": "string",
+                              "description": "Seller."
+                            }
+                          },
+                          "imageUrl": {
+                            "type": "string",
+                            "description": "Image URL."
+                          },
+                          "detailUrl": {
+                            "type": "string",
+                            "description": "Detail URL."
+                          },
+                          "bundleItems": {
+                            "type": "array",
+                            "description": "Information on services sold along with the SKU. Example: a gift package.",
+                            "items": {
+                              "description": "Service information.",
+                              "type": "object",
+                              "properties": {
+                                "type": {
+                                  "type": "string",
+                                  "description": "Service type."
+                                },
+                                "id": {
+                                  "type": "integer",
+                                  "description": "Service identifier."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Service name."
+                                },
+                                "price": {
+                                  "type": "integer",
+                                  "description": "Service price in cents."
+                                }
+                              }
+                            }
+                          },
+                          "attachments": {
+                            "type": "array",
+                            "description": "Array containing information on attachments.",
+                            "items": {
+                              "type": "string",
+                              "description": "Attachment information."
+                            }
+                          },
+                          "priceTags": {
+                            "type": "array",
+                            "description": "Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.",
+                            "items": {
+                              "description": "Price tag information.",
+                              "type": "object",
+                              "properties": {
+                                "identifier": {
+                                  "type": "string",
+                                  "description": "Promotion unique identifier.",
+                                  "nullable": true
+                                },
+                                "isPercentual": {
+                                  "type": "boolean",
+                                  "description": "Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\r\n- `type` indicates whether the tag refers to a discount or tax.\r\n- `where` specifies the context, either price or shipping.\r\n- `identifier` is the promotion ID.\r\n- `calculationId` is a hash that may vary with each price calculation."
+                                },
+                                "rawValue": {
+                                  "type": "number",
+                                  "description": "Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations."
+                                },
+                                "value": {
+                                  "type": "integer",
+                                  "description": "Price tag value representing either a promotion (value decrease) or a tax (value increase)."
+                                }
+                              }
+                            }
+                          },
+                          "availability": {
+                            "type": "string",
+                            "description": "Availability."
+                          },
+                          "measurementUnit": {
+                            "type": "string",
+                            "description": "Measurement unit."
+                          },
+                          "unitMultiplier": {
+                            "type": "integer",
+                            "description": "Unit multiplier."
+                          },
+                          "manufacturerCode": {
+                            "type": "string",
+                            "description": "Manufacturer code.",
+                            "nullable": true
+                          },
+                          "priceDefinition": {
+                            "type": "object",
+                            "description": "Price information for all units of a specific item.",
+                            "properties": {
+                              "calculatedSellingPrice": {
+                                "type": "integer",
+                                "description": "Item's calculated unitary selling price in cents."
+                              },
+                              "total": {
+                                "type": "integer",
+                                "description": "Total value for all units of the item in cents."
+                              },
+                              "sellingPrices": {
+                                "type": "array",
+                                "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
+                                "items": {
+                                  "description": "Rounding information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value in cents for that specific rounding."
+                                    },
+                                    "quantity": {
+                                      "type": "integer",
+                                      "description": "Rounding quantity, meaning how many items are rounded to this value."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "selectableGifts": {
+                      "type": "array",
+                      "description": "Array containing the data of the item selected as a gift.",
+                      "items": {
+                        "type": "string",
+                        "description": "Gift."
+                      }
+                    },
+                    "totalizers": {
+                      "type": "array",
+                      "description": "Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).",
+                      "items": {
+                        "type": "object",
+                        "description": "Totalizer of purchases."
+                      }
+                    },
+                    "shippingData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Shipping information pertinent to the order.",
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Address information.",
+                          "properties": {
+                            "addressType": {
+                              "type": "string",
+                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                            },
+                            "receiverName": {
+                              "type": "string",
+                              "description": "Name of the person who is going to receive the order."
+                            },
+                            "addressId": {
+                              "type": "string",
+                              "description": "Address ID.",
+                              "nullable": true
+                            },
+                            "isDisposable": {
+                              "type": "boolean",
+                              "description": "Indicates whether address is disposable."
+                            },
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City of the shipping address."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State of the shipping address."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Three letter ISO code of the country of the shipping address."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street of the shipping address."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Number of the building, house or apartment in the shipping address."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood of the shipping address."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Complement to the shipping address, in case it applies.",
+                              "nullable": true
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                              "nullable": true
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
+                              "items": {
+                                "type": "number",
+                                "description": "Geocoordinates numbers."
+                              }
+                            }
+                          }
+                        },
+                        "logisticsInfo": {
+                          "type": "array",
+                          "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.",
+                          "items": {
+                            "description": "Logistics information.",
+                            "type": "object",
+                            "properties": {
+                              "itemIndex": {
+                                "type": "integer",
+                                "description": "Index corresponding to the position of the object in the `items` array."
+                              },
+                              "selectedSla": {
+                                "type": "string",
+                                "description": "SLA selected by the customer.",
+                                "nullable": true
+                              },
+                              "selectedDeliveryChannel": {
+                                "type": "string",
+                                "description": "Delivery channel selected by the customer.",
+                                "nullable": true
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "slas": {
+                                "type": "array",
+                                "description": "Information on available SLAs.",
+                                "items": {
+                                  "description": "SLA information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "SLA ID."
+                                    },
+                                    "deliveryChannel": {
+                                      "type": "string",
+                                      "description": "Delivery channel."
+                                    },
+                                    "name": {
+                                      "type": "string",
+                                      "description": "SLA name."
+                                    },
+                                    "deliveryIds": {
+                                      "type": "array",
+                                      "description": "Information on each delivery ID.",
+                                      "items": {
+                                        "type": "object",
+                                        "properties": {
+                                          "courierId": {
+                                            "type": "string",
+                                            "description": "Courier ID."
+                                          },
+                                          "warehouseId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "dockId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "courierName": {
+                                            "type": "string",
+                                            "description": "Courier name."
+                                          },
+                                          "quantity": {
+                                            "type": "integer",
+                                            "description": "Quantity."
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "shippingEstimate": {
+                                      "type": "string",
+                                      "description": "Shipping estimate. For instance, Three business days will be represented `3bd`."
+                                    },
+                                    "shippingEstimateDate": {
+                                      "type": "string",
+                                      "description": "When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.",
+                                      "nullable": true
+                                    },
+                                    "useIndividualShippingEstimates": {
+                                      "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+                                      "type": "boolean"
+                                    },
+                                    "lockTTL": {
+                                      "type": "string",
+                                      "description": "Estimate date of delivery.",
+                                      "nullable": true
+                                    },
+                                    "price": {
+                                      "type": "integer",
+                                      "description": "Price in cents."
+                                    },
+                                    "listPrice": {
+                                      "type": "integer",
+                                      "description": "List price in cents."
+                                    },
+                                    "tax": {
+                                      "type": "integer",
+                                      "description": "Tax in cents."
+                                    },
+                                    "pickupStoreInfo": {
+                                      "type": "object",
+                                      "description": "Information on the pickup store.",
+                                      "properties": {
+                                        "isPickupStore": {
+                                          "type": "boolean",
+                                          "description": "Indicates whether it is the pickup store."
+                                        },
+                                        "friendlyName": {
+                                          "type": "string",
+                                          "description": "Friendly name.",
+                                          "nullable": true
+                                        },
+                                        "address": {
+                                          "type": "object",
+                                          "description": "Address information.",
+                                          "nullable": true,
+                                          "properties": {
+                                            "addressType": {
+                                              "type": "string",
+                                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                                            },
+                                            "postalCode": {
+                                              "type": "string",
+                                              "description": "Postal code."
+                                            },
+                                            "city": {
+                                              "type": "string",
+                                              "description": "City of the shipping address."
+                                            },
+                                            "state": {
+                                              "type": "string",
+                                              "description": "State of the shipping address."
+                                            },
+                                            "country": {
+                                              "type": "string",
+                                              "description": "Three letter ISO code of the country of the shipping address."
+                                            },
+                                            "street": {
+                                              "type": "string",
+                                              "description": "Street of the shipping address."
+                                            },
+                                            "number": {
+                                              "type": "string",
+                                              "description": "Number of the building, house or apartment in the shipping address."
+                                            },
+                                            "neighborhood": {
+                                              "type": "string",
+                                              "description": "Neighborhood of the shipping address."
+                                            },
+                                            "complement": {
+                                              "type": "string",
+                                              "description": "Complement to the shipping address, in case it applies.",
+                                              "nullable": true
+                                            },
+                                            "reference": {
+                                              "type": "string",
+                                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                              "nullable": true
+                                            },
+                                            "geoCoordinates": {
+                                              "type": "array",
+                                              "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
+                                              "items": {
+                                                "type": "number",
+                                                "description": "Geocoordinates numbers."
+                                              }
+                                            }
+                                          }
+                                        },
+                                        "additionalInfo": {
+                                          "type": "string",
+                                          "description": "Additional information.",
+                                          "nullable": true
+                                        },
+                                        "dockId": {
+                                          "type": "string",
+                                          "description": "Corresponding dock ID.",
+                                          "nullable": true
+                                        }
+                                      }
+                                    },
+                                    "pickupPointId": {
+                                      "type": "string",
+                                      "description": "Pickup point ID.",
+                                      "nullable": true
+                                    },
+                                    "pickupDistance": {
+                                      "type": "integer",
+                                      "description": "Pickup point distance."
+                                    },
+                                    "polygonName": {
+                                      "type": "string",
+                                      "description": "Polygon name.",
+                                      "nullable": true
+                                    },
+                                    "transitTime": {
+                                      "type": "string",
+                                      "description": "Transit time. For instance, \"three business days\" is represented `3bd`."
+                                    }
+                                  }
+                                }
+                              },
+                              "shipsTo": {
+                                "type": "array",
+                                "description": "List of countries that the item may be shipped to.",
+                                "items": {
+                                  "type": "string",
+                                  "description": "Three letter country code."
+                                }
+                              },
+                              "itemId": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "deliveryChannels": {
+                                "type": "array",
+                                "description": "List of available delivery channels.",
+                                "items": {
+                                  "description": "Delivery channel information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "Delivery channel ID."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "selectedAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the selected addresses for the order.",
+                          "items": {
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates numbers."
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "availableAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the available addresses for the order.",
+                          "items": {
+                            "description": "Address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates numbers."
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "clientProfileData": {
+                      "type": "object",
+                      "description": "Customer's profile information.",
+                      "nullable": true,
+                      "properties": {
+                        "email": {
+                          "type": "string",
+                          "description": "Email address.",
+                          "nullable": true
+                        },
+                        "firstName": {
+                          "type": "string",
+                          "description": "First name.",
+                          "nullable": true
+                        },
+                        "lastName": {
+                          "type": "string",
+                          "description": "Last name."
+                        },
+                        "documentType": {
+                          "type": "string",
+                          "description": "Type of the document informed by the customer."
+                        },
+                        "document": {
+                          "type": "string",
+                          "description": "Document informed by the customer."
+                        },
+                        "phone": {
+                          "type": "string",
+                          "description": "Phone number."
+                        },
+                        "corporateName": {
+                          "type": "string",
+                          "description": "Company name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "tradeName": {
+                          "type": "string",
+                          "description": "Trade name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporateDocument": {
+                          "type": "string",
+                          "description": "Corporate document, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "stateInscription": {
+                          "type": "string",
+                          "description": "State inscription, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporatePhone": {
+                          "type": "string",
+                          "description": "Corporate phone number, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "isCorporate": {
+                          "type": "boolean",
+                          "description": "Indicates whether the customer is a legal entity."
+                        },
+                        "profileCompleteOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile is complete on loading."
+                        },
+                        "profileErrorOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile presents error on loading.",
+                          "nullable": true
+                        },
+                        "customerClass": {
+                          "type": "string",
+                          "description": "Customer class.",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "paymentData": {
+                      "type": "object",
+                      "description": "Information on the order's payment.",
+                      "properties": {
+                        "giftCards": {
+                          "type": "array",
+                          "description": "Gift card information, if it applies to the order.",
+                          "items": {
+                            "description": "Gift card information.",
+                            "nullable": true,
+                            "type": "object",
+                            "properties": {
+                              "redemptionCode": {
+                                "type": "string",
+                                "description": "Gift card redemption code."
+                              },
+                              "value": {
+                                "type": "integer",
+                                "description": "Gift card value in cents."
+                              },
+                              "balance": {
+                                "type": "integer",
+                                "description": "Gift card balance in cents."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Gift card name."
+                              },
+                              "id": {
+                                "type": "string",
+                                "description": "Gift card ID."
+                              },
+                              "inUse": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is in use."
+                              },
+                              "isSpecialCard": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is special."
+                              }
+                            }
+                          }
+                        },
+                        "transactions": {
+                          "type": "array",
+                          "description": "Information on each transaction pertinent to the order.",
+                          "items": {
+                            "description": "Transaction information.",
+                            "nullable": true,
+                            "type": "object",
+                            "properties": {
+                              "isActive": {
+                                "type": "boolean",
+                                "description": "Indicates whether transaction is active."
+                              },
+                              "transactionId": {
+                                "type": "string",
+                                "description": "Transaction ID."
+                              },
+                              "merchantName": {
+                                "type": "string",
+                                "description": "Merchant name."
+                              },
+                              "payments": {
+                                "type": "array",
+                                "description": "Information on each payment.",
+                                "items": {
+                                  "description": "Payment information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "accountId": {
+                                      "type": "string",
+                                      "description": "Account ID."
+                                    },
+                                    "bin": {
+                                      "type": "string",
+                                      "description": "Bin.",
+                                      "nullable": true
+                                    },
+                                    "installments": {
+                                      "type": "integer",
+                                      "description": "Number of installments."
+                                    },
+                                    "paymentSystem": {
+                                      "type": "integer",
+                                      "description": "Payment system."
+                                    },
+                                    "referenceValue": {
+                                      "type": "integer",
+                                      "description": "Reference value for calculating interest rates, in case it applies. Displayed in cents."
+                                    },
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value including interest, in case it applies. Displayed in cents."
+                                    }
+                                  }
+                                }
+                              },
+                              "sharedTransaction": {
+                                "type": "boolean",
+                                "description": "Indicates whather transaction is shared."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "marketingData": {
+                      "type": "object",
+                      "description": "Object containIng promotion data such as coupon tracking information and internal or external UTMs.",
+                      "nullable": true,
+                      "properties": {
+                        "coupon": {
+                          "type": "string",
+                          "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.",
+                          "example": "free-shipping"
+                        },
+                        "utmSource": {
+                          "type": "string",
+                          "description": "UTM source.",
+                          "example": "Facebook",
+                          "nullable": true
+                        },
+                        "utmMedium": {
+                          "type": "string",
+                          "description": "UTM medium.",
+                          "example": "CPC",
+                          "nullable": true
+                        },
+                        "utmCampaign": {
+                          "type": "string",
+                          "description": "UTM campaign.",
+                          "example": "Black friday",
+                          "nullable": true
+                        },
+                        "utmiPage": {
+                          "type": "string",
+                          "description": "utmi_page (internal utm).",
+                          "example": "utmi_page-example",
+                          "nullable": true
+                        },
+                        "utmiPart": {
+                          "type": "string",
+                          "description": "utmi_part (internal utm).",
+                          "example": "utmi_part-exmaple",
+                          "nullable": true
+                        },
+                        "utmiCampaign": {
+                          "type": "string",
+                          "description": "utmi_campaign (internal utm).",
+                          "example": "utmi_campaign-exmaple",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "sellers": {
+                      "type": "array",
+                      "description": "Information on each seller.",
+                      "items": {
+                        "description": "Seller information.",
+                        "nullable": true,
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "Seller ID."
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Seller name."
+                          },
+                          "logo": {
+                            "type": "string",
+                            "description": "Seller logo.",
+                            "nullable": true
+                          }
+                        }
+                      }
+                    },
+                    "clientPreferencesData": {
+                      "type": "object",
+                      "description": "Object containing preferences from the client who placed the order.",
+                      "properties": {
+                        "locale": {
+                          "type": "string",
+                          "description": "Client's locale. Examples: `pt-BR` and `en-US`."
+                        },
+                        "optinNewsLetter": {
+                          "type": "boolean",
+                          "description": "`true` if the client opted to receive newsletter from the store.",
+                          "nullable": false
+                        }
+                      }
+                    },
+                    "commercialConditionData": {
+                      "type": "object",
+                      "description": "Object containing commercial condition information.",
+                      "nullable": true
+                    },
+                    "storePreferencesData": {
+                      "type": "object",
+                      "description": "Object containing data from the store's configuration (stored in VTEX's License Manager)."
+                    },
+                    "giftRegistryData": {
+                      "type": "object",
+                      "description": "Gift registry list information.",
+                      "nullable": true
+                    },
+                    "openTextField": {
+                      "type": "string",
+                      "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON`, even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/docs/guides/customizable-fields-with-checkout-api).",
+                      "example": "open-text-example",
+                      "nullable": true
+                    },
+                    "invoiceData": {
+                      "type": "object",
+                      "description": "Invoice data including billing address.",
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Billing address.",
+                          "properties": {
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City name."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State name."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Country."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street name."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Street number."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Address complement."
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Reference for location."
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Geographic coordinates (latitude, longitude).",
+                              "items": {
+                                "type": "number"
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "customData": {
+                      "type": "object",
+                      "description": "Customer additional information.",
+                      "nullable": true
+                    },
+                    "itemMetadata": {
+                      "type": "object",
+                      "description": "Item metadata.",
+                      "properties": {
+                        "items": {
+                          "type": "array",
+                          "description": "List of objects containing metadata on each item in the order.",
+                          "items": {
+                            "description": "Item metadata.",
+                            "nullable": true,
+                            "type": "object",
+                            "properties": {
+                              "id": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "seller": {
+                                "type": "string",
+                                "description": "Seller."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Product name."
+                              },
+                              "skuName": {
+                                "type": "string",
+                                "description": "SKU name."
+                              },
+                              "productId": {
+                                "type": "string",
+                                "description": "Product ID."
+                              },
+                              "refId": {
+                                "type": "string",
+                                "description": "Ref ID."
+                              },
+                              "ean": {
+                                "type": "string",
+                                "description": "European Article Number.",
+                                "nullable": true
+                              },
+                              "imageUrl": {
+                                "type": "string",
+                                "description": "Image URL."
+                              },
+                              "detailUrl": {
+                                "type": "string",
+                                "description": "Detail URL."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "hooksData": {
+                      "type": "object",
+                      "description": "Hooks information.",
+                      "nullable": true
+                    },
+                    "ratesAndBenefitsData": {
+                      "type": "object",
+                      "description": "Information on rates and benefits that apply to the order.",
+                      "properties": {
+                        "rateAndBenefitsIdentifiers": {
+                          "type": "array",
+                          "description": "List with rates and benefits identifiers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit identifier."
+                          }
+                        },
+                        "teaser": {
+                          "type": "array",
+                          "description": "List with rates and benefits teasers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit teaser."
+                          }
+                        }
+                      }
+                    },
+                    "subscriptionData": {
+                      "type": "object",
+                      "description": "Subscription information.",
+                      "nullable": true
+                    },
+                    "itemsOrdination": {
+                      "type": "object",
+                      "description": "Object containing information about the ordering of items within the orderForm.",
+                      "properties": {
+                        "criteria": {
+                          "type": "string",
+                          "description": "Criteria adopted to order the items in the list."
+                        },
+                        "ascending": {
+                          "type": "boolean",
+                          "description": "Indicates whether the ordering is ascending."
+                        }
+                      }
+                    }
+                  }
+                },
+                "example": {
+                  "orderFormId": "ede846222cd44046ba6c638442c3505a",
+                  "salesChannel": "1",
+                  "loggedIn": false,
+                  "isCheckedIn": false,
+                  "storeId": "1",
+                  "allowManualPrice": false,
+                  "canEditData": true,
+                  "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
+                  "profileProvider": "VTEX",
+                  "availableAccounts": [],
+                  "availableAddresses": [
+                    {
+                      "addressType": "residential",
+                      "receiverName": "Clark Kent",
+                      "addressId": "666c2e830bd9474ab6f6cc53fb6dd2d2",
+                      "isDisposable": true,
+                      "postalCode": "70386000",
+                      "city": "Brasília",
+                      "state": "DF",
+                      "country": "BRA",
+                      "street": "Rua da minha casa",
+                      "number": "123",
+                      "neighborhood": "Copacabana",
+                      "complement": "15º andar",
+                      "reference": null,
+                      "geoCoordinates": [
+                        -47.924747467041016,
+                        -15.832582473754883
+                      ]
+                    }
+                  ],
+                  "userType": "User type",
+                  "ignoreProfileData": false,
+                  "value": 34390,
+                  "messages": [],
+                  "items": [
+                    {
+                      "uniqueId": "9D6E447B3FF64CEDA33B17C01379C119",
+                      "id": "2",
+                      "productId": "2",
+                      "productRefId": "1",
+                      "refId": "CBC30L",
+                      "ean": null,
+                      "name": "Chopp Brahma Claro 30L",
+                      "skuName": "Chopp Brahma Claro 30L",
+                      "modalType": null,
+                      "parentItemIndex": null,
+                      "parentAssemblyBinding": null,
+                      "assemblies": [],
+                      "priceValidUntil": "2022-07-13T18:30:46Z",
+                      "tax": 0,
+                      "price": 32890,
+                      "listPrice": 49900,
+                      "manualPrice": null,
+                      "manualPriceAppliedBy": null,
+                      "sellingPrice": 32890,
+                      "rewardValue": 0,
+                      "isGift": false,
+                      "additionalInfo": {
+                        "dimension": null,
+                        "brandName": "Brahma",
+                        "brandId": "2000000",
+                        "offeringInfo": null,
+                        "offeringType": null,
+                        "offeringTypeId": null
+                      },
+                      "preSaleDate": null,
+                      "productCategoryIds": "/1/",
+                      "productCategories": {
+                        "1": "Bebidas"
+                      },
+                      "quantity": 1,
+                      "seller": "1",
+                      "sellerChain": [
+                        "1"
+                      ],
+                      "imageUrl": "http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000",
+                      "detailUrl": "/chopp-brahma-claro-30l/p",
+                      "components": [],
+                      "bundleItems": [],
+                      "attachments": [],
+                      "attachmentOfferings": [
+                        {
+                          "name": "vtex.subscription.weekly",
+                          "required": false,
+                          "schema": {
+                            "vtex.subscription.key.frequency": {
+                              "MaximumNumberOfCharacters": 7,
+                              "Domain": [
+                                "1 week",
+                                "2 week",
+                                "3 week",
+                                "4 week"
+                              ]
+                            }
+                          }
+                        },
+                        {
+                          "name": "vtex.subscription.daily",
+                          "required": false,
+                          "schema": {
+                            "vtex.subscription.key.frequency": {
+                              "MaximumNumberOfCharacters": 5,
+                              "Domain": [
+                                "1 day"
+                              ]
+                            }
+                          }
+                        }
+                      ],
+                      "offerings": [],
+                      "priceTags": [
+                        {
+                          "name": "DISCOUNT@MANUALPRICE",
+                          "value": -5000,
+                          "rawValue": -50,
+                          "isPercentual": false,
+                          "identifier": "1234abc-5678b-1234c"
+                        }
+                      ],
+                      "availability": "available",
+                      "measurementUnit": "un",
+                      "unitMultiplier": 1,
+                      "manufacturerCode": null,
+                      "priceDefinition": {
+                        "calculatedSellingPrice": 32890,
+                        "total": 32890,
+                        "sellingPrices": [
+                          {
+                            "value": 32890,
+                            "quantity": 1
+                          }
+                        ]
+                      }
+                    }
+                  ],
+                  "selectableGifts": [],
+                  "totalizers": [
+                    {
+                      "id": "Items",
+                      "name": "Total Items",
+                      "value": 32890
+                    }
+                  ],
+                  "shippingData": {
+                    "address": {
+                      "addressType": "residential",
+                      "receiverName": "Clark Kent",
+                      "addressId": "teste",
+                      "isDisposable": true,
+                      "postalCode": "70386000",
+                      "city": "Brasília",
+                      "state": "DF",
+                      "country": "BRA",
+                      "street": "Rua da minha casa",
+                      "number": "123",
+                      "neighborhood": "Copacabana",
+                      "complement": "15º andar",
+                      "reference": null,
+                      "geoCoordinates": [
+                        -47.924747467041016,
+                        -15.832582473754883
+                      ]
+                    },
+                    "logisticsInfo": [
+                      {
+                        "itemIndex": 0,
+                        "selectedSla": "Normal",
+                        "selectedDeliveryChannel": "delivery",
+                        "addressId": "teste",
+                        "slas": [
+                          {
+                            "id": "Normal",
+                            "deliveryChannel": "delivery",
+                            "name": "Normal",
+                            "deliveryIds": [
+                              {
+                                "courierId": "1",
+                                "warehouseId": "1_1",
+                                "dockId": "1",
+                                "courierName": "Transportadora",
+                                "quantity": 1,
+                                "kitItemDetails": []
+                              }
+                            ],
+                            "shippingEstimate": "3bd",
+                            "shippingEstimateDate": null,
+                            "lockTTL": "10d",
+                            "availableDeliveryWindows": [],
+                            "deliveryWindow": null,
+                            "price": 1500,
+                            "listPrice": 1500,
+                            "tax": 0,
+                            "pickupStoreInfo": {
+                              "isPickupStore": false,
+                              "friendlyName": null,
+                              "address": null,
+                              "additionalInfo": null,
+                              "dockId": null
+                            },
+                            "pickupPointId": null,
+                            "pickupDistance": 0,
+                            "polygonName": null,
+                            "transitTime": "3bd"
+                          }
+                        ],
+                        "shipsTo": [
+                          "BRA",
+                          "COL",
+                          "USA"
+                        ],
+                        "itemId": "2",
+                        "deliveryChannels": [
+                          {
+                            "id": "delivery"
+                          },
+                          {
+                            "id": "pickup-in-point"
+                          }
+                        ]
+                      }
+                    ],
+                    "selectedAddresses": [
+                      {
+                        "addressType": "residential",
+                        "receiverName": "Clark Kent",
+                        "addressId": "teste",
+                        "isDisposable": true,
+                        "postalCode": "12345000",
+                        "city": "Rio de Janeiro",
+                        "state": "RJ",
+                        "country": "BRA",
+                        "street": "Rua da minha casa",
+                        "number": "123",
+                        "neighborhood": "Copacabana",
+                        "complement": "15º andar",
+                        "reference": null,
+                        "geoCoordinates": [
+                          -47.924747467041016,
+                          -15.832582473754883
+                        ]
+                      }
+                    ],
+                    "availableAddresses": [
+                      {
+                        "addressType": "residential",
+                        "receiverName": "Clark Kent",
+                        "addressId": "teste",
+                        "isDisposable": true,
+                        "postalCode": "12345000",
+                        "city": "Rio de Janeiro",
+                        "state": "RJ",
+                        "country": "BRA",
+                        "street": "Rua da minha casa",
+                        "number": "123",
+                        "neighborhood": "Copacabana",
+                        "complement": "15º andar",
+                        "reference": null,
+                        "geoCoordinates": [
+                          -47.924747467041016,
+                          -15.832582473754883
+                        ]
+                      }
+                    ],
+                    "pickupPoints": []
+                  },
+                  "clientProfileData": {
+                    "email": "clark.kent@example.com",
+                    "firstName": "Clark",
+                    "lastName": "Kent",
+                    "document": "12345678900",
+                    "documentType": "cpf",
+                    "phone": "+5521998765432",
+                    "corporateName": "company-name",
+                    "tradeName": "trade-name",
+                    "corporateDocument": "12345678000100",
+                    "stateInscription": "12345678",
+                    "corporatePhone": "551100988887777",
+                    "isCorporate": false,
+                    "profileCompleteOnLoading": false,
+                    "profileErrorOnLoading": false,
+                    "customerClass": null
+                  },
+                  "paymentData": {
+                    "giftCards": [],
+                    "transactions": [
+                      {
+                        "isActive": true,
+                        "transactionId": "296D6D245C17437E823EB77E403FC88D",
+                        "merchantName": "MYSTORE",
+                        "payments": [
+                          {
+                            "paymentSystem": 6,
+                            "bin": null,
+                            "accountId": "12",
+                            "tokenId": null,
+                            "value": 34390,
+                            "referenceValue": 34390,
+                            "giftCardRedemptionCode": null,
+                            "giftCardProvider": null,
+                            "giftCardId": null
+                          }
+                        ],
+                        "sharedTransaction": false
+                      }
+                    ]
+                  },
+                  "marketingData": {
+                    "utmSource": null,
+                    "utmMedium": null,
+                    "utmCampaign": null,
+                    "utmipage": null,
+                    "utmiPart": null,
+                    "utmiCampaign": null,
+                    "coupon": "freeshipping",
+                    "marketingTags": []
+                  },
+                  "sellers": [
+                    {
+                      "id": "1",
+                      "name": "lojadobreno",
+                      "logo": "Logo"
+                    }
+                  ],
+                  "clientPreferencesData": {
+                    "locale": "pt-BR",
+                    "optinNewsLetter": false
+                  },
+                  "commercialConditionData": null,
+                  "storePreferencesData": {},
+                  "giftRegistryData": null,
+                  "openTextField": null,
+                  "invoiceData": null,
+                  "customData": null,
+                  "itemMetadata": {
+                    "items": [
+                      {
+                        "id": "2",
+                        "seller": "1",
+                        "name": "Chopp Brahma Claro 30L",
+                        "skuName": "Chopp Brahma Claro 30L",
+                        "productId": "2",
+                        "refId": "CBC30L",
+                        "ean": null,
+                        "imageUrl": "http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000",
+                        "detailUrl": "/chopp-brahma-claro-30l/p",
+                        "assemblyOptions": []
+                      }
+                    ]
+                  },
+                  "hooksData": null,
+                  "ratesAndBenefitsData": {
+                    "rateAndBenefitsIdentifiers": [],
+                    "teaser": []
+                  },
+                  "subscriptionData": null,
+                  "itemsOrdination": {
+                    "criteria": "NAME",
+                    "ascending": true
+                  }
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/api/checkout/pub/pickup-points": {
+      "get": {
+        "tags": [
+          "Fulfillment"
+        ],
+        "summary": "List pickup points by location",
+        "description": "Retrieves information on pickup points close to a given location determined by geocoordinates or postal code.\n\r\n\rThe pickup points returned are not necessarily all active ones. Make sure to validate the information consumed by integrations.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).",
+        "operationId": "ListPickupPpointsByLocation",
+        "security": [],
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "geoCoordinates",
+            "in": "query",
+            "description": "Geocoordinates (first longitude, then latitude) around which to search for pickup points. If you use this type of search, do not pass postal and country codes.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "string",
+              "example": "-47.924747467041016; -15.832582473754883",
+              "description": "Geocoordinate."
+            }
+          },
+          {
+            "name": "postalCode",
+            "in": "query",
+            "description": "Postal code around which to search for pickup points. If you use this type of search, make sure to pass a `countryCode` and do not pass `geoCoordinates`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "string",
+              "example": "1234000"
+            }
+          },
+          {
+            "name": "countryCode",
+            "in": "query",
+            "description": "Three letter country code refering to the `postalCode` field. Pass the country code only if you are searching pickup points by postal code.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "string",
+              "example": "BRA"
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "example": {
+                  "paging": {
+                    "page": 1,
+                    "pageSize": 30,
+                    "total": 1,
+                    "pages": 1
+                  },
+                  "items": [
+                    {
+                      "distance": 0.8469786518616546,
+                      "pickupPoint": {
+                        "friendlyName": "physical-store-02",
+                        "address": {
+                          "addressType": "pickup",
+                          "receiverName": null,
+                          "addressId": "physical-store-02",
+                          "isDisposable": true,
+                          "postalCode": "23450-070",
+                          "city": "Rio de Janeiro",
+                          "state": "RJ",
+                          "country": "BRA",
+                          "street": "Praia de Botafogo",
+                          "number": "132",
+                          "neighborhood": "Botafogo",
+                          "complement": "Apto 101",
+                          "reference": null,
+                          "geoCoordinates": [
+                            -47.924747467041016,
+                            -15.832582473754883
+                          ]
+                        },
+                        "additionalInfo": null,
+                        "id": "02_Physical",
+                        "businessHours": [
+                          {
+                            "DayOfWeek": 0,
+                            "OpeningTime": "00:00:00",
+                            "ClosingTime": "23:59:00"
+                          },
+                          {
+                            "DayOfWeek": 1,
+                            "OpeningTime": "00:00:00",
+                            "ClosingTime": "23:59:00"
+                          },
+                          {
+                            "DayOfWeek": 2,
+                            "OpeningTime": "00:00:00",
+                            "ClosingTime": "23:59:00"
+                          },
+                          {
+                            "DayOfWeek": 3,
+                            "OpeningTime": "00:00:00",
+                            "ClosingTime": "23:59:00"
+                          },
+                          {
+                            "DayOfWeek": 4,
+                            "OpeningTime": "00:00:00",
+                            "ClosingTime": "23:50:00"
+                          },
+                          {
+                            "DayOfWeek": 5,
+                            "OpeningTime": "00:00:00",
+                            "ClosingTime": "23:59:00"
+                          },
+                          {
+                            "DayOfWeek": 6,
+                            "OpeningTime": "00:00:00",
+                            "ClosingTime": "23:59:00"
+                          }
+                        ]
+                      }
+                    }
+                  ]
+                },
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "paging": {
+                      "description": "Paging.",
+                      "type": "object",
+                      "properties": {
+                        "page": {
+                          "description": "Page number.",
+                          "type": "integer"
+                        },
+                        "pageSize": {
+                          "description": "Page size.",
+                          "type": "integer"
+                        },
+                        "total": {
+                          "description": "Total pages.",
+                          "type": "integer"
+                        },
+                        "pages": {
+                          "description": "Pages.",
+                          "type": "integer"
+                        }
+                      }
+                    },
+                    "items": {
+                      "description": "Items.",
+                      "type": "array",
+                      "items": {
+                        "description": "Item information.",
+                        "type": "object",
+                        "properties": {
+                          "distance": {
+                            "description": "Distance.",
+                            "type": "number"
+                          },
+                          "pickupPoint": {
+                            "description": "Pickup point.",
+                            "type": "object",
+                            "properties": {
+                              "friendlyName": {
+                                "description": "Friendly name.",
+                                "type": "string"
+                              },
+                              "address": {
+                                "description": "Address.",
+                                "type": "object",
+                                "properties": {
+                                  "addressType": {
+                                    "description": "Address type.",
+                                    "type": "string"
+                                  },
+                                  "receiverName": {
+                                    "description": "Receiver name.",
+                                    "type": "string"
+                                  },
+                                  "addressId": {
+                                    "description": "Address ID.",
+                                    "type": "string",
+                                    "nullable": true
+                                  },
+                                  "isDisposable": {
+                                    "description": "Is disposable.",
+                                    "type": "boolean"
+                                  },
+                                  "postalCode": {
+                                    "description": "Postal code.",
+                                    "type": "string"
+                                  },
+                                  "city": {
+                                    "description": "City.",
+                                    "type": "string"
+                                  },
+                                  "state": {
+                                    "description": "State.",
+                                    "type": "string"
+                                  },
+                                  "country": {
+                                    "description": "Country.",
+                                    "type": "string"
+                                  },
+                                  "street": {
+                                    "description": "Street.",
+                                    "type": "string"
+                                  },
+                                  "number": {
+                                    "description": "Number.",
+                                    "type": "string"
+                                  },
+                                  "neighborhood": {
+                                    "description": "Neighborhood.",
+                                    "type": "string"
+                                  },
+                                  "complement": {
+                                    "description": "Complement to the shipping address, in case it applies.",
+                                    "type": "string",
+                                    "nullable": true
+                                  },
+                                  "reference": {
+                                    "description": "Racao.",
+                                    "type": "string"
+                                  },
+                                  "geoCoordinates": {
+                                    "description": "Geo coordinates.",
+                                    "type": "array",
+                                    "items": {
+                                      "description": "Geo coordinate.",
+                                      "type": "integer"
+                                    }
+                                  }
+                                }
+                              },
+                              "additionalInfo": {
+                                "description": "Additional info.",
+                                "type": "string"
+                              },
+                              "id": {
+                                "description": "ID.",
+                                "type": "string"
+                              },
+                              "businessHours": {
+                                "description": "Array with business hours.",
+                                "type": "array",
+                                "items": {
+                                  "description": "Business hours.",
+                                  "type": "object",
+                                  "properties": {
+                                    "DayOfWeek": {
+                                      "description": "Day of week.",
+                                      "type": "integer"
+                                    },
+                                    "OpeningTime": {
+                                      "description": "Opening time.",
+                                      "type": "string"
+                                    },
+                                    "ClosingTime": {
+                                      "description": "Closing time.",
+                                      "type": "string"
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/checkout/pub/postal-code/{countryCode}/{postalCode}": {
+      "get": {
+        "tags": [
+          "Fulfillment"
+        ],
+        "summary": "Get address by postal code",
+        "description": "Retrieves address information for a given postal code and country.\r\n\r\nThis request can be used to implement auto complete functionality when a customer needs to fill in an address.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).",
+        "operationId": "GetAddressByPostalCode",
+        "security": [],
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "countryCode",
+            "in": "path",
+            "description": "Three letter country code refering to the `postalCode` field.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "BRA"
+            }
+          },
+          {
+            "name": "postalCode",
+            "in": "path",
+            "description": "Postal code.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "1234000"
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "example": {
+                  "postalCode": "12345000",
+                  "city": "Rio de Janeiro",
+                  "state": "RJ",
+                  "country": "BRA",
+                  "street": "My street",
+                  "number": "34",
+                  "neighborhood": "My neighborhood",
+                  "complement": "Apto 101",
+                  "reference": "Reference",
+                  "geoCoordinates": []
+                },
+                "schema": {
+                  "description": "Address.",
+                  "type": "object",
+                  "properties": {
+                    "postalCode": {
+                      "description": "Postal code.",
+                      "type": "string"
+                    },
+                    "city": {
+                      "description": "City.",
+                      "type": "string"
+                    },
+                    "state": {
+                      "description": "State.",
+                      "type": "string"
+                    },
+                    "country": {
+                      "description": "Country.",
+                      "type": "string"
+                    },
+                    "street": {
+                      "description": "Street.",
+                      "type": "string"
+                    },
+                    "number": {
+                      "description": "Number.",
+                      "type": "string"
+                    },
+                    "neighborhood": {
+                      "description": "Neighborhood.",
+                      "type": "string"
+                    },
+                    "complement": {
+                      "description": "Complement to the shipping address, in case it applies.",
+                      "type": "string",
+                      "nullable": true
+                    },
+                    "reference": {
+                      "description": "Reference.",
+                      "type": "string"
+                    },
+                    "geoCoordinates": {
+                      "description": "Geo coordinates.",
+                      "type": "array",
+                      "items": {
+                        "description": "Geo coordinate.",
+                        "type": "integer"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/api/checkout/pub/orderForm/{orderFormId}/transaction": {
+      "post": {
+        "tags": [
+          "Order placement"
+        ],
+        "summary": "Place order from an existing cart",
+        "description": "This endpoint places an order from an existing `orderForm` object, meaning an existing cart.\n\r\n\rAfter the creation of an order with this request, you have five minutes to send payment information and then request payment processing.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "PlaceOrderFromExistingOrderForm",
+        "security": [],
+        "parameters": [
+          {
+            "name": "orderFormId",
+            "in": "path",
+            "description": "ID of the `orderForm` corresponding to the cart from which to place the order.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "ede846222cd44046ba6c638442c3505a"
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "required": [
+                  "referenceId",
+                  "value",
+                  "referenceValue",
+                  "interestValue"
+                ],
+                "properties": {
+                  "referenceId": {
+                    "title": "referenceId",
+                    "type": "string",
+                    "description": "ID of the `orderForm` corresponding to the cart from which to place the order. This is the same as the `orderFormId` parameter.",
+                    "example": "41a22925298a4ddca95318131a25b000"
+                  },
+                  "savePersonalData": {
+                    "title": "savePersonalData",
+                    "type": "boolean",
+                    "description": "`true` if the shopper's data provided during checkout should be saved for future reference.",
+                    "example": false
+                  },
+                  "optinNewsLetter": {
+                    "title": "optinNewsLetter",
+                    "type": "boolean",
+                    "description": "True if the shopper opted to receive the newsletter.",
+                    "example": false,
+                    "nullable": true
+                  },
+                  "value": {
+                    "type": "integer",
+                    "description": "Total value of the order without separating cents. For example, $24.99 is represented `2499`.",
+                    "example": 6800
+                  },
+                  "referenceValue": {
+                    "type": "integer",
+                    "description": "Reference value of the order for calculating interest if that is the case. Can be equal to the total value and does not separate cents. For example, $24.99 is represented `2499`.",
+                    "example": 6800
+                  },
+                  "interestValue": {
+                    "type": "integer",
+                    "description": "Interest rate to be used in case it applies.",
+                    "example": 0
+                  }
+                }
+              },
+              "example": {
+                "referenceId": "41a22925298a4ddca95318131a25b000",
+                "savePersonalData": false,
+                "optinNewsLetter": false,
+                "value": 6800,
+                "referenceValue": 6800,
+                "interestValue": 0
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "orderFormId": {
+                      "type": "string",
+                      "description": "ID of the orderForm corresponding to a specific cart."
+                    },
+                    "salesChannel": {
+                      "type": "string",
+                      "description": "Attribute created by the seller, in their VTEX store configuration."
+                    },
+                    "loggedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether the user is logged into the store."
+                    },
+                    "isCheckedIn": {
+                      "type": "boolean",
+                      "description": "Indicates whether order is checked in."
+                    },
+                    "storeId": {
+                      "type": "string",
+                      "description": "ID of the store.",
+                      "nullable": true
+                    },
+                    "allowManualPrice": {
+                      "type": "boolean",
+                      "description": "Permission to modify item price manually."
+                    },
+                    "canEditData": {
+                      "type": "boolean",
+                      "description": "Data can be edited."
+                    },
+                    "userProfileId": {
+                      "type": "string",
+                      "description": "Unique ID associated with the customer profile."
+                    },
+                    "profileProvider": {
+                      "type": "string",
+                      "description": "Profile provider."
+                    },
+                    "availableAccounts": {
+                      "type": "array",
+                      "description": "Available accounts.",
+                      "items": {
+                        "type": "string",
+                        "description": "Account."
+                      }
+                    },
+                    "availableAddresses": {
+                      "type": "array",
+                      "description": "Information on each available address.",
+                      "items": {
+                        "description": "Address information.",
+                        "type": "object",
+                        "properties": {
+                          "addressType": {
+                            "type": "string",
+                            "description": "Address type."
+                          },
+                          "receiverName": {
+                            "type": "string",
+                            "description": "Name of the receiver."
+                          },
+                          "addressId": {
+                            "type": "string",
+                            "description": "Address ID.",
+                            "nullable": true
+                          },
+                          "isDisposable": {
+                            "type": "boolean",
+                            "description": "Indicates whether address is disposable."
+                          },
+                          "city": {
+                            "type": "string",
+                            "description": "City of the address."
+                          },
+                          "state": {
+                            "type": "string",
+                            "description": "State of the address."
+                          },
+                          "country": {
+                            "type": "string",
+                            "description": "Country of the address. ISO three-letter code."
+                          },
+                          "street": {
+                            "type": "string",
+                            "description": "Street of the address."
+                          },
+                          "number": {
+                            "type": "string",
+                            "description": "Number of the address."
+                          },
+                          "neighborhood": {
+                            "type": "string",
+                            "description": "Neighborhood of the address."
+                          },
+                          "complement": {
+                            "description": "Complement to the shipping address, in case it applies.",
+                            "type": "string",
+                            "nullable": true
+                          },
+                          "reference": {
+                            "type": "string",
+                            "description": "Reference that may help in the location of the address.",
+                            "nullable": true
+                          },
+                          "geoCoordinates": {
+                            "type": "array",
+                            "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                            "items": {
+                              "type": "number",
+                              "description": "Geocoordinates."
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "userType": {
+                      "type": "string",
+                      "description": "User type.",
+                      "nullable": true
+                    },
+                    "ignoreProfileData": {
+                      "type": "boolean",
+                      "description": "Ignore customer profile data."
+                    },
+                    "value": {
+                      "type": "integer",
+                      "description": "Total value of the order without separating cents. For example, $24.99 is represented as `2499`."
+                    },
+                    "messages": {
+                      "type": "array",
+                      "description": "Array containing an object for each message generated by our servers while processing the request.",
+                      "items": {
+                        "type": "string",
+                        "description": "Message."
+                      }
+                    },
+                    "items": {
+                      "type": "array",
+                      "description": "Information on each item in the order.",
+                      "items": {
+                        "description": "Item information.",
+                        "type": "object",
+                        "properties": {
+                          "uniqueId": {
+                            "type": "string",
+                            "description": "Unique ID."
+                          },
+                          "id": {
+                            "type": "string",
+                            "description": "ID of the item."
+                          },
+                          "productId": {
+                            "type": "string",
+                            "description": "Product ID."
+                          },
+                          "productRefId": {
+                            "type": "string",
+                            "description": "Product Ref ID."
+                          },
+                          "refId": {
+                            "type": "string",
+                            "description": "Ref ID."
+                          },
+                          "ean": {
+                            "type": "string",
+                            "description": "European Article Number.",
+                            "nullable": true
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Product name."
+                          },
+                          "skuName": {
+                            "type": "string",
+                            "description": "SKU name."
+                          },
+                          "modalType": {
+                            "type": "string",
+                            "description": "Modal type.",
+                            "nullable": true
+                          },
+                          "parentItemIndex": {
+                            "type": "integer",
+                            "description": "Parent item index.",
+                            "nullable": true
+                          },
+                          "parentAssemblyBinding": {
+                            "type": "string",
+                            "description": "Parent assembly binding.",
+                            "nullable": true
+                          },
+                          "priceValidUntil": {
+                            "type": "string",
+                            "description": "Price expiration date and time."
+                          },
+                          "tax": {
+                            "type": "integer",
+                            "description": "Tax value in cents."
+                          },
+                          "taxCode": {
+                            "type": "string",
+                            "description": "A unique identifier code assigned to a tax within the VTEX Admin."
+                          },
+                          "price": {
+                            "type": "integer",
+                            "description": "Price in cents."
+                          },
+                          "listPrice": {
+                            "type": "integer",
+                            "description": "List price in cents."
+                          },
+                          "manualPrice": {
+                            "type": "integer",
+                            "description": "Manual price in cents.",
+                            "nullable": true
+                          },
+                          "manualPriceAppliedBy": {
+                            "type": "string",
+                            "description": "User that applied the manual price, if that is the case.",
+                            "nullable": true
+                          },
+                          "sellingPrice": {
+                            "type": "integer",
+                            "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
+                          },
+                          "rewardValue": {
+                            "type": "integer",
+                            "description": "Reward value in cents."
+                          },
+                          "isGift": {
+                            "type": "boolean",
+                            "description": "Indicates whether item is a gift."
+                          },
+                          "additionalInfo": {
+                            "type": "object",
+                            "description": "Additional information.",
+                            "properties": {
+                              "dimension": {
+                                "type": "string",
+                                "description": "Dimension.",
+                                "nullable": true
+                              },
+                              "brandName": {
+                                "type": "string",
+                                "description": "Brand name."
+                              },
+                              "brandId": {
+                                "type": "string",
+                                "description": "Brand ID."
+                              },
+                              "offeringInfo": {
+                                "type": "string",
+                                "description": "Offering information.",
+                                "nullable": true
+                              },
+                              "offeringType": {
+                                "type": "string",
+                                "description": "Offering type.",
+                                "nullable": true
+                              },
+                              "offeringTypeId": {
+                                "type": "string",
+                                "description": "Offering type ID.",
+                                "nullable": true
+                              }
+                            }
+                          },
+                          "preSaleDate": {
+                            "type": "string",
+                            "description": "Presale date.",
+                            "nullable": true
+                          },
+                          "productCategoryIds": {
+                            "type": "string",
+                            "description": "Product category IDs."
+                          },
+                          "productCategories": {
+                            "type": "object",
+                            "description": "Object, where each field is an ID from `productCategoryIds`.",
+                            "properties": {
+                              "{ID}": {
+                                "type": "string",
+                                "description": "Product category corresponding to the ID in the field key."
+                              }
+                            }
+                          },
+                          "quantity": {
+                            "type": "integer",
+                            "description": "Quantity."
+                          },
+                          "seller": {
+                            "type": "string",
+                            "description": "Seller."
+                          },
+                          "sellerChain": {
+                            "type": "array",
+                            "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
+                            "items": {
+                              "type": "string",
+                              "description": "Seller."
+                            }
+                          },
+                          "imageUrl": {
+                            "type": "string",
+                            "description": "Image URL."
+                          },
+                          "detailUrl": {
+                            "type": "string",
+                            "description": "Detail URL."
+                          },
+                          "bundleItems": {
+                            "type": "array",
+                            "description": "Information on services sold along with the SKU. Example: a gift package.",
+                            "items": {
+                              "description": "Service information.",
+                              "type": "object",
+                              "properties": {
+                                "type": {
+                                  "type": "string",
+                                  "description": "Service type."
+                                },
+                                "id": {
+                                  "type": "integer",
+                                  "description": "Service identifier."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Service name."
+                                },
+                                "price": {
+                                  "type": "integer",
+                                  "description": "Service price in cents."
+                                }
+                              }
+                            }
+                          },
+                          "attachments": {
+                            "type": "array",
+                            "description": "Array containing information on attachments.",
+                            "items": {
+                              "type": "string",
+                              "description": "Attachment."
+                            }
+                          },
+                          "priceTags": {
+                            "type": "array",
+                            "description": "Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.",
+                            "items": {
+                              "description": "Price tag information.",
+                              "type": "object",
+                              "properties": {
+                                "identifier": {
+                                  "type": "string",
+                                  "description": "Promotion unique identifier.",
+                                  "nullable": true
+                                },
+                                "isPercentual": {
+                                  "type": "boolean",
+                                  "description": "Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\r\n- `type` indicates whether the tag refers to a discount or tax.\r\n- `where` specifies the context, either price or shipping.\r\n- `identifier` is the promotion ID.\r\n- `calculationId` is a hash that may vary with each price calculation."
+                                },
+                                "rawValue": {
+                                  "type": "number",
+                                  "description": "Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations."
+                                },
+                                "value": {
+                                  "type": "integer",
+                                  "description": "Price tag value representing either a promotion (value decrease) or a tax (value increase)."
+                                }
+                              }
+                            }
+                          },
+                          "availability": {
+                            "type": "string",
+                            "description": "Availability."
+                          },
+                          "measurementUnit": {
+                            "type": "string",
+                            "description": "Measurement unit."
+                          },
+                          "unitMultiplier": {
+                            "type": "integer",
+                            "description": "Unit multiplier."
+                          },
+                          "manufacturerCode": {
+                            "type": "string",
+                            "description": "Manufacturer code.",
+                            "nullable": true
+                          },
+                          "priceDefinition": {
+                            "type": "object",
+                            "description": "Price information for all units of a specific item.",
+                            "properties": {
+                              "calculatedSellingPrice": {
+                                "type": "integer",
+                                "description": "Item's calculated unitary selling price in cents."
+                              },
+                              "total": {
+                                "type": "integer",
+                                "description": "Total value for all units of the item in cents."
+                              },
+                              "sellingPrices": {
+                                "type": "array",
+                                "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
+                                "items": {
+                                  "description": "Rounding information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value in cents for that specific rounding."
+                                    },
+                                    "quantity": {
+                                      "type": "integer",
+                                      "description": "Rounding quantity, meaning how many items are rounded to this value."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "selectableGifts": {
+                      "type": "array",
+                      "description": "Array containing the data of the item selected as a gift.",
+                      "items": {
+                        "type": "string",
+                        "description": "Gift."
+                      }
+                    },
+                    "totalizers": {
+                      "type": "array",
+                      "description": "Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).",
+                      "items": {
+                        "type": "object",
+                        "description": "Totalizer of purchases."
+                      }
+                    },
+                    "shippingData": {
+                      "type": "object",
+                      "description": "Shipping information pertinent to the order.",
+                      "nullable": true,
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Address information.",
+                          "nullable": true,
+                          "properties": {
+                            "addressType": {
+                              "type": "string",
+                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                            },
+                            "receiverName": {
+                              "type": "string",
+                              "description": "Name of the person who is going to receive the order."
+                            },
+                            "addressId": {
+                              "type": "string",
+                              "description": "Address ID.",
+                              "nullable": true
+                            },
+                            "isDisposable": {
+                              "type": "boolean",
+                              "description": "Indicates whether address is disposable."
+                            },
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City of the shipping address."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State of the shipping address."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Three letter ISO code of the country of the shipping address."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street of the shipping address."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Number of the building, house or apartment in the shipping address."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood of the shipping address."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Complement to the shipping address, in case it applies.",
+                              "nullable": true
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                              "nullable": true
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                              "items": {
+                                "type": "number",
+                                "description": "Geocoordinates."
+                              }
+                            }
+                          }
+                        },
+                        "logisticsInfo": {
+                          "type": "array",
+                          "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.",
+                          "items": {
+                            "description": "Logistics information.",
+                            "type": "object",
+                            "properties": {
+                              "itemIndex": {
+                                "type": "integer",
+                                "description": "Index corresponding to the position of the object in the `items` array."
+                              },
+                              "selectedSla": {
+                                "type": "string",
+                                "description": "SLA selected by the customer.",
+                                "nullable": true
+                              },
+                              "selectedDeliveryChannel": {
+                                "type": "string",
+                                "description": "Delivery channel selected by the customer.",
+                                "nullable": true
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "slas": {
+                                "type": "array",
+                                "description": "Information on available SLAs.",
+                                "items": {
+                                  "description": "SLA information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "SLA ID."
+                                    },
+                                    "deliveryChannel": {
+                                      "type": "string",
+                                      "description": "Delivery channel."
+                                    },
+                                    "name": {
+                                      "type": "string",
+                                      "description": "SLA name."
+                                    },
+                                    "deliveryIds": {
+                                      "type": "array",
+                                      "description": "Information on each delivery ID.",
+                                      "items": {
+                                        "description": "Delivery ID information.",
+                                        "type": "object",
+                                        "properties": {
+                                          "courierId": {
+                                            "type": "string",
+                                            "description": "Courier ID."
+                                          },
+                                          "warehouseId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "dockId": {
+                                            "type": "string",
+                                            "description": "Warehouse ID."
+                                          },
+                                          "courierName": {
+                                            "type": "string",
+                                            "description": "Courier name."
+                                          },
+                                          "quantity": {
+                                            "type": "integer",
+                                            "description": "Quantity."
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "attachmentOfferings": {
+                                      "type": "array",
+                                      "description": "List of attachments details.",
+                                      "nullable": true,
+                                      "items": {
+                                        "description": "Attachment details.",
+                                        "type": "object",
+                                        "required": [
+                                          "name",
+                                          "required",
+                                          "schema"
+                                        ],
+                                        "properties": {
+                                          "name": {
+                                            "type": "string",
+                                            "description": "Name of the attachment.",
+                                            "nullable": true
+                                          },
+                                          "required": {
+                                            "type": "boolean",
+                                            "description": "Defines if the attachment is required (`true`) or not (`false`).",
+                                            "nullable": true
+                                          },
+                                          "schema": {
+                                            "type": "object",
+                                            "description": "Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).",
+                                            "nullable": true
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "shippingEstimate": {
+                                      "type": "string",
+                                      "description": "Shipping estimate. For instance, \"three business days\" will be represented as `3bd`."
+                                    },
+                                    "shippingEstimateDate": {
+                                      "type": "string",
+                                      "description": "When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.",
+                                      "nullable": true
+                                    },
+                                    "useIndividualShippingEstimates": {
+                                      "type": "boolean",
+                                      "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`."
+                                    },
+                                    "lockTTL": {
+                                      "type": "string",
+                                      "description": "Estimate date of delivery.",
+                                      "nullable": true
+                                    },
+                                    "price": {
+                                      "type": "integer",
+                                      "description": "Price in cents."
+                                    },
+                                    "listPrice": {
+                                      "type": "integer",
+                                      "description": "List price in cents."
+                                    },
+                                    "tax": {
+                                      "type": "integer",
+                                      "description": "Tax in cents."
+                                    },
+                                    "pickupStoreInfo": {
+                                      "type": "object",
+                                      "description": "Information on the pickup store.",
+                                      "properties": {
+                                        "isPickupStore": {
+                                          "type": "boolean",
+                                          "description": "Indicates whether it is the pickup store."
+                                        },
+                                        "friendlyName": {
+                                          "type": "string",
+                                          "description": "Friendly name.",
+                                          "nullable": true
+                                        },
+                                        "address": {
+                                          "type": "object",
+                                          "description": "Address information.",
+                                          "nullable": true,
+                                          "properties": {
+                                            "addressType": {
+                                              "type": "string",
+                                              "description": "Type of address. For example, `Residential` or `Pickup`."
+                                            },
+                                            "postalCode": {
+                                              "type": "string",
+                                              "description": "Postal code."
+                                            },
+                                            "city": {
+                                              "type": "string",
+                                              "description": "City of the shipping address."
+                                            },
+                                            "state": {
+                                              "type": "string",
+                                              "description": "State of the shipping address."
+                                            },
+                                            "country": {
+                                              "type": "string",
+                                              "description": "Three letter ISO code of the country of the shipping address."
+                                            },
+                                            "street": {
+                                              "type": "string",
+                                              "description": "Street of the shipping address."
+                                            },
+                                            "number": {
+                                              "type": "string",
+                                              "description": "Number of the building, house or apartment in the shipping address."
+                                            },
+                                            "neighborhood": {
+                                              "type": "string",
+                                              "description": "Neighborhood of the shipping address."
+                                            },
+                                            "complement": {
+                                              "type": "string",
+                                              "description": "Complement to the shipping address, in case it applies.",
+                                              "nullable": true
+                                            },
+                                            "reference": {
+                                              "type": "string",
+                                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                              "nullable": true
+                                            },
+                                            "geoCoordinates": {
+                                              "type": "array",
+                                              "description": "Array with two strings that repesent geocoordinates: first latitude, then longitude.",
+                                              "items": {
+                                                "type": "number",
+                                                "description": "Geocoordinates."
+                                              }
+                                            }
+                                          }
+                                        },
+                                        "additionalInfo": {
+                                          "type": "string",
+                                          "description": "Additional information.",
+                                          "nullable": true
+                                        },
+                                        "dockId": {
+                                          "type": "string",
+                                          "description": "Corresponding dock ID.",
+                                          "nullable": true
+                                        }
+                                      }
+                                    },
+                                    "pickupPointId": {
+                                      "type": "string",
+                                      "description": "Pickup point ID.",
+                                      "nullable": true
+                                    },
+                                    "pickupDistance": {
+                                      "type": "integer",
+                                      "description": "Pickup point distance."
+                                    },
+                                    "polygonName": {
+                                      "type": "string",
+                                      "description": "Polygon name.",
+                                      "nullable": true
+                                    },
+                                    "transitTime": {
+                                      "type": "string",
+                                      "description": "Transit time. For instance, \"three business days\" is represented as `3bd`."
+                                    }
+                                  }
+                                }
+                              },
+                              "shipsTo": {
+                                "type": "array",
+                                "description": "List of countries that the item may be shipped to.",
+                                "items": {
+                                  "type": "string",
+                                  "description": "Three letter country code."
+                                }
+                              },
+                              "itemId": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "deliveryChannels": {
+                                "type": "array",
+                                "description": "List of available delivery channels.",
+                                "items": {
+                                  "description": "Delivery channel information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "Delivery channel ID."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "selectedAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the selected addresses for the order.",
+                          "items": {
+                            "description": "Selected address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "availableAddresses": {
+                          "type": "array",
+                          "description": "Array with information on the available addresses for the order.",
+                          "items": {
+                            "description": "Available address information.",
+                            "type": "object",
+                            "properties": {
+                              "addressType": {
+                                "type": "string",
+                                "description": "Type of address. For example, `Residential` or `Pickup`."
+                              },
+                              "receiverName": {
+                                "type": "string",
+                                "description": "Name of the person who is going to receive the order."
+                              },
+                              "addressId": {
+                                "type": "string",
+                                "description": "Address ID.",
+                                "nullable": true
+                              },
+                              "isDisposable": {
+                                "type": "boolean",
+                                "description": "Indicates whether address is disposable."
+                              },
+                              "postalCode": {
+                                "type": "string",
+                                "description": "Postal code."
+                              },
+                              "city": {
+                                "type": "string",
+                                "description": "City of the shipping address."
+                              },
+                              "state": {
+                                "type": "string",
+                                "description": "State of the shipping address."
+                              },
+                              "country": {
+                                "type": "string",
+                                "description": "Three letter ISO code of the country of the shipping address."
+                              },
+                              "street": {
+                                "type": "string",
+                                "description": "Street of the shipping address."
+                              },
+                              "number": {
+                                "type": "string",
+                                "description": "Number of the building, house or apartment in the shipping address."
+                              },
+                              "neighborhood": {
+                                "type": "string",
+                                "description": "Neighborhood of the shipping address."
+                              },
+                              "complement": {
+                                "type": "string",
+                                "description": "Complement to the shipping address, in case it applies.",
+                                "nullable": true
+                              },
+                              "reference": {
+                                "type": "string",
+                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                "nullable": true
+                              },
+                              "geoCoordinates": {
+                                "type": "array",
+                                "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                                "items": {
+                                  "type": "number",
+                                  "description": "Geocoordinates."
+                                }
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "clientProfileData": {
+                      "type": "object",
+                      "description": "Customer's profile information.",
+                      "nullable": true,
+                      "properties": {
+                        "email": {
+                          "type": "string",
+                          "description": "Email address.",
+                          "nullable": true
+                        },
+                        "firstName": {
+                          "type": "string",
+                          "description": "First name.",
+                          "nullable": true
+                        },
+                        "lastName": {
+                          "type": "string",
+                          "description": "Last name."
+                        },
+                        "documentType": {
+                          "type": "string",
+                          "description": "Type of the document informed by the customer."
+                        },
+                        "document": {
+                          "type": "string",
+                          "description": "Document informed by the customer."
+                        },
+                        "phone": {
+                          "type": "string",
+                          "description": "Phone number."
+                        },
+                        "corporateName": {
+                          "type": "string",
+                          "description": "Company name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "tradeName": {
+                          "type": "string",
+                          "description": "Trade name, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporateDocument": {
+                          "type": "string",
+                          "description": "Corporate document, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "stateInscription": {
+                          "type": "string",
+                          "description": "State inscription, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "corporatePhone": {
+                          "type": "string",
+                          "description": "Corporate phone number, if the customer is a legal entity.",
+                          "nullable": true
+                        },
+                        "isCorporate": {
+                          "type": "boolean",
+                          "description": "Indicates whether the customer is a legal entity."
+                        },
+                        "profileCompleteOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile is complete on loading."
+                        },
+                        "profileErrorOnLoading": {
+                          "type": "boolean",
+                          "description": "Indicates whether profile presents error on loading.",
+                          "nullable": true
+                        },
+                        "customerClass": {
+                          "type": "string",
+                          "description": "Customer class.",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "paymentData": {
+                      "type": "object",
+                      "description": "Information on the order's payment.",
+                      "properties": {
+                        "giftCards": {
+                          "type": "array",
+                          "description": "Gift card information, if it applies to the order.",
+                          "items": {
+                            "description": "Gift card information.",
+                            "type": "object",
+                            "properties": {
+                              "redemptionCode": {
+                                "type": "string",
+                                "description": "Gift card redemption code."
+                              },
+                              "value": {
+                                "type": "integer",
+                                "description": "Gift card value in cents."
+                              },
+                              "balance": {
+                                "type": "integer",
+                                "description": "Gift card balance in cents."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Gift card name."
+                              },
+                              "id": {
+                                "type": "string",
+                                "description": "Gift card ID."
+                              },
+                              "inUse": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is in use."
+                              },
+                              "isSpecialCard": {
+                                "type": "boolean",
+                                "description": "Indicates whether gift card is special."
+                              }
+                            }
+                          }
+                        },
+                        "transactions": {
+                          "type": "array",
+                          "description": "Information on each transaction pertinent to the order.",
+                          "items": {
+                            "description": "Transaction information.",
+                            "nullable": true,
+                            "type": "object",
+                            "properties": {
+                              "isActive": {
+                                "type": "boolean",
+                                "description": "Indicates whether transaction is active."
+                              },
+                              "transactionId": {
+                                "type": "string",
+                                "description": "Transaction ID."
+                              },
+                              "merchantName": {
+                                "type": "string",
+                                "description": "Merchant name."
+                              },
+                              "payments": {
+                                "type": "array",
+                                "description": "Information on each payment.",
+                                "items": {
+                                  "description": "Payment information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "accountId": {
+                                      "type": "string",
+                                      "description": "Account ID."
+                                    },
+                                    "bin": {
+                                      "type": "string",
+                                      "description": "Bin.",
+                                      "nullable": true
+                                    },
+                                    "installments": {
+                                      "type": "integer",
+                                      "description": "Number of installments."
+                                    },
+                                    "paymentSystem": {
+                                      "type": "string",
+                                      "description": "Payment system."
+                                    },
+                                    "referenceValue": {
+                                      "type": "integer",
+                                      "description": "Reference value for calculating interest rates, in case it applies. Displayed in cents."
+                                    },
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Value including interest, in case it applies. Displayed in cents."
+                                    }
+                                  }
+                                }
+                              },
+                              "sharedTransaction": {
+                                "type": "boolean",
+                                "description": "Indicates whather transaction is shared."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "marketingData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Object containing promotion data such as coupon tracking information and internal or external UTMs.",
+                      "properties": {
+                        "coupon": {
+                          "type": "string",
+                          "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.",
+                          "example": "free-shipping"
+                        },
+                        "utmSource": {
+                          "type": "string",
+                          "description": "UTM source.",
+                          "example": "Facebook"
+                        },
+                        "utmMedium": {
+                          "type": "string",
+                          "description": "UTM medium.",
+                          "example": "CPC"
+                        },
+                        "utmCampaign": {
+                          "type": "string",
+                          "description": "UTM campaign.",
+                          "example": "Black friday"
+                        },
+                        "utmiPage": {
+                          "type": "string",
+                          "description": "utmi_page (internal utm).",
+                          "example": "utmi_page-example",
+                          "nullable": true
+                        },
+                        "utmiPart": {
+                          "type": "string",
+                          "description": "utmi_part (internal utm).",
+                          "example": "utmi_part-example",
+                          "nullable": true
+                        },
+                        "utmiCampaign": {
+                          "type": "string",
+                          "description": "utmi_campaign (internal utm).",
+                          "example": "utmi_campaign-example",
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "sellers": {
+                      "type": "array",
+                      "description": "Information on each seller.",
+                      "items": {
+                        "description": "Seller information.",
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "Seller ID."
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Seller name."
+                          },
+                          "logo": {
+                            "type": "string",
+                            "description": "Seller logo.",
+                            "nullable": true
+                          }
+                        }
+                      }
+                    },
+                    "clientPreferencesData": {
+                      "type": "object",
+                      "description": "Object containing preferences from the client who placed the order.",
+                      "properties": {
+                        "locale": {
+                          "type": "string",
+                          "description": "Client's locale. Examples: `pt-BR` and `en-US`."
+                        },
+                        "optinNewsLetter": {
+                          "type": "boolean",
+                          "description": "`true` if the client opted to receive newsletter from the store.",
+                          "example": false,
+                          "nullable": true
+                        }
+                      }
+                    },
+                    "commercialConditionData": {
+                      "type": "object",
+                      "description": "Object containing commercial condition information.",
+                      "nullable": true
+                    },
+                    "storePreferencesData": {
+                      "type": "object",
+                      "description": "Object containing data from the store's configuration (stored in VTEX's License Manager)."
+                    },
+                    "giftRegistryData": {
+                      "type": "object",
+                      "description": "Gift registry list information.",
+                      "nullable": true
+                    },
+                    "openTextField": {
+                      "type": "string",
+                      "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).",
+                      "example": "open-text-example",
+                      "nullable": true
+                    },
+                    "invoiceData": {
+                      "type": "object",
+                      "nullable": true,
+                      "description": "Invoice data including billing address.",
+                      "properties": {
+                        "address": {
+                          "type": "object",
+                          "description": "Billing address.",
+                          "properties": {
+                            "postalCode": {
+                              "type": "string",
+                              "description": "Postal code."
+                            },
+                            "city": {
+                              "type": "string",
+                              "description": "City name."
+                            },
+                            "state": {
+                              "type": "string",
+                              "description": "State name."
+                            },
+                            "country": {
+                              "type": "string",
+                              "description": "Country."
+                            },
+                            "street": {
+                              "type": "string",
+                              "description": "Street name."
+                            },
+                            "number": {
+                              "type": "string",
+                              "description": "Street number."
+                            },
+                            "neighborhood": {
+                              "type": "string",
+                              "description": "Neighborhood."
+                            },
+                            "complement": {
+                              "type": "string",
+                              "description": "Address complement."
+                            },
+                            "reference": {
+                              "type": "string",
+                              "description": "Reference for location."
+                            },
+                            "geoCoordinates": {
+                              "type": "array",
+                              "description": "Geographic coordinates (latitude, longitude).",
+                              "items": {
+                                "type": "number"
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "customData": {
+                      "type": "object",
+                      "description": "Customer additional information.",
+                      "nullable": true
+                    },
+                    "itemMetadata": {
+                      "type": "object",
+                      "description": "Item metadata.",
+                      "properties": {
+                        "items": {
+                          "type": "array",
+                          "description": "List of objects containing metadata on each item in the order.",
+                          "items": {
+                            "description": "Item metadata.",
+                            "type": "object",
+                            "properties": {
+                              "id": {
+                                "type": "string",
+                                "description": "Item ID."
+                              },
+                              "seller": {
+                                "type": "string",
+                                "description": "Seller."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Product name."
+                              },
+                              "skuName": {
+                                "type": "string",
+                                "description": "SKU name."
+                              },
+                              "productId": {
+                                "type": "string",
+                                "description": "Product ID."
+                              },
+                              "refId": {
+                                "type": "string",
+                                "description": "Ref ID."
+                              },
+                              "ean": {
+                                "type": "string",
+                                "description": "European Article Number.",
+                                "nullable": true
+                              },
+                              "imageUrl": {
+                                "type": "string",
+                                "description": "Image URL."
+                              },
+                              "detailUrl": {
+                                "type": "string",
+                                "description": "Detail URL."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    },
+                    "hooksData": {
+                      "type": "object",
+                      "description": "Hooks information.",
+                      "nullable": true
+                    },
+                    "ratesAndBenefitsData": {
+                      "type": "object",
+                      "description": "Information on rates and benefits that apply to the order.",
+                      "properties": {
+                        "rateAndBenefitsIdentifiers": {
+                          "type": "array",
+                          "description": "List with rates and benefits identifiers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit identifier."
+                          }
+                        },
+                        "teaser": {
+                          "type": "array",
+                          "description": "List with rates and benefits teasers.",
+                          "items": {
+                            "type": "string",
+                            "description": "Benefit teaser."
+                          }
+                        }
+                      }
+                    },
+                    "subscriptionData": {
+                      "type": "object",
+                      "description": "Subscription information.",
+                      "nullable": true
+                    },
+                    "itemsOrdination": {
+                      "type": "object",
+                      "description": "Object containing information about the ordering of items within the `orderForm`.",
+                      "properties": {
+                        "criteria": {
+                          "type": "string",
+                          "description": "Criteria adopted to order the items in the list."
+                        },
+                        "ascending": {
+                          "type": "boolean",
+                          "description": "Indicates whether the ordering is ascending."
+                        }
+                      }
+                    }
+                  }
+                },
+                "example": {
+                  "orderForm": null,
+                  "transactionData": {
+                    "merchantTransactions": [
+                      {
+                        "id": "STORE",
+                        "transactionId": "62FEDE228E2144649CF67812C4E5ER79",
+                        "merchantName": "STORE",
+                        "payments": [
+                          {
+                            "paymentSystem": 6,
+                            "bin": null,
+                            "accountId": "12",
+                            "value": 15650,
+                            "referenceValue": 15650,
+                            "giftCardRedemptionCode": null,
+                            "giftCardProvider": null,
+                            "giftCardId": null
+                          }
+                        ]
+                      }
+                    ],
+                    "receiverUri": "https://store.vtexpayments.com.br/split/v976778amgh/payments",
+                    "gatewayCallbackTemplatePath": "/checkout/gatewayCallback/v976778amgh/{messageCode}"
+                  },
+                  "orders": [
+                    {
+                      "orderId": "v976778amgh-01",
+                      "orderGroup": "v976778amgh",
+                      "state": "order-created",
+                      "isCheckedIn": false,
+                      "sellerOrderId": "00-v976778amgh-01",
+                      "storeId": "1",
+                      "value": 15650,
+                      "items": [
+                        {
+                          "uniqueId": "0F93E9C4926A4CD97FDD4C2599BDF9DB",
+                          "id": "2000016",
+                          "productId": "2000002",
+                          "refId": "35-Preto",
+                          "ean": null,
+                          "name": "Produto Seleção SKU - Lista 35 - Preto",
+                          "skuName": "35 - Preto",
+                          "modalType": null,
+                          "priceValidUntil": "2018-02-16T23:42:44.5467295Z",
+                          "tax": 0,
+                          "price": 15000,
+                          "listPrice": 15000,
+                          "manualPrice": null,
+                          "sellingPrice": 15000,
+                          "rewardValue": 1,
+                          "isGift": false,
+                          "additionalInfo": {
+                            "brandName": "Marca Um",
+                            "brandId": "1",
+                            "offeringInfo": null,
+                            "offeringType": null,
+                            "offeringTypeId": null
+                          },
+                          "preSaleDate": null,
+                          "productCategoryIds": "/12/28/",
+                          "productCategories": {
+                            "12": "Departamento 5",
+                            "28": "Categoria 5-3"
+                          },
+                          "defaultPicker": null,
+                          "handlerSequence": 0,
+                          "handling": false,
+                          "quantity": 1,
+                          "seller": "1",
+                          "imageUrl": "http://store.vteximg.com.br/arquivos/ids/168463-55-55/imagem-modo-lista.png",
+                          "detailUrl": "/produto-selecao-sku-lista/p",
+                          "components": [],
+                          "bundleItems": [],
+                          "attachments": [],
+                          "itemAttachment": {
+                            "name": null,
+                            "content": {}
+                          },
+                          "attachmentOfferings": [
+                            {
+                              "name": "vtex.subscription.weekly",
+                              "required": false,
+                              "schema": {
+                                "vtex.subscription.key.frequency": {
+                                  "MaximumNumberOfCharacters": 7,
+                                  "Domain": [
+                                    "1 week",
+                                    "2 week",
+                                    "3 week",
+                                    "4 week"
+                                  ]
+                                }
+                              }
+                            },
+                            {
+                              "name": "vtex.subscription.daily",
+                              "required": false,
+                              "schema": {
+                                "vtex.subscription.key.frequency": {
+                                  "MaximumNumberOfCharacters": 5,
+                                  "Domain": [
+                                    "1 day"
+                                  ]
+                                }
+                              }
+                            }
+                          ],
+                          "offerings": [],
+                          "priceTags": [
+                            {
+                              "name": "DISCOUNT@MANUALPRICE",
+                              "value": -5000,
+                              "rawValue": -50,
+                              "isPercentual": false,
+                              "identifier": "1234abc-5678b-1234c"
+                            }
+                          ],
+                          "availability": "available",
+                          "measurementUnit": "un",
+                          "unitMultiplier": 1
+                        }
+                      ],
+                      "sellers": [
+                        {
+                          "id": "1",
+                          "name": "Store",
+                          "logo": "Logo"
+                        }
+                      ],
+                      "totals": [
+                        {
+                          "id": "Items",
+                          "name": "Total dos Itens",
+                          "value": 15000
+                        },
+                        {
+                          "id": "Discounts",
+                          "name": "Total dos Descontos",
+                          "value": 0
+                        },
+                        {
+                          "id": "Shipping",
+                          "name": "Total do Frete",
+                          "value": 650
+                        },
+                        {
+                          "id": "Tax",
+                          "name": "Total da Taxa",
+                          "value": 0
+                        }
+                      ],
+                      "clientProfileData": {
+                        "email": "clark.kent@examplemail.com",
+                        "firstName": "Clark",
+                        "lastName": "Kent",
+                        "document": "12345678900",
+                        "documentType": "cpf",
+                        "phone": "+5500123456789",
+                        "corporateName": "company-name",
+                        "tradeName": "trade-name",
+                        "corporateDocument": "12345678000100",
+                        "stateInscription": "12345678",
+                        "corporatePhone": "551100988887777",
+                        "isCorporate": false,
+                        "profileCompleteOnLoading": false,
+                        "profileErrorOnLoading": false,
+                        "customerClass": null
+                      },
+                      "ratesAndBenefitsData": {
+                        "attachmentId": "ratesAndBenefitsData",
+                        "rateAndBenefitsIdentifiers": [],
+                        "teaser": []
+                      },
+                      "shippingData": {
+                        "attachmentId": "shippingData",
+                        "address": {
+                          "addressType": "residential",
+                          "receiverName": "Marcelo",
+                          "addressId": "49ad09e5fba8434a8ff1e0faa4b60ceb",
+                          "postalCode": "28050987",
+                          "city": "Rio de Janeiro",
+                          "state": "RJ",
+                          "country": "BRA",
+                          "street": "Rua da minha casa",
+                          "number": "123",
+                          "neighborhood": "Copacabana",
+                          "complement": "15º andar",
+                          "reference": null,
+                          "geoCoordinates": []
+                        },
+                        "logisticsInfo": [
+                          {
+                            "itemIndex": 0,
+                            "selectedSla": "Normal",
+                            "slas": [
+                              {
+                                "id": "n2_2",
+                                "name": "n2_2",
+                                "deliveryIds": [
+                                  {
+                                    "courierId": "1de4790",
+                                    "warehouseId": "1_1",
+                                    "dockId": "N2",
+                                    "courierName": "N2_2",
+                                    "quantity": 1
+                                  }
+                                ],
+                                "shippingEstimate": "6bd",
+                                "shippingEstimateDate": null,
+                                "lockTTL": "7d",
+                                "availableDeliveryWindows": [
+                                  {
+                                    "startDateUtc": "2024-03-27T00:00:00+00:00",
+                                    "endDateUtc": "2024-03-27T00:00:00+00:00",
+                                    "price": 0,
+                                    "lisPrice": 0,
+                                    "tax": 0
+                                  },
+                                  {
+                                    "startDateUtc": "2024-03-28T00:00:00+00:00",
+                                    "endDateUtc": "2024-03-28T00:00:00+00:00",
+                                    "price": 0,
+                                    "lisPrice": 0,
+                                    "tax": 0
+                                  }
+                                ],
+                                "deliveryWindow": null,
+                                "price": 650,
+                                "listPrice": 650,
+                                "tax": 0,
+                                "pickupStoreInfo": {
+                                  "isPickupStore": false,
+                                  "friendlyName": null,
+                                  "address": null,
+                                  "additionalInfo": null,
+                                  "dockId": null
+                                }
+                              },
+                              {
+                                "id": "Normal",
+                                "name": "Normal",
+                                "deliveryIds": [
+                                  {
+                                    "courierId": "2p1t",
+                                    "warehouseId": "1_1",
+                                    "dockId": "N2",
+                                    "courierName": "Post_Test_2",
+                                    "quantity": 1
+                                  }
+                                ],
+                                "shippingEstimate": "6bd",
+                                "shippingEstimateDate": null,
+                                "lockTTL": "7d",
+                                "availableDeliveryWindows": [],
+                                "deliveryWindow": null,
+                                "price": 650,
+                                "listPrice": 650,
+                                "tax": 0,
+                                "pickupStoreInfo": {
+                                  "isPickupStore": false,
+                                  "friendlyName": null,
+                                  "address": null,
+                                  "additionalInfo": null,
+                                  "dockId": null
+                                }
+                              },
+                              {
+                                "id": "P_T",
+                                "name": "P_T",
+                                "deliveryIds": [
+                                  {
+                                    "courierId": "1p1t",
+                                    "warehouseId": "1_1",
+                                    "dockId": "N2",
+                                    "courierName": "Post_Teste",
+                                    "quantity": 1
+                                  }
+                                ],
+                                "shippingEstimate": "6bd",
+                                "shippingEstimateDate": null,
+                                "lockTTL": "7d",
+                                "availableDeliveryWindows": [],
+                                "deliveryWindow": null,
+                                "price": 1462,
+                                "listPrice": 1462,
+                                "tax": 0,
+                                "pickupStoreInfo": {
+                                  "isPickupStore": false,
+                                  "friendlyName": null,
+                                  "address": null,
+                                  "additionalInfo": null,
+                                  "dockId": null
+                                }
+                              },
+                              {
+                                "id": "Econômica",
+                                "name": "Econômica",
+                                "deliveryIds": [
+                                  {
+                                    "courierId": "2B9C2C7D-7A76-485D-94EF-701D041E448C",
+                                    "warehouseId": "1_1",
+                                    "dockId": "1_1_1",
+                                    "courierName": "Leve 30kg (De: 10000-000 Até: 25999-999) ",
+                                    "quantity": 1
+                                  }
+                                ],
+                                "shippingEstimate": "20bd",
+                                "shippingEstimateDate": null,
+                                "lockTTL": "7d",
+                                "availableDeliveryWindows": [],
+                                "deliveryWindow": null,
+                                "price": 2265,
+                                "listPrice": 2265,
+                                "tax": 0,
+                                "pickupStoreInfo": {
+                                  "isPickupStore": false,
+                                  "friendlyName": null,
+                                  "address": null,
+                                  "additionalInfo": null,
+                                  "dockId": null
+                                }
+                              }
+                            ],
+                            "shipsTo": [
+                              "BRA"
+                            ],
+                            "itemId": "2000016"
+                          }
+                        ],
+                        "availableAddresses": [
+                          {
+                            "addressType": "residential",
+                            "receiverName": "Marcelo",
+                            "addressId": "49ad09e5fba8434a8ff1e0faa4b60ceb",
+                            "postalCode": "28050642",
+                            "city": "Rio de Janeiro",
+                            "state": "RJ",
+                            "country": "BRA",
+                            "street": "Rua da minha casa",
+                            "number": "123",
+                            "neighborhood": "Copacabana",
+                            "complement": "15º andar",
+                            "reference": null,
+                            "geoCoordinates": []
+                          }
+                        ]
+                      },
+                      "paymentData": {
+                        "attachmentId": "paymentData",
+                        "transactionId": "62FEDE228E2144649CF67812C4E5DD87",
+                        "payments": [
+                          {
+                            "paymentSystem": 6,
+                            "bin": null,
+                            "accountId": "12",
+                            "tokenId": null,
+                            "value": 34390,
+                            "referenceValue": 34390,
+                            "giftCardRedemptionCode": null,
+                            "giftCardProvider": null,
+                            "giftCardId": null
+                          }
+                        ],
+                        "giftCards": [],
+                        "transactions": [
+                          {
+                            "isActive": true,
+                            "transactionId": "62FEDE228E2144649CF67812C4E5DD87",
+                            "merchantName": "STORE",
+                            "payments": [
+                              {
+                                "paymentSystem": 6,
+                                "bin": null,
+                                "accountId": "12",
+                                "tokenId": null,
+                                "value": 34390,
+                                "referenceValue": 34390,
+                                "giftCardRedemptionCode": null,
+                                "giftCardProvider": null,
+                                "giftCardId": null
+                              }
+                            ]
+                          }
+                        ],
+                        "merchantName": "STORE"
+                      },
+                      "clientPreferencesData": {
+                        "attachmentId": "clientPreferencesData",
+                        "locale": "pt-BR",
+                        "optinNewsLetter": true
+                      },
+                      "giftRegistryData": null,
+                      "marketingData": null,
+                      "storePreferencesData": {
+                        "countryCode": "BRA",
+                        "checkToSavePersonDataByDefault": false,
+                        "templateOptions": {
+                          "toggleCorporate": false
+                        },
+                        "timeZone": "E. South America Standard Time",
+                        "currencyCode": "BRL",
+                        "currencyLocale": 1046,
+                        "currencySymbol": "R$",
+                        "currencyFormatInfo": {
+                          "currencyDecimalDigits": 2,
+                          "currencyDecimalSeparator": ",",
+                          "currencyGroupSeparator": ".",
+                          "currencyGroupSize": 3,
+                          "startsWithCurrencySymbol": true
+                        }
+                      },
+                      "openTextField": {
+                        "attachmentId": "openTextField",
+                        "value": null
+                      },
+                      "changeData": null,
+                      "salesChannel": "1",
+                      "followUpEmail": "f1e7309d88dd4633825ce183d52a50a6@ct.vtex.com.br",
+                      "creationDate": "2024-02-16T23:42:43.9605088Z",
+                      "lastChange": "2024-02-16T23:42:47.62285Z",
+                      "timeZoneCreationDate": "2024-02-16T21:42:43.9605088",
+                      "timeZoneLastChange": "2024-02-16T21:42:47.62285",
+                      "isCompleted": false,
+                      "hostName": "ambienteqa",
+                      "merchantName": null,
+                      "userType": "User type",
+                      "roundingError": 0
+                    }
+                  ]
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/api/checkout/pub/orders": {
+      "put": {
+        "tags": [
+          "Order placement"
+        ],
+        "summary": "Place order",
+        "description": "Places order without having any prior cart information. This means all information on items, client, payment and shipping must be sent in the body.\r\n\r\n>⚠️ 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).\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Orders Full Access** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "PlaceOrder",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "sc",
+            "in": "query",
+            "description": "Trade Policy (Sales Channel) identification. This query can be used to create an order for a specific sales channel.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "integer",
+              "example": 1
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "required": [
+                  "items",
+                  "clientProfileData",
+                  "shippingData",
+                  "paymentData"
+                ],
+                "properties": {
+                  "items": {
+                    "type": "array",
+                    "description": "Array of objects containing information on each of the order's items.",
+                    "items": {
+                      "description": "Information on each of the order's items.",
+                      "type": "object",
+                      "required": [
+                        "id",
+                        "quantity",
+                        "seller"
+                      ],
+                      "properties": {
+                        "id": {
+                          "type": "string",
+                          "description": "The SKU ID.",
+                          "example": "123"
+                        },
+                        "quantity": {
+                          "type": "integer",
+                          "format": "int32",
+                          "description": "The quantity of items of this specific SKU in the cart to be simulated.",
+                          "example": 1
+                        },
+                        "seller": {
+                          "type": "string",
+                          "description": "The ID of the seller responsible for this SKU. This ID can be found in your VTEX Admin.",
+                          "example": "1"
+                        },
+                        "commission": {
+                          "type": "integer",
+                          "description": "Comission.",
+                          "example": 10
+                        },
+                        "freightCommission": {
+                          "type": "integer",
+                          "description": "Freight comission.",
+                          "example": 10
+                        },
+                        "price": {
+                          "type": "integer",
+                          "description": "Item price within the context of the order without separating cents. For example, $24.99 is represented `2499`.",
+                          "example": 2499
+                        },
+                        "bundleItems": {
+                          "type": "array",
+                          "description": "Information on services sold along with the SKU. Example: a gift package.",
+                          "items": {
+                            "description": "Information on services sold along with the SKU. Example: a gift package.",
+                            "type": "object",
+                            "properties": {
+                              "type": {
+                                "type": "string",
+                                "description": "Service type.",
+                                "example": "type-example"
+                              },
+                              "id": {
+                                "type": "string",
+                                "description": "Service identifier.",
+                                "example": "id-example"
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Service name.",
+                                "example": "name-example"
+                              },
+                              "price": {
+                                "type": "integer",
+                                "description": "Service price. The last two digits are the cents.",
+                                "example": 199
+                              }
+                            }
+                          }
+                        },
+                        "itemAttachment": {
+                          "type": "object",
+                          "description": "Item attachment.",
+                          "properties": {
+                            "name": {
+                              "type": "string",
+                              "description": "Attachment name.",
+                              "example": "name-example"
+                            },
+                            "content": {
+                              "type": "string",
+                              "description": "Content referring to the customization requested by the customer.",
+                              "example": "content-example"
+                            }
+                          }
+                        },
+                        "attachments": {
+                          "type": "array",
+                          "description": "Array containing information on attachments.",
+                          "items": {
+                            "description": "Information on attachments.",
+                            "type": "string"
+                          }
+                        },
+                        "priceTags": {
+                          "type": "array",
+                          "description": "Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.",
+                          "items": {
+                            "description": "Price tag information.",
+                            "type": "object",
+                            "properties": {
+                              "identifier": {
+                                "type": "string",
+                                "description": "Promotion unique identifier.",
+                                "nullable": true
+                              },
+                              "isPercentual": {
+                                "type": "boolean",
+                                "description": "Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly."
+                              },
+                              "name": {
+                                "type": "string",
+                                "description": "Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\r\n- `type` indicates whether the tag refers to a discount or tax.\r\n- `where` specifies the context, either price or shipping.\r\n- `identifier` is the promotion ID.\r\n- `calculationId` is a hash that may vary with each price calculation."
+                              },
+                              "rawValue": {
+                                "type": "number",
+                                "description": "Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations."
+                              },
+                              "value": {
+                                "type": "integer",
+                                "description": "Price tag value representing either a promotion (value decrease) or a tax (value increase)."
+                              }
+                            }
+                          }
+                        },
+                        "measurementUnit": {
+                          "type": "string",
+                          "description": "SKU measurement unit.",
+                          "example": "g"
+                        },
+                        "unitMultiplier": {
+                          "type": "integer",
+                          "description": "SKU unit multiplier.",
+                          "example": 1
+                        },
+                        "isGift": {
+                          "type": "boolean",
+                          "description": "Indicates whether the order is a gift.",
+                          "example": false
+                        }
+                      },
+                      "example": {
+                        "id": "123456789",
+                        "quantity": 1,
+                        "seller": "1"
+                      }
+                    }
+                  },
+                  "clientProfileData": {
+                    "type": "object",
+                    "description": "Customer's profile information. The `email` functions as a customer's ID.\n\r\n\rFor customers already in your database, sending only the email address is enough to register the order to the shopper’s existing account.\n\r\n\r> If the shopper exists in you database but is not logged in, sending other profile information along with the email will cause the platform to fail placing the order. This happens because this action is interpreted as an attempt to edit profile data, which is not possible unless the customer is logged in to the store.",
+                    "required": [
+                      "email"
+                    ],
+                    "nullable": true,
+                    "properties": {
+                      "email": {
+                        "type": "string",
+                        "description": "Customer's email address.",
+                        "example": "customer@examplemail.com",
+                        "nullable": true
+                      },
+                      "firstName": {
+                        "type": "string",
+                        "description": "Customer's first name.",
+                        "example": "first-name",
+                        "nullable": true
+                      },
+                      "lastName": {
+                        "type": "string",
+                        "description": "Customer's last name.",
+                        "example": "last-name"
+                      },
+                      "documentType": {
+                        "type": "string",
+                        "description": "Type of the document informed by the customer.",
+                        "example": "cpf"
+                      },
+                      "document": {
+                        "type": "string",
+                        "description": "Document number informed by the customer.",
+                        "example": "123456789"
+                      },
+                      "phone": {
+                        "type": "string",
+                        "description": "Customer's phone number.",
+                        "example": "+55110988887777"
+                      },
+                      "corporateName": {
+                        "type": "string",
+                        "description": "Company name, if the customer is a legal entity.",
+                        "example": "company-name"
+                      },
+                      "tradeName": {
+                        "type": "string",
+                        "description": "Trade name, if the customer is a legal entity.",
+                        "example": "trade-name"
+                      },
+                      "corporateDocument": {
+                        "type": "string",
+                        "description": "Corporate document, if the customer is a legal entity.",
+                        "example": "12345678000100"
+                      },
+                      "stateInscription": {
+                        "type": "string",
+                        "description": "State inscription, if the customer is a legal entity.",
+                        "example": "12345678"
+                      },
+                      "corporatePhone": {
+                        "type": "string",
+                        "description": "Corporate phone number, if the customer is a legal entity.",
+                        "example": "+551100988887777"
+                      },
+                      "isCorporate": {
+                        "type": "boolean",
+                        "description": "`true` if the customer is a legal entity.",
+                        "example": false
+                      }
+                    }
+                  },
+                  "shippingData": {
+                    "type": "object",
+                    "description": "Shipping information.",
+                    "nullable": true,
+                    "properties": {
+                      "address": {
+                        "type": "object",
+                        "description": "Shipping address.\n\r\n\rFor customers already in your data base, it is enough to send this object only with an `addressId`, which you may obtain from a [Cart simulation request](https://developers.vtex.com/vtex-rest-api/reference/shopping-cart#cartsimulation), for example.",
+                        "nullable": true,
+                        "properties": {
+                          "addressType": {
+                            "type": "string",
+                            "description": "Type of address. For example, `Residential` or `Pickup`, among others.",
+                            "example": "residential"
+                          },
+                          "receiverName": {
+                            "type": "string",
+                            "description": "Name of the person who is going to receive the order.",
+                            "example": "receiver-name"
+                          },
+                          "addressId": {
+                            "type": "string",
+                            "description": "Address ID.",
+                            "example": "Home",
+                            "nullable": true
+                          },
+                          "postalCode": {
+                            "type": "string",
+                            "description": "Postal Code.",
+                            "example": "12345-000"
+                          },
+                          "city": {
+                            "type": "string",
+                            "description": "City of the shipping address.",
+                            "example": "Rio de Janeiro"
+                          },
+                          "state": {
+                            "type": "string",
+                            "description": "State of the shipping address.",
+                            "example": "Rio de Janeiro"
+                          },
+                          "country": {
+                            "type": "string",
+                            "description": "Three letter ISO code of the country of the shipping address.",
+                            "example": "BRA"
+                          },
+                          "street": {
+                            "type": "string",
+                            "description": "Street of the shipping address.",
+                            "example": "Praia de Botafogo"
+                          },
+                          "number": {
+                            "type": "string",
+                            "description": "Number of the building, house or apartment in the shipping address.",
+                            "example": "300"
+                          },
+                          "neighborhood": {
+                            "type": "string",
+                            "description": "Neighborhood of the shipping address.",
+                            "example": "Botafogo"
+                          },
+                          "complement": {
+                            "description": "Complement to the shipping address, in case it applies.",
+                            "type": "string",
+                            "nullable": true,
+                            "example": "3rd floor"
+                          },
+                          "reference": {
+                            "type": "string",
+                            "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                            "example": "Grey building"
+                          },
+                          "geoCoordinates": {
+                            "type": "array",
+                            "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
+                            "example": [
+                              -47.924747467041016,
+                              -15.832582473754883
+                            ],
+                            "items": {
+                              "type": "number",
+                              "example": -47.924747467041016,
+                              "description": "Geocoordinates numbers."
+                            }
+                          }
+                        }
+                      },
+                      "logisticsInfo": {
+                        "type": "array",
+                        "description": "Array of objects containing logistics information of each item.",
+                        "items": {
+                          "description": "Logistics information.",
+                          "type": "object",
+                          "required": [
+                            "itemIndex",
+                            "selectedSla",
+                            "price"
+                          ],
+                          "properties": {
+                            "itemIndex": {
+                              "type": "integer",
+                              "description": "Index of the item in the `items` array, starting from 0.",
+                              "example": 0
+                            },
+                            "selectedSla": {
+                              "type": "string",
+                              "description": "Selected shipping option.",
+                              "example": "Express",
+                              "nullable": true
+                            },
+                            "selectedDeliveryChannel": {
+                              "type": "string",
+                              "description": "String with the selected delivery channel. This field supports the following values:  \n\n- `delivery`,  \n\n- `pickup-in-point`.",
+                              "example": "delivery",
+                              "nullable": true
+                            },
+                            "lockTTL": {
+                              "type": "string",
+                              "description": "Logistics reservation waiting time.",
+                              "example": "8d",
+                              "nullable": true
+                            },
+                            "shippingEstimate": {
+                              "type": "string",
+                              "description": "Estimated time until delivery for the item.",
+                              "example": "7d"
+                            },
+                            "price": {
+                              "type": "integer",
+                              "description": "Shipping price for the item. Does not account for the whole order's shipping price.",
+                              "example": 1099
+                            },
+                            "deliveryWindow": {
+                              "type": "object",
+                              "description": "In case of scheduled delivery, this object will contain information on the delivery window selected by the shopper.",
+                              "properties": {
+                                "startDateUtc": {
+                                  "type": "string",
+                                  "description": "Delivery window starting day and time in UTC.",
+                                  "example": "2021-07-13T00:00:00+00:00"
+                                },
+                                "endDateUtc": {
+                                  "type": "string",
+                                  "description": "Delivery window ending day and time in UTC.",
+                                  "example": "2021-07-13T23:59:59+00:00"
+                                },
+                                "price": {
+                                  "type": "integer",
+                                  "description": "Delivery window price.",
+                                  "example": 0
+                                },
+                                "lisPrice": {
+                                  "type": "integer",
+                                  "description": "Delivery window list price.",
+                                  "example": 0
+                                },
+                                "tax": {
+                                  "type": "integer",
+                                  "description": "Delivery window tax.",
+                                  "example": 0
+                                }
+                              }
+                            }
+                          }
+                        }
+                      },
+                      "updateStatus": {
+                        "type": "string",
+                        "description": "Indicate whether this object's information is up to date according to the order's items. An order can not be placed if `\"outdated\"`.",
+                        "example": "updated"
+                      }
+                    }
+                  },
+                  "paymentData": {
+                    "type": "object",
+                    "required": [
+                      "payments"
+                    ],
+                    "description": "Payment infomation.",
+                    "properties": {
+                      "giftCards": {
+                        "type": "array",
+                        "description": "Gift card information, if it applies to the order.",
+                        "items": {
+                          "description": "Gift card information.",
+                          "type": "object",
+                          "required": [
+                            "redemptionCode",
+                            "value"
+                          ],
+                          "properties": {
+                            "redemptionCode": {
+                              "type": "string",
+                              "description": "Gift card redemption code.",
+                              "example": "HYUO-TEZZ-QFFT-HTFR"
+                            },
+                            "value": {
+                              "type": "integer",
+                              "description": "Gift card value.",
+                              "example": 500
+                            },
+                            "balance": {
+                              "type": "integer",
+                              "description": "Gift card balance.",
+                              "example": 500
+                            },
+                            "name": {
+                              "type": "string",
+                              "description": "Gift card name.",
+                              "example": "name-example"
+                            },
+                            "id": {
+                              "type": "string",
+                              "description": "Gift card ID.",
+                              "example": "1390324156495k195pmab4rall3di"
+                            },
+                            "inUse": {
+                              "type": "boolean",
+                              "description": "Indicates whether gift card is in use.",
+                              "example": true
+                            },
+                            "isSpecialCard": {
+                              "type": "boolean",
+                              "description": "Indicates whether gift card is special.",
+                              "example": false
+                            }
+                          }
+                        }
+                      },
+                      "giftCardMessages": {
+                        "type": "array",
+                        "description": "Array of gift card messages.",
+                        "items": {
+                          "example": "message-example",
+                          "description": "Gift card message.",
+                          "type": "string"
+                        }
+                      },
+                      "paymentSystems": {
+                        "type": "array",
+                        "description": "Information on payment systems.",
+                        "items": {
+                          "type": "object",
+                          "description": "Payment system.",
+                          "properties": {
+                            "id": {
+                              "type": "integer",
+                              "description": "Payment system ID.",
+                              "example": 2
+                            },
+                            "name": {
+                              "type": "string",
+                              "description": "Payment system name.",
+                              "example": "Visa"
+                            },
+                            "groupName": {
+                              "type": "string",
+                              "description": "Payment group name.",
+                              "example": "creditCardPaymentGroup"
+                            },
+                            "validator": {
+                              "type": "object",
+                              "description": "Payment system validator.",
+                              "properties": {
+                                "regex": {
+                                  "type": "string",
+                                  "description": "Payment system validator.",
+                                  "example": "^4"
+                                },
+                                "mask": {
+                                  "type": "string",
+                                  "description": "Validator mask.",
+                                  "example": "9999 9999 9999 9999"
+                                },
+                                "cardCodeRegex": {
+                                  "type": "string",
+                                  "description": "Card code regular expression.",
+                                  "example": "[^0-9]"
+                                },
+                                "cardCodeMask": {
+                                  "type": "string",
+                                  "description": "Card code mask.",
+                                  "example": "999"
+                                },
+                                "weights": {
+                                  "type": "array",
+                                  "description": "Weights.",
+                                  "items": {
+                                    "type": "integer",
+                                    "description": "Weights."
+                                  },
+                                  "example": [
+                                    2,
+                                    1,
+                                    2,
+                                    1,
+                                    2,
+                                    1,
+                                    2,
+                                    1,
+                                    2,
+                                    1,
+                                    2,
+                                    1,
+                                    2,
+                                    1,
+                                    2,
+                                    1,
+                                    2,
+                                    1,
+                                    2
+                                  ]
+                                }
+                              }
+                            },
+                            "stringId": {
+                              "type": "string",
+                              "description": "String ID.",
+                              "example": "12345abc"
+                            },
+                            "template": {
+                              "type": "string",
+                              "description": "Template.",
+                              "example": "creditCardPaymentGroup-template"
+                            },
+                            "requiresDocument": {
+                              "type": "boolean",
+                              "description": "Indicates whether a document is required.",
+                              "example": false
+                            },
+                            "selected": {
+                              "type": "boolean",
+                              "description": "Indicates whether this payment system has been selected.",
+                              "example": false
+                            },
+                            "isCustom": {
+                              "type": "boolean",
+                              "description": "Indicates whether it is custom.",
+                              "example": false
+                            },
+                            "description": {
+                              "type": "string",
+                              "description": "Description.",
+                              "example": "description-example"
+                            }
+                          }
+                        }
+                      },
+                      "payments": {
+                        "type": "array",
+                        "description": "Payment information.",
+                        "items": {
+                          "type": "object",
+                          "required": [
+                            "paymentSystem",
+                            "referenceValue",
+                            "value",
+                            "installments"
+                          ],
+                          "description": "Payment information.",
+                          "properties": {
+                            "accountId": {
+                              "type": "string",
+                              "description": "Account ID.",
+                              "example": "accountID-example"
+                            },
+                            "bin": {
+                              "type": "string",
+                              "description": "Payment bin.",
+                              "example": "2",
+                              "nullable": true
+                            },
+                            "installments": {
+                              "type": "integer",
+                              "description": "Number of installments.",
+                              "example": 2
+                            },
+                            "paymentSystem": {
+                              "type": "integer",
+                              "description": "Payment system.",
+                              "example": 12
+                            },
+                            "referenceValue": {
+                              "type": "integer",
+                              "description": "Reference value for calculating interest rates, in case it applies.",
+                              "example": 16175
+                            },
+                            "value": {
+                              "type": "integer",
+                              "description": "Value including interest, in case it applies.",
+                              "example": 16175
+                            }
+                          }
+                        }
+                      },
+                      "updateStatus": {
+                        "type": "string",
+                        "description": "Indicates whether this object's information is up to date according to the order's items. An order can not be placed if `\"outdated\"`.",
+                        "example": "updated"
+                      }
+                    }
+                  },
+                  "marketingData": {
+                    "type": "object",
+                    "description": "Coupon information.",
+                    "nullable": true,
+                    "properties": {
+                      "coupon": {
+                        "type": "string",
+                        "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.",
+                        "example": "free-shipping"
+                      },
+                      "utmSource": {
+                        "type": "string",
+                        "description": "UTM source.",
+                        "example": "Facebook"
+                      },
+                      "utmMedium": {
+                        "type": "string",
+                        "description": "UTM medium.",
+                        "example": "CPC"
+                      },
+                      "utmCampaign": {
+                        "type": "string",
+                        "description": "UTM campaign.",
+                        "example": "Black friday"
+                      },
+                      "utmiPage": {
+                        "type": "string",
+                        "description": "utmi_page (internal utm).",
+                        "example": "utmi_page-example"
+                      },
+                      "utmiPart": {
+                        "type": "string",
+                        "description": "utmi_part (internal utm).",
+                        "example": "utmi_part-exmaple"
+                      },
+                      "utmiCampaign": {
+                        "type": "string",
+                        "description": "utmi_campaign (internal utm).",
+                        "example": "utmi_campaign-exmaple"
+                      }
+                    }
+                  },
+                  "openTextField": {
+                    "type": "string",
+                    "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/docs/guides/customizable-fields-with-checkout-api).",
+                    "example": "open-text-example"
+                  },
+                  "salesAssociateData": {
+                    "type": "object",
+                    "description": "Sales Associate information.",
+                    "properties": {
+                      "salesAssociateId": {
+                        "type": "string",
+                        "description": "Sales Associate (Seller) identification code. All information should be registered by the merchant. Maximum of 100 characters.",
+                        "example": "seller123"
+                      }
+                    }
+                  }
+                }
+              },
+              "example": {
+                "items": [
+                  {
+                    "id": "123456789",
+                    "quantity": 1,
+                    "seller": "1",
+                    "price": 2499,
+                    "commission": 10,
+                    "freightCommission": 5,
+                    "measurementUnit": "g",
+                    "unitMultiplier": 1,
+                    "isGift": false,
+                    "bundleItems": [
+                      {
+                        "type": "gift-wrap",
+                        "id": "gift-123",
+                        "name": "Gift Wrapping",
+                        "price": 199
+                      }
+                    ],
+                    "priceTags": [
+                      {
+                        "identifier": "discount-123",
+                        "isPercentual": false,
+                        "name": "Promotional Discount",
+                        "rawValue": -10,
+                        "value": -1000
+                      }
+                    ]
+                  }
+                ],
+                "clientProfileData": {
+                  "email": "customer@example.com",
+                  "firstName": "John",
+                  "lastName": "Doe",
+                  "documentType": "cpf",
+                  "document": "12345678900",
+                  "phone": "+5511999999999",
+                  "isCorporate": false
+                },
+                "shippingData": {
+                  "address": {
+                    "addressType": "residential",
+                    "receiverName": "John Doe",
+                    "postalCode": "12345-000",
+                    "city": "São Paulo",
+                    "state": "SP",
+                    "country": "BRA",
+                    "street": "Avenida Paulista",
+                    "number": "1000",
+                    "neighborhood": "Bela Vista",
+                    "complement": "Apt 101",
+                    "reference": "Next to the park"
+                  },
+                  "logisticsInfo": [
+                    {
+                      "itemIndex": 0,
+                      "selectedSla": "Express",
+                      "selectedDeliveryChannel": "delivery",
+                      "shippingEstimate": "2d",
+                      "price": 1099
+                    }
+                  ],
+                  "updateStatus": "updated"
+                },
+                "paymentData": {
+                  "payments": [
+                    {
+                      "paymentSystem": 1,
+                      "referenceValue": 2499,
+                      "value": 2499,
+                      "installments": 1
+                    }
+                  ],
+                  "giftCards": [
+                    {
+                      "redemptionCode": "GIFT-1234-5678",
+                      "value": 500,
+                      "balance": 500,
+                      "name": "Birthday Gift Card",
+                      "id": "gift123",
+                      "inUse": true,
+                      "isSpecialCard": false
+                    }
+                  ],
+                  "updateStatus": "updated"
+                },
+                "marketingData": {
+                  "coupon": "SUMMER10",
+                  "utmSource": "Google",
+                  "utmMedium": "CPC",
+                  "utmCampaign": "Summer_Sale"
+                },
+                "openTextField": "Please deliver after 5 PM.",
+                "salesAssociateData": {
+                  "salesAssociateId": "seller123"
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "orderForm": {
+                      "type": "string",
+                      "description": "This is `null` since this request does not depend on any previously existing orderForm information in the platform.",
+                      "nullable": true
+                    },
+                    "transactionData": {
+                      "type": "object",
+                      "description": "Information on each transaction pertinent to the order placed.",
+                      "properties": {
+                        "merchantTransactions": {
+                          "type": "array",
+                          "description": "Information on each merchant transaction.",
+                          "items": {
+                            "description": "Merchant transaction information.",
+                            "type": "object",
+                            "properties": {
+                              "id": {
+                                "type": "string",
+                                "description": "ID of the seller."
+                              },
+                              "transactionId": {
+                                "type": "string",
+                                "description": "ID of the transaction in the platform."
+                              },
+                              "merchantName": {
+                                "type": "string",
+                                "description": "Name of the merchant responsible for the sale."
+                              },
+                              "payments": {
+                                "type": "array",
+                                "description": "Information on each payment pertinent to the transaction.",
+                                "items": {
+                                  "description": "Payment information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "paymentSystem": {
+                                      "type": "integer",
+                                      "description": "Payment system."
+                                    },
+                                    "bin": {
+                                      "type": "string",
+                                      "description": "Payment bin.",
+                                      "nullable": true
+                                    },
+                                    "accountId": {
+                                      "type": "string",
+                                      "description": "Account ID.",
+                                      "nullable": true
+                                    },
+                                    "tokenId": {
+                                      "type": "string",
+                                      "description": "Token ID.",
+                                      "nullable": true
+                                    },
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Total value to be paid in this payment."
+                                    },
+                                    "referenceValue": {
+                                      "type": "integer",
+                                      "description": "Reference value over which interests may be applied."
+                                    },
+                                    "giftCardRedemptionCode": {
+                                      "type": "string",
+                                      "description": "Gift card redemption code.",
+                                      "nullable": true
+                                    },
+                                    "giftCardProvider": {
+                                      "type": "string",
+                                      "description": "Gift card provider.",
+                                      "nullable": true
+                                    },
+                                    "giftCardId": {
+                                      "type": "string",
+                                      "description": "Gift card ID.",
+                                      "nullable": true
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        },
+                        "receiverUri": {
+                          "type": "string",
+                          "description": "Receiver URI."
+                        },
+                        "gatewayCallbackTemplatePath": {
+                          "type": "string",
+                          "description": "Template of the gateway callback path, which may later be used to send information about the transaction."
+                        }
+                      }
+                    },
+                    "orders": {
+                      "type": "array",
+                      "description": "Information on each of the orders created.",
+                      "items": {
+                        "description": "Order information.",
+                        "type": "object",
+                        "properties": {
+                          "orderId": {
+                            "type": "string",
+                            "description": "ID of the order in the Order Management System (OMS)."
+                          },
+                          "orderGroup": {
+                            "type": "string",
+                            "description": "Order group. Orders that involve different sellers are split into different orders of a same order group."
+                          },
+                          "state": {
+                            "type": "string",
+                            "description": "State.",
+                            "nullable": true
+                          },
+                          "isCheckedIn": {
+                            "type": "boolean",
+                            "description": "Indicates whether order is checked in.",
+                            "example": false
+                          },
+                          "sellerOrderId": {
+                            "type": "string",
+                            "description": "ID of the order in the seller.",
+                            "nullable": true
+                          },
+                          "storeId": {
+                            "type": "string",
+                            "description": "Store ID.",
+                            "nullable": true
+                          },
+                          "checkedInPickupPointId": {
+                            "type": "string",
+                            "description": "Checked in pickup point.",
+                            "nullable": true
+                          },
+                          "value": {
+                            "type": "integer",
+                            "description": "Value of the order."
+                          },
+                          "items": {
+                            "type": "array",
+                            "description": "Information on each item in the order.",
+                            "items": {
+                              "description": "Item information.",
+                              "type": "object",
+                              "properties": {
+                                "uniqueId": {
+                                  "type": "string",
+                                  "description": "Unique ID."
+                                },
+                                "id": {
+                                  "type": "string",
+                                  "description": "ID of the item."
+                                },
+                                "productId": {
+                                  "type": "string",
+                                  "description": "Product ID."
+                                },
+                                "productRefId": {
+                                  "type": "string",
+                                  "description": "Product Ref ID."
+                                },
+                                "refId": {
+                                  "type": "string",
+                                  "description": "Ref ID."
+                                },
+                                "ean": {
+                                  "type": "string",
+                                  "description": "European Article Number.",
+                                  "nullable": true
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Product name."
+                                },
+                                "skuName": {
+                                  "type": "string",
+                                  "description": "SKU name."
+                                },
+                                "modalType": {
+                                  "type": "string",
+                                  "description": "Modal type.",
+                                  "nullable": true
+                                },
+                                "parentItemIndex": {
+                                  "type": "integer",
+                                  "description": "Parent item index.",
+                                  "nullable": true
+                                },
+                                "parentAssemblyBinding": {
+                                  "type": "string",
+                                  "description": "Parent assembly binding.",
+                                  "nullable": true
+                                },
+                                "priceValidUntil": {
+                                  "type": "string",
+                                  "description": "Price expiration date and time."
+                                },
+                                "tax": {
+                                  "type": "integer",
+                                  "description": "Tax value in cents."
+                                },
+                                "price": {
+                                  "type": "integer",
+                                  "description": "Price in cents."
+                                },
+                                "listPrice": {
+                                  "type": "integer",
+                                  "description": "List price in cents."
+                                },
+                                "manualPrice": {
+                                  "type": "integer",
+                                  "description": "Manual price in cents.",
+                                  "nullable": true
+                                },
+                                "manualPriceAppliedBy": {
+                                  "type": "string",
+                                  "description": "User that applied the manual price, if that is the case.",
+                                  "nullable": true
+                                },
+                                "sellingPrice": {
+                                  "type": "integer",
+                                  "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
+                                },
+                                "rewardValue": {
+                                  "type": "integer",
+                                  "description": "Reward value in cents."
+                                },
+                                "isGift": {
+                                  "type": "boolean",
+                                  "description": "Indicates whether item is a gift."
+                                },
+                                "additionalInfo": {
+                                  "type": "object",
+                                  "description": "Additional information.",
+                                  "properties": {
+                                    "dimension": {
+                                      "type": "string",
+                                      "description": "Dimension.",
+                                      "nullable": true
+                                    },
+                                    "brandName": {
+                                      "type": "string",
+                                      "description": "Brand name."
+                                    },
+                                    "brandId": {
+                                      "type": "string",
+                                      "description": "Brand ID."
+                                    },
+                                    "offeringInfo": {
+                                      "type": "string",
+                                      "description": "Offering information.",
+                                      "nullable": true
+                                    },
+                                    "offeringType": {
+                                      "type": "string",
+                                      "description": "Offering type.",
+                                      "nullable": true
+                                    },
+                                    "offeringTypeId": {
+                                      "type": "string",
+                                      "description": "Offering type ID.",
+                                      "nullable": true
+                                    }
+                                  }
+                                },
+                                "preSaleDate": {
+                                  "type": "string",
+                                  "description": "Presale date.",
+                                  "nullable": true
+                                },
+                                "productCategoryIds": {
+                                  "type": "string",
+                                  "description": "Product category IDs."
+                                },
+                                "productCategories": {
+                                  "type": "object",
+                                  "description": "Object, where each field is an ID from `productCategoryIds`.",
+                                  "properties": {
+                                    "{ID}": {
+                                      "type": "string",
+                                      "description": "Product category corresponding to the ID in the field key."
+                                    }
+                                  }
+                                },
+                                "quantity": {
+                                  "type": "integer",
+                                  "description": "Quantity."
+                                },
+                                "seller": {
+                                  "type": "string",
+                                  "description": "Seller."
+                                },
+                                "sellerChain": {
+                                  "type": "array",
+                                  "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/pt/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
+                                  "items": {
+                                    "type": "string",
+                                    "description": "Seller."
+                                  }
+                                },
+                                "imageUrl": {
+                                  "type": "string",
+                                  "description": "Image URL."
+                                },
+                                "detailUrl": {
+                                  "type": "string",
+                                  "description": "Detail URL."
+                                },
+                                "bundleItems": {
+                                  "type": "array",
+                                  "description": "Information on services sold along with the SKU. Example: a gift package.",
+                                  "items": {
+                                    "description": "Service information.",
+                                    "type": "object",
+                                    "properties": {
+                                      "type": {
+                                        "type": "string",
+                                        "description": "Service type."
+                                      },
+                                      "id": {
+                                        "type": "integer",
+                                        "description": "Service identifier."
+                                      },
+                                      "name": {
+                                        "type": "string",
+                                        "description": "Service name."
+                                      },
+                                      "price": {
+                                        "type": "integer",
+                                        "description": "Service price in cents."
+                                      }
+                                    }
+                                  }
+                                },
+                                "attachments": {
+                                  "type": "array",
+                                  "description": "Array containing information on attachments.",
+                                  "items": {
+                                    "type": "string",
+                                    "description": "Attachment ID."
+                                  }
+                                },
+                                "priceTags": {
+                                  "type": "array",
+                                  "description": "Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.",
+                                  "items": {
+                                    "description": "Price tag information.",
+                                    "type": "object",
+                                    "properties": {
+                                      "identifier": {
+                                        "type": "string",
+                                        "description": "Promotion unique identifier.",
+                                        "nullable": true
+                                      },
+                                      "isPercentual": {
+                                        "type": "boolean",
+                                        "description": "Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly."
+                                      },
+                                      "name": {
+                                        "type": "string",
+                                        "description": "Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\r\n- `type` indicates whether the tag refers to a discount or tax.\r\n- `where` specifies the context, either price or shipping.\r\n- `identifier` is the promotion ID.\r\n- `calculationId` is a hash that may vary with each price calculation."
+                                      },
+                                      "rawValue": {
+                                        "type": "number",
+                                        "description": "Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations."
+                                      },
+                                      "value": {
+                                        "type": "integer",
+                                        "description": "Price tag value representing either a promotion (value decrease) or a tax (value increase)."
+                                      }
+                                    }
+                                  }
+                                },
+                                "availability": {
+                                  "type": "string",
+                                  "description": "Availability."
+                                },
+                                "measurementUnit": {
+                                  "type": "string",
+                                  "description": "Measurement unit."
+                                },
+                                "unitMultiplier": {
+                                  "type": "integer",
+                                  "description": "Unit multiplier."
+                                },
+                                "manufacturerCode": {
+                                  "type": "string",
+                                  "description": "Manufacturer code.",
+                                  "nullable": true
+                                },
+                                "priceDefinition": {
+                                  "type": "object",
+                                  "description": "Price information for all units of a specific item.",
+                                  "properties": {
+                                    "calculatedSellingPrice": {
+                                      "type": "integer",
+                                      "description": "Item's calculated unitary selling price in cents."
+                                    },
+                                    "total": {
+                                      "type": "integer",
+                                      "description": "Total value for all units of the item in cents."
+                                    },
+                                    "sellingPrices": {
+                                      "type": "array",
+                                      "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
+                                      "items": {
+                                        "description": "Rounding information.",
+                                        "type": "object",
+                                        "properties": {
+                                          "value": {
+                                            "type": "integer",
+                                            "description": "Value in cents for that specific rounding."
+                                          },
+                                          "quantity": {
+                                            "type": "integer",
+                                            "description": "Rounding quantity, meaning how many items are rounded to this value."
+                                          }
+                                        }
+                                      }
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          },
+                          "sellers": {
+                            "type": "array",
+                            "description": "Information on each seller.",
+                            "items": {
+                              "description": "Seller information.",
+                              "type": "object",
+                              "properties": {
+                                "id": {
+                                  "type": "string",
+                                  "description": "Seller ID."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Seller name."
+                                },
+                                "logo": {
+                                  "type": "string",
+                                  "description": "Seller logo.",
+                                  "nullable": true
+                                }
+                              }
+                            }
+                          },
+                          "totals": {
+                            "type": "array",
+                            "description": "Information on order totals.",
+                            "items": {
+                              "description": "Order total information.",
+                              "type": "object",
+                              "properties": {
+                                "id": {
+                                  "type": "string",
+                                  "description": "Total ID."
+                                },
+                                "name": {
+                                  "type": "string",
+                                  "description": "Total name."
+                                },
+                                "value": {
+                                  "type": "integer",
+                                  "description": "Total value."
+                                }
+                              }
+                            }
+                          },
+                          "clientProfileData": {
+                            "type": "object",
+                            "description": "Customer's profile information.",
+                            "nullable": true,
+                            "properties": {
+                              "email": {
+                                "type": "string",
+                                "description": "Email address.",
+                                "nullable": true
+                              },
+                              "firstName": {
+                                "type": "string",
+                                "description": "First name.",
+                                "nullable": true
+                              },
+                              "lastName": {
+                                "type": "string",
+                                "description": "Last name."
+                              },
+                              "documentType": {
+                                "type": "string",
+                                "description": "Type of the document informed by the customer."
+                              },
+                              "document": {
+                                "type": "string",
+                                "description": "Document informed by the customer."
+                              },
+                              "phone": {
+                                "type": "string",
+                                "description": "Phone number."
+                              },
+                              "corporateName": {
+                                "type": "string",
+                                "description": "Company name, if the customer is a legal entity.",
+                                "nullable": true
+                              },
+                              "tradeName": {
+                                "type": "string",
+                                "description": "Trade name, if the customer is a legal entity.",
+                                "nullable": true
+                              },
+                              "corporateDocument": {
+                                "type": "string",
+                                "description": "Corporate document, if the customer is a legal entity.",
+                                "nullable": true
+                              },
+                              "stateInscription": {
+                                "type": "string",
+                                "description": "State inscription, if the customer is a legal entity.",
+                                "nullable": true
+                              },
+                              "corporatePhone": {
+                                "type": "string",
+                                "description": "Corporate phone number, if the customer is a legal entity.",
+                                "nullable": true
+                              },
+                              "isCorporate": {
+                                "type": "boolean",
+                                "description": "Indicates whether the customer is a legal entity."
+                              },
+                              "profileCompleteOnLoading": {
+                                "type": "boolean",
+                                "description": "Indicates whether profile is complete on loading."
+                              },
+                              "profileErrorOnLoading": {
+                                "type": "boolean",
+                                "description": "Indicates whether profile presents error on loading.",
+                                "nullable": true
+                              },
+                              "customerClass": {
+                                "type": "string",
+                                "description": "Customer class.",
+                                "nullable": true
+                              }
+                            }
+                          },
+                          "ratesAndBenefitsData": {
+                            "type": "object",
+                            "description": "Information on rates and benefits that apply to the order.",
+                            "properties": {
+                              "rateAndBenefitsIdentifiers": {
+                                "type": "array",
+                                "description": "List with rates and benefits identifiers.",
+                                "items": {
+                                  "type": "string",
+                                  "description": "Rate and benefit identifier."
+                                }
+                              },
+                              "teaser": {
+                                "type": "array",
+                                "description": "List with rates and benefits teasers.",
+                                "items": {
+                                  "type": "string",
+                                  "description": "Rate and benefit teaser."
+                                }
+                              }
+                            }
+                          },
+                          "shippingData": {
+                            "type": "object",
+                            "description": "Shipping information pertinent to the order.",
+                            "properties": {
+                              "address": {
+                                "type": "object",
+                                "description": "Address information.",
+                                "nullable": true,
+                                "properties": {
+                                  "addressType": {
+                                    "type": "string",
+                                    "description": "Type of address. For example, `Residential` or `Pickup`."
+                                  },
+                                  "receiverName": {
+                                    "type": "string",
+                                    "description": "Name of the person who is going to receive the order."
+                                  },
+                                  "addressId": {
+                                    "type": "string",
+                                    "description": "Address ID.",
+                                    "nullable": true
+                                  },
+                                  "isDisposable": {
+                                    "type": "boolean",
+                                    "description": "Indicates whether address is disposable."
+                                  },
+                                  "postalCode": {
+                                    "type": "string",
+                                    "description": "Postal code."
+                                  },
+                                  "city": {
+                                    "type": "string",
+                                    "description": "City of the shipping address."
+                                  },
+                                  "state": {
+                                    "type": "string",
+                                    "description": "State of the shipping address."
+                                  },
+                                  "country": {
+                                    "type": "string",
+                                    "description": "Three letter ISO code of the country of the shipping address."
+                                  },
+                                  "street": {
+                                    "type": "string",
+                                    "description": "Street of the shipping address."
+                                  },
+                                  "number": {
+                                    "type": "string",
+                                    "description": "Number of the building, house or apartment in the shipping address."
+                                  },
+                                  "neighborhood": {
+                                    "type": "string",
+                                    "description": "Neighborhood of the shipping address."
+                                  },
+                                  "complement": {
+                                    "type": "string",
+                                    "description": "Complement to the shipping address, in case it applies.",
+                                    "nullable": true
+                                  },
+                                  "reference": {
+                                    "type": "string",
+                                    "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                    "nullable": true
+                                  },
+                                  "geoCoordinates": {
+                                    "type": "array",
+                                    "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
+                                    "items": {
+                                      "type": "number",
+                                      "description": "Geocoordinates numbers."
+                                    }
+                                  }
+                                }
+                              },
+                              "logisticsInfo": {
+                                "type": "array",
+                                "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.",
+                                "items": {
+                                  "description": "Logistics information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "itemIndex": {
+                                      "type": "integer",
+                                      "description": "Index corresponding to the position of the object in the `items` array."
+                                    },
+                                    "selectedSla": {
+                                      "type": "string",
+                                      "description": "SLA selected by the customer.",
+                                      "nullable": true
+                                    },
+                                    "selectedDeliveryChannel": {
+                                      "type": "string",
+                                      "description": "Delivery channel selected by the customer. For example, `\"delivery\"` or `\"pickup-in-point\"`.",
+                                      "nullable": true
+                                    },
+                                    "addressId": {
+                                      "type": "string",
+                                      "description": "Address ID.",
+                                      "nullable": true
+                                    },
+                                    "slas": {
+                                      "type": "array",
+                                      "description": "Information on available SLAs.",
+                                      "items": {
+                                        "description": "SLA information.",
+                                        "type": "object",
+                                        "properties": {
+                                          "id": {
+                                            "type": "string",
+                                            "description": "SLA ID."
+                                          },
+                                          "deliveryChannel": {
+                                            "type": "string",
+                                            "description": "Delivery channel."
+                                          },
+                                          "name": {
+                                            "type": "string",
+                                            "description": "SLA name."
+                                          },
+                                          "deliveryIds": {
+                                            "type": "array",
+                                            "description": "Information on each delivery ID.",
+                                            "items": {
+                                              "description": "Delivery ID information.",
+                                              "type": "object",
+                                              "properties": {
+                                                "courierId": {
+                                                  "type": "string",
+                                                  "description": "Courier ID."
+                                                },
+                                                "warehouseId": {
+                                                  "type": "string",
+                                                  "description": "Warehouse ID."
+                                                },
+                                                "dockId": {
+                                                  "type": "string",
+                                                  "description": "Warehouse ID."
+                                                },
+                                                "courierName": {
+                                                  "type": "string",
+                                                  "description": "Courier name."
+                                                },
+                                                "quantity": {
+                                                  "type": "integer",
+                                                  "description": "Quantity."
+                                                }
+                                              }
+                                            }
+                                          },
+                                          "shippingEstimate": {
+                                            "type": "string",
+                                            "description": "Shipping estimate. For instance, Three business days will be represented `3bd`."
+                                          },
+                                          "shippingEstimateDate": {
+                                            "type": "string",
+                                            "description": "When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.",
+                                            "nullable": true
+                                          },
+                                          "useIndividualShippingEstimates": {
+                                            "type": "boolean",
+                                            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`."
+                                          },
+                                          "lockTTL": {
+                                            "type": "string",
+                                            "description": "Estimate date of delivery.",
+                                            "nullable": true
+                                          },
+                                          "price": {
+                                            "type": "integer",
+                                            "description": "Price in cents."
+                                          },
+                                          "listPrice": {
+                                            "type": "integer",
+                                            "description": "List price in cents."
+                                          },
+                                          "tax": {
+                                            "type": "integer",
+                                            "description": "Tax in cents."
+                                          },
+                                          "pickupStoreInfo": {
+                                            "type": "object",
+                                            "description": "Information on the pickup store.",
+                                            "properties": {
+                                              "isPickupStore": {
+                                                "type": "boolean",
+                                                "description": "Indicates whether it is the pickup store."
+                                              },
+                                              "friendlyName": {
+                                                "type": "string",
+                                                "description": "Friendly name.",
+                                                "nullable": true
+                                              },
+                                              "address": {
+                                                "type": "object",
+                                                "description": "Address information.",
+                                                "nullable": true,
+                                                "properties": {
+                                                  "addressType": {
+                                                    "type": "string",
+                                                    "description": "Type of address. For example, `Residential` or `Pickup`."
+                                                  },
+                                                  "postalCode": {
+                                                    "type": "string",
+                                                    "description": "Postal code."
+                                                  },
+                                                  "city": {
+                                                    "type": "string",
+                                                    "description": "City of the shipping address."
+                                                  },
+                                                  "state": {
+                                                    "type": "string",
+                                                    "description": "State of the shipping address."
+                                                  },
+                                                  "country": {
+                                                    "type": "string",
+                                                    "description": "Three letter ISO code of the country of the shipping address."
+                                                  },
+                                                  "street": {
+                                                    "type": "string",
+                                                    "description": "Street of the shipping address."
+                                                  },
+                                                  "number": {
+                                                    "type": "string",
+                                                    "description": "Number of the building, house or apartment in the shipping address."
+                                                  },
+                                                  "neighborhood": {
+                                                    "type": "string",
+                                                    "description": "Neighborhood of the shipping address."
+                                                  },
+                                                  "complement": {
+                                                    "type": "string",
+                                                    "description": "Complement to the shipping address, in case it applies.",
+                                                    "nullable": true
+                                                  },
+                                                  "reference": {
+                                                    "type": "string",
+                                                    "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                                    "nullable": true
+                                                  },
+                                                  "geoCoordinates": {
+                                                    "type": "array",
+                                                    "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
+                                                    "items": {
+                                                      "type": "number",
+                                                      "description": "Geocoordinates numbers."
+                                                    }
+                                                  }
+                                                }
+                                              },
+                                              "additionalInfo": {
+                                                "type": "string",
+                                                "description": "Additional information.",
+                                                "nullable": true
+                                              },
+                                              "dockId": {
+                                                "type": "string",
+                                                "description": "Corresponding dock ID.",
+                                                "nullable": true
+                                              }
+                                            }
+                                          },
+                                          "pickupPointId": {
+                                            "type": "string",
+                                            "description": "Pickup point ID.",
+                                            "nullable": true
+                                          },
+                                          "pickupDistance": {
+                                            "type": "integer",
+                                            "description": "Pickup point distance."
+                                          },
+                                          "polygonName": {
+                                            "type": "string",
+                                            "description": "Polygon name.",
+                                            "nullable": true
+                                          },
+                                          "transitTime": {
+                                            "type": "string",
+                                            "description": "Transit time. For instance, \"three business days\" is represented `3bd`."
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "shipsTo": {
+                                      "type": "array",
+                                      "description": "List of countries that the item may be shipped to.",
+                                      "items": {
+                                        "type": "string",
+                                        "description": "Three letter country code."
+                                      }
+                                    },
+                                    "itemId": {
+                                      "type": "string",
+                                      "description": "Item ID."
+                                    },
+                                    "deliveryChannels": {
+                                      "type": "array",
+                                      "description": "List of available delivery channels.",
+                                      "items": {
+                                        "description": "Delivery channel information.",
+                                        "type": "object",
+                                        "properties": {
+                                          "id": {
+                                            "type": "string",
+                                            "description": "Delivery channel ID."
+                                          }
+                                        }
+                                      }
+                                    }
+                                  }
+                                }
+                              },
+                              "selectedAddresses": {
+                                "type": "array",
+                                "description": "Array with information on the selected addresses for the order.",
+                                "items": {
+                                  "description": "Selected address information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "addressType": {
+                                      "type": "string",
+                                      "description": "Type of address. For example, `Residential` or `Pickup`."
+                                    },
+                                    "receiverName": {
+                                      "type": "string",
+                                      "description": "Name of the person who is going to receive the order."
+                                    },
+                                    "addressId": {
+                                      "type": "string",
+                                      "description": "Address ID.",
+                                      "nullable": true
+                                    },
+                                    "isDisposable": {
+                                      "type": "boolean",
+                                      "description": "Indicates whether address is disposable."
+                                    },
+                                    "postalCode": {
+                                      "type": "string",
+                                      "description": "Postal code."
+                                    },
+                                    "city": {
+                                      "type": "string",
+                                      "description": "City of the shipping address."
+                                    },
+                                    "state": {
+                                      "type": "string",
+                                      "description": "State of the shipping address."
+                                    },
+                                    "country": {
+                                      "type": "string",
+                                      "description": "Three letter ISO code of the country of the shipping address."
+                                    },
+                                    "street": {
+                                      "type": "string",
+                                      "description": "Street of the shipping address."
+                                    },
+                                    "number": {
+                                      "type": "string",
+                                      "description": "Number of the building, house or apartment in the shipping address."
+                                    },
+                                    "neighborhood": {
+                                      "type": "string",
+                                      "description": "Neighborhood of the shipping address."
+                                    },
+                                    "complement": {
+                                      "description": "Complement to the shipping address, in case it applies.",
+                                      "type": "string",
+                                      "nullable": true
+                                    },
+                                    "reference": {
+                                      "type": "string",
+                                      "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                      "nullable": true
+                                    },
+                                    "geoCoordinates": {
+                                      "type": "array",
+                                      "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
+                                      "items": {
+                                        "type": "number",
+                                        "description": "Geocoordinates numbers."
+                                      }
+                                    }
+                                  }
+                                }
+                              },
+                              "availableAddresses": {
+                                "type": "array",
+                                "description": "Array with information on the available addresses for the order.",
+                                "items": {
+                                  "description": "Available address information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "addressType": {
+                                      "type": "string",
+                                      "description": "Type of address. For example, `Residential` or `Pickup`."
+                                    },
+                                    "receiverName": {
+                                      "type": "string",
+                                      "description": "Name of the person who is going to receive the order."
+                                    },
+                                    "addressId": {
+                                      "type": "string",
+                                      "description": "Address ID.",
+                                      "nullable": true
+                                    },
+                                    "isDisposable": {
+                                      "type": "boolean",
+                                      "description": "Indicates whether address is disposable."
+                                    },
+                                    "postalCode": {
+                                      "type": "string",
+                                      "description": "Postal code."
+                                    },
+                                    "city": {
+                                      "type": "string",
+                                      "description": "City of the shipping address."
+                                    },
+                                    "state": {
+                                      "type": "string",
+                                      "description": "State of the shipping address."
+                                    },
+                                    "country": {
+                                      "type": "string",
+                                      "description": "Three letter ISO code of the country of the shipping address."
+                                    },
+                                    "street": {
+                                      "type": "string",
+                                      "description": "Street of the shipping address."
+                                    },
+                                    "number": {
+                                      "type": "string",
+                                      "description": "Number of the building, house or apartment in the shipping address."
+                                    },
+                                    "neighborhood": {
+                                      "type": "string",
+                                      "description": "Neighborhood of the shipping address."
+                                    },
+                                    "complement": {
+                                      "description": "Complement to the shipping address, in case it applies.",
+                                      "type": "string",
+                                      "nullable": true
+                                    },
+                                    "reference": {
+                                      "type": "string",
+                                      "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                      "nullable": true
+                                    },
+                                    "geoCoordinates": {
+                                      "type": "array",
+                                      "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
+                                      "items": {
+                                        "type": "number",
+                                        "description": "Geocoordinates numbers."
+                                      }
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          },
+                          "paymentData": {
+                            "type": "object",
+                            "description": "Information on the order's payment.",
+                            "properties": {
+                              "giftCards": {
+                                "type": "array",
+                                "description": "Gift card information, if it applies to the order.",
+                                "items": {
+                                  "description": "Gift card information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "redemptionCode": {
+                                      "type": "string",
+                                      "description": "Gift card redemption code."
+                                    },
+                                    "value": {
+                                      "type": "integer",
+                                      "description": "Gift card value in cents."
+                                    },
+                                    "balance": {
+                                      "type": "integer",
+                                      "description": "Gift card balance in cents."
+                                    },
+                                    "name": {
+                                      "type": "string",
+                                      "description": "Gift card name."
+                                    },
+                                    "id": {
+                                      "type": "string",
+                                      "description": "Gift card ID."
+                                    },
+                                    "inUse": {
+                                      "type": "boolean",
+                                      "description": "Indicates whether gift card is in use."
+                                    },
+                                    "isSpecialCard": {
+                                      "type": "boolean",
+                                      "description": "Indicates whether gift card is special."
+                                    }
+                                  }
+                                }
+                              },
+                              "transactions": {
+                                "type": "array",
+                                "description": "Information on each transaction pertinent to the order.",
+                                "items": {
+                                  "description": "Transaction information.",
+                                  "type": "object",
+                                  "properties": {
+                                    "isActive": {
+                                      "type": "boolean",
+                                      "description": "Indicates whether transaction is active."
+                                    },
+                                    "transactionId": {
+                                      "type": "string",
+                                      "description": "Transaction ID."
+                                    },
+                                    "merchantName": {
+                                      "type": "string",
+                                      "description": "Merchant name."
+                                    },
+                                    "payments": {
+                                      "type": "array",
+                                      "description": "Information on each payment.",
+                                      "items": {
+                                        "description": "Payment information.",
+                                        "type": "object",
+                                        "properties": {
+                                          "accountId": {
+                                            "type": "string",
+                                            "description": "Account ID."
+                                          },
+                                          "bin": {
+                                            "type": "string",
+                                            "description": "Bin.",
+                                            "nullable": true
+                                          },
+                                          "installments": {
+                                            "type": "integer",
+                                            "description": "Number of installments."
+                                          },
+                                          "paymentSystem": {
+                                            "type": "integer",
+                                            "description": "Payment system."
+                                          },
+                                          "referenceValue": {
+                                            "type": "integer",
+                                            "description": "Reference value for calculating interest rates, in case it applies. Displayed in cents."
+                                          },
+                                          "value": {
+                                            "type": "integer",
+                                            "description": "Value including interest, in case it applies. Displayed in cents."
+                                          }
+                                        }
+                                      }
+                                    },
+                                    "sharedTransaction": {
+                                      "type": "boolean",
+                                      "description": "Indicates whather transaction is shared."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          },
+                          "itemMetadata": {
+                            "type": "object",
+                            "description": "Item metadata.",
+                            "properties": {
+                              "items": {
+                                "type": "array",
+                                "description": "List of objects containing metadata on each item in the order.",
+                                "items": {
+                                  "type": "object",
+                                  "description": "Item metadata.",
+                                  "properties": {
+                                    "id": {
+                                      "type": "string",
+                                      "description": "Item ID."
+                                    },
+                                    "seller": {
+                                      "type": "string",
+                                      "description": "Seller."
+                                    },
+                                    "name": {
+                                      "type": "string",
+                                      "description": "Product name."
+                                    },
+                                    "skuName": {
+                                      "type": "string",
+                                      "description": "SKU name."
+                                    },
+                                    "productId": {
+                                      "type": "string",
+                                      "description": "Product ID."
+                                    },
+                                    "refId": {
+                                      "type": "string",
+                                      "description": "Ref ID."
+                                    },
+                                    "ean": {
+                                      "type": "string",
+                                      "description": "European Article Number.",
+                                      "nullable": true
+                                    },
+                                    "imageUrl": {
+                                      "type": "string",
+                                      "description": "Image URL."
+                                    },
+                                    "detailUrl": {
+                                      "type": "string",
+                                      "description": "Detail URL."
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          },
+                          "salesChannel": {
+                            "type": "string",
+                            "description": "Sales channel."
+                          },
+                          "followUpEmail": {
+                            "type": "string",
+                            "description": "Follow up email address."
+                          },
+                          "creationDate": {
+                            "type": "string",
+                            "description": "Creation date."
+                          },
+                          "lastChange": {
+                            "type": "string",
+                            "description": "Last change."
+                          },
+                          "timeZoneCreationDate": {
+                            "type": "string",
+                            "description": "Time zone creation date."
+                          },
+                          "timeZoneLastChange": {
+                            "type": "string",
+                            "description": "Time zone last change."
+                          },
+                          "isCompleted": {
+                            "type": "boolean",
+                            "description": "Indicates whether order is completed."
+                          },
+                          "hostName": {
+                            "type": "string",
+                            "description": "Host name."
+                          },
+                          "merchantName": {
+                            "type": "string",
+                            "description": "Merchant name.",
+                            "nullable": true
+                          },
+                          "userType": {
+                            "type": "string",
+                            "description": "User type."
+                          },
+                          "roundingError": {
+                            "type": "integer",
+                            "description": "Rounding error."
+                          },
+                          "allowEdition": {
+                            "type": "boolean",
+                            "description": "Indicates whether edition is allowed."
+                          },
+                          "allowCancelation": {
+                            "type": "boolean",
+                            "description": "Indicates whether cancelation is allowed."
+                          },
+                          "allowChangeSeller": {
+                            "type": "boolean",
+                            "description": "Indicates whether seller changing is allowed."
+                          },
+                          "isUserDataVisible": {
+                            "type": "boolean",
+                            "description": "Indicates whether user data is visible."
+                          },
+                          "orderFormCreationDate": {
+                            "type": "string",
+                            "description": "`orderForm` creation date."
+                          },
+                          "salesAssociateId": {
+                            "type": "string",
+                            "description": "Sales Associate (Seller) identification code."
+                          }
+                        }
+                      }
+                    }
+                  }
+                },
+                "example": {
+                  "orderForm": null,
+                  "transactionData": {
+                    "merchantTransactions": [
+                      {
+                        "id": "MYSTORE",
+                        "transactionId": "296D6D245C17437E823EB77E403FC88D",
+                        "merchantName": "MYSTORE",
+                        "payments": [
+                          {
+                            "paymentSystem": 6,
+                            "bin": null,
+                            "accountId": "12",
+                            "tokenId": null,
+                            "value": 34390,
+                            "referenceValue": 34390,
+                            "giftCardRedemptionCode": null,
+                            "giftCardProvider": null,
+                            "giftCardId": null
+                          }
+                        ]
+                      }
+                    ],
+                    "receiverUri": "https://mystore.vtexpayments.com.br/split/1146512005522/payments",
+                    "gatewayCallbackTemplatePath": "/checkout/gatewayCallback/1146512005522/{messageCode}"
+                  },
+                  "orders": [
+                    {
+                      "orderId": "1146512005522-01",
+                      "orderGroup": "1146512005522",
+                      "state": null,
+                      "isCheckedIn": false,
+                      "sellerOrderId": "00-1146512005522-01",
+                      "storeId": "1",
+                      "checkedInPickupPointId": "21",
+                      "value": 34390,
+                      "items": [
+                        {
+                          "uniqueId": "9D6E447B3FF64CEDA33B17C01379C119",
+                          "id": "2",
+                          "productId": "2",
+                          "productRefId": "1",
+                          "refId": "CBC30L",
+                          "ean": null,
+                          "name": "Chopp Brahma Claro 30L",
+                          "skuName": "Chopp Brahma Claro 30L",
+                          "modalType": null,
+                          "parentItemIndex": null,
+                          "parentAssemblyBinding": null,
+                          "assemblies": [],
+                          "priceValidUntil": "2022-07-13T18:30:46Z",
+                          "tax": 0,
+                          "price": 32890,
+                          "listPrice": 49900,
+                          "manualPrice": null,
+                          "manualPriceAppliedBy": null,
+                          "sellingPrice": 32890,
+                          "rewardValue": 0,
+                          "isGift": false,
+                          "additionalInfo": {
+                            "dimension": null,
+                            "brandName": "Brahma",
+                            "brandId": "2000000",
+                            "offeringInfo": null,
+                            "offeringType": null,
+                            "offeringTypeId": null
+                          },
+                          "preSaleDate": null,
+                          "productCategoryIds": "/1/",
+                          "productCategories": {
+                            "1": "Bebidas"
+                          },
+                          "quantity": 1,
+                          "seller": "1",
+                          "sellerChain": [
+                            "1"
+                          ],
+                          "imageUrl": "http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000",
+                          "detailUrl": "/chopp-brahma-claro-30l/p",
+                          "components": [],
+                          "bundleItems": [],
+                          "attachments": [],
+                          "attachmentOfferings": [
+                            {
+                              "name": "vtex.subscription.weekly",
+                              "required": false,
+                              "schema": {
+                                "vtex.subscription.key.frequency": {
+                                  "MaximumNumberOfCharacters": 7,
+                                  "Domain": [
+                                    "1 week",
+                                    "2 week",
+                                    "3 week",
+                                    "4 week"
+                                  ]
+                                }
+                              }
+                            },
+                            {
+                              "name": "vtex.subscription.daily",
+                              "required": false,
+                              "schema": {
+                                "vtex.subscription.key.frequency": {
+                                  "MaximumNumberOfCharacters": 5,
+                                  "Domain": [
+                                    "1 day"
+                                  ]
+                                }
+                              }
+                            }
+                          ],
+                          "offerings": [],
+                          "priceTags": [
+                            {
+                              "name": "DISCOUNT@MANUALPRICE",
+                              "value": -5000,
+                              "rawValue": -50,
+                              "isPercentual": false,
+                              "identifier": "1234abc-5678b-1234c"
+                            }
+                          ],
+                          "availability": "available",
+                          "measurementUnit": "un",
+                          "unitMultiplier": 1,
+                          "manufacturerCode": null,
+                          "priceDefinition": {
+                            "calculatedSellingPrice": 32890,
+                            "total": 32890,
+                            "sellingPrices": [
+                              {
+                                "value": 32890,
+                                "quantity": 1
+                              }
+                            ]
+                          }
+                        }
+                      ],
+                      "sellers": [
+                        {
+                          "id": "1",
+                          "name": "Tracking QA",
+                          "logo": "Logo"
+                        }
+                      ],
+                      "totals": [
+                        {
+                          "id": "Items",
+                          "name": "Total dos Itens",
+                          "value": 32890
+                        },
+                        {
+                          "id": "Discounts",
+                          "name": "Total dos Descontos",
+                          "value": 0
+                        },
+                        {
+                          "id": "Shipping",
+                          "name": "Total do Frete",
+                          "value": 1500
+                        },
+                        {
+                          "id": "Tax",
+                          "name": "Total da Taxa",
+                          "value": 0
+                        }
+                      ],
+                      "clientProfileData": {
+                        "email": "clark.kent@example.com",
+                        "firstName": "Clark",
+                        "lastName": "Kent",
+                        "document": "12345678900",
+                        "documentType": "cpf",
+                        "phone": "+5521998765432",
+                        "corporateName": "company-name",
+                        "tradeName": "trade-name",
+                        "corporateDocument": "12345678000100",
+                        "stateInscription": "12345678",
+                        "corporatePhone": "551100988887777",
+                        "isCorporate": false,
+                        "profileCompleteOnLoading": false,
+                        "profileErrorOnLoading": false,
+                        "customerClass": null
+                      },
+                      "ratesAndBenefitsData": {
+                        "rateAndBenefitsIdentifiers": [],
+                        "teaser": []
+                      },
+                      "shippingData": {
+                        "address": {
+                          "addressType": "residential",
+                          "receiverName": "Clark Kent",
+                          "addressId": "teste",
+                          "isDisposable": true,
+                          "postalCode": "70386000",
+                          "city": "Brasília",
+                          "state": "DF",
+                          "country": "BRA",
+                          "street": "Rua da minha casa",
+                          "number": "123",
+                          "neighborhood": "Copacabana",
+                          "complement": "15º andar",
+                          "reference": null,
+                          "geoCoordinates": [
+                            -47.924747467041016,
+                            -15.832582473754883
+                          ]
+                        },
+                        "logisticsInfo": [
+                          {
+                            "itemIndex": 0,
+                            "selectedSla": "Normal",
+                            "selectedDeliveryChannel": "delivery",
+                            "addressId": "teste",
+                            "slas": [
+                              {
+                                "id": "Normal",
+                                "deliveryChannel": "delivery",
+                                "name": "Normal",
+                                "deliveryIds": [
+                                  {
+                                    "courierId": "1",
+                                    "warehouseId": "1_1",
+                                    "dockId": "1",
+                                    "courierName": "Transportadora",
+                                    "quantity": 1,
+                                    "kitItemDetails": []
+                                  }
+                                ],
+                                "shippingEstimate": "3bd",
+                                "shippingEstimateDate": null,
+                                "lockTTL": "10d",
+                                "availableDeliveryWindows": [],
+                                "deliveryWindow": null,
+                                "price": 1500,
+                                "listPrice": 1500,
+                                "tax": 0,
+                                "pickupStoreInfo": {
+                                  "isPickupStore": false,
+                                  "friendlyName": null,
+                                  "address": null,
+                                  "additionalInfo": null,
+                                  "dockId": null
+                                },
+                                "pickupPointId": null,
+                                "pickupDistance": 0,
+                                "polygonName": null,
+                                "transitTime": "3bd"
+                              }
+                            ],
+                            "shipsTo": [
+                              "BRA",
+                              "COL",
+                              "USA"
+                            ],
+                            "itemId": "2",
+                            "deliveryChannels": [
+                              {
+                                "id": "delivery"
+                              },
+                              {
+                                "id": "pickup-in-point"
+                              }
+                            ]
+                          }
+                        ],
+                        "selectedAddresses": [
+                          {
+                            "addressType": "residential",
+                            "receiverName": "Clark Kent",
+                            "addressId": "teste",
+                            "isDisposable": true,
+                            "postalCode": "12345000",
+                            "city": "Rio de Janeiro",
+                            "state": "RJ",
+                            "country": "BRA",
+                            "street": "Rua da minha casa",
+                            "number": "123",
+                            "neighborhood": "Copacabana",
+                            "complement": "15º andar",
+                            "reference": null,
+                            "geoCoordinates": [
+                              -47.924747467041016,
+                              -15.832582473754883
+                            ]
+                          }
+                        ],
+                        "availableAddresses": [
+                          {
+                            "addressType": "residential",
+                            "receiverName": "Clark Kent",
+                            "addressId": "teste",
+                            "isDisposable": true,
+                            "postalCode": "12345000",
+                            "city": "Rio de Janeiro",
+                            "state": "RJ",
+                            "country": "BRA",
+                            "street": "Rua da minha casa",
+                            "number": "123",
+                            "neighborhood": "Copacabana",
+                            "complement": "15º andar",
+                            "reference": null,
+                            "geoCoordinates": [
+                              -47.924747467041016,
+                              -15.832582473754883
+                            ]
+                          }
+                        ],
+                        "pickupPoints": []
+                      },
+                      "paymentData": {
+                        "giftCards": [],
+                        "transactions": [
+                          {
+                            "isActive": true,
+                            "transactionId": "296D6D245C17437E823EB77E403FC88D",
+                            "merchantName": "MYSTORE",
+                            "payments": [
+                              {
+                                "paymentSystem": 6,
+                                "bin": null,
+                                "accountId": "12",
+                                "tokenId": null,
+                                "value": 34390,
+                                "referenceValue": 34390,
+                                "giftCardRedemptionCode": null,
+                                "giftCardProvider": null,
+                                "giftCardId": null
+                              }
+                            ],
+                            "sharedTransaction": false
+                          }
+                        ]
+                      },
+                      "clientPreferencesData": null,
+                      "commercialConditionData": null,
+                      "giftRegistryData": null,
+                      "marketingData": null,
+                      "storePreferencesData": {
+                        "countryCode": "BRA",
+                        "saveUserData": false,
+                        "timeZone": "E. South America Standard Time",
+                        "currencyCode": "BRL",
+                        "currencyLocale": 1046,
+                        "currencySymbol": "R$",
+                        "currencyFormatInfo": {
+                          "currencyDecimalDigits": 2,
+                          "currencyDecimalSeparator": ",",
+                          "currencyGroupSeparator": ".",
+                          "currencyGroupSize": 3,
+                          "startsWithCurrencySymbol": true
+                        }
+                      },
+                      "openTextField": {
+                        "value": null
+                      },
+                      "invoiceData": null,
+                      "itemMetadata": {
+                        "items": [
+                          {
+                            "id": "2",
+                            "seller": "1",
+                            "name": "Chopp Brahma Claro 30L",
+                            "skuName": "Chopp Brahma Claro 30L",
+                            "productId": "2",
+                            "refId": "CBC30L",
+                            "ean": null,
+                            "imageUrl": "http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000",
+                            "detailUrl": "/chopp-brahma-claro-30l/p",
+                            "assemblyOptions": []
+                          }
+                        ]
+                      },
+                      "taxData": null,
+                      "customData": null,
+                      "hooksData": null,
+                      "changeData": null,
+                      "subscriptionData": null,
+                      "salesChannel": "1",
+                      "followUpEmail": "6c10d76b5170456d89823b38b7c8f6ac@ct.vtex.com.br",
+                      "creationDate": "2021-07-13T18:33:25.3029443Z",
+                      "lastChange": "2021-07-13T18:33:27.736557Z",
+                      "timeZoneCreationDate": "2021-07-13T15:33:25.3029443",
+                      "timeZoneLastChange": "2021-07-13T15:33:27.736557",
+                      "isCompleted": false,
+                      "hostName": "mystore",
+                      "merchantName": null,
+                      "userType": "User type",
+                      "roundingError": 0,
+                      "allowEdition": false,
+                      "allowCancellation": false,
+                      "isUserDataVisible": true,
+                      "allowChangeSeller": false,
+                      "orderFormCreationDate": "2021-07-13T18:33:25.1313373Z"
+                    }
+                  ],
+                  "salesAssociateData": {
+                    "salesAssociateId": "seller123"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/api/checkout/pub/gatewayCallback/{orderGroup}": {
+      "post": {
+        "tags": [
+          "Order placement"
+        ],
+        "summary": "Process order",
+        "description": "Order processing callback request, which is made after an order's payment is approved.\n\r\n\r> This request has to be made 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.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Save Order Configuration** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "ProcessOrder",
+        "security": [],
+        "parameters": [
+          {
+            "name": "orderGroup",
+            "in": "path",
+            "description": "Order group. It is the part of the `orderId` that comes before the `-`. For example, the `orderGroup` of the order `123456789-01` is `123456789`.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "123456789"
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Cookie",
+            "in": "header",
+            "description": "VTEX Chekout cookie associated with a specific order. Use the `Vtex_CHKO_Auth` and the `CheckoutDataAccess` cookies returned by the [Place order](https://developers.vtex.com/vtex-rest-api/reference/order-placement-1#placeorder) or [Place order from existing cart](https://developers.vtex.com/vtex-rest-api/reference/order-placement-1#placeorderfromexistingorderform) API requests, like a browser would.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "Vtex_CHKO_Auth=0e/RpYIEZu19BuwXB4tZ7eIGu9HT8vdUAHWQDHDpxMc=; CheckoutDataAccess=0e/PoiTEZu19BuwXB4tZ7eIGu9HT8vdUAHWQDHDpxMc="
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK"
+          },
+          "428": {
+            "description": "This code is used to indicate that a payment redirection flow is required to complete the order, such as using an [external payment application](https://developers.vtex.com/docs/guides/payments-integration-payment-app).",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "RedirectResponseCollection": {
+                      "type": "array",
+                      "description": "Redirect Payment information.",
+                      "items": {
+                        "description": "Redirect URL information.",
+                        "type": "object",
+                        "properties": {
+                          "redirectUrl": {
+                            "type": "string",
+                            "description": "Redirect URL information."
+                          }
+                        }
+                      }
+                    },
+                    "paymentAuthorizationAppCollection": {
+                      "type": "array",
+                      "description": "Payment authorization information.",
+                      "items": {
+                        "description": "Payment authorization information.",
+                        "type": "object",
+                        "properties": {
+                          "appName": {
+                            "type": "string",
+                            "description": "Indicates which VTEX IO app that will handle the payment flow at Checkout."
+                          },
+                          "appPayload": {
+                            "type": "object",
+                            "description": "App payload information.",
+                            "properties": {
+                              "code": {
+                                "type": "string",
+                                "description": "URL source of external payment flow."
+                              },
+                              "expiresAt": {
+                                "type": "string",
+                                "description": "Payment flow expiration date in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format (`YYYY-MM-DDThh:mm:ss.fff`)."
+                              },
+                              "paymentId": {
+                                "type": "string",
+                                "description": "Payment identifier at VTEX."
+                              },
+                              "transactionId": {
+                                "type": "string",
+                                "description": "Transaction ID."
+                              }
+                            }
+                          }
+                        }
+                      }
+                    }
+                  }
+                },
+                "example": {
+                  "RedirectResponseCollection": [
+                    {
+                      "redirectUrl": "https://bacen.pix/pix/…"
+                    }
+                  ],
+                  "paymentAuthorizationAppCollection": [
+                    {
+                      "appName": "vtex.pix-payment",
+                      "appPayload": {
+                        "code": "https://bacen.pix/pix/…",
+                        "expiresAt": "2023-07-12 14:18:11Z",
+                        "paymentId": "7AA33BDE370746839F2F8C5F13FE1D84",
+                        "transactionId": "7CEA6AD624D54F07825D37EDEAA746ED"
+                      }
+                    }
+                  ]
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "operationId": {
+                      "type": "string",
+                      "description": "Operation ID."
+                    },
+                    "error": {
+                      "type": "object",
+                      "description": "Information on the error.",
+                      "properties": {
+                        "code": {
+                          "type": "string",
+                          "description": "Error code."
+                        },
+                        "message": {
+                          "type": "string",
+                          "description": "Error message."
+                        },
+                        "exception": {
+                          "type": "string",
+                          "description": "Error exception.",
+                          "nullable": true
+                        }
+                      }
+                    }
+                  }
+                },
+                "example": {
+                  "operationId": "a231ed11-255b-4ea0-96c3-1790e1b27f7e",
+                  "error": {
+                    "code": "001",
+                    "message": "Seu pagamento não foi autorizado. Falha ao enviar os dados de pagamento. Favor entrar em contato com o SAC ou utilizar outra forma de pagamento. *** ",
+                    "exception": null
+                  }
+                }
+              }
+            }
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/api/checkout/pub/regions/{regionId}": {
+      "get": {
+        "tags": [
+          "Region"
+        ],
+        "summary": "Get sellers by region or address",
+        "description": "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).\n\r\n\rTo access the list of sellers, you must choose one of the following methods:\n\r\n\r1. Send the identification of the list of sellers (`regionId`) as a path parameter through the URL. Or;\n\r2. 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.\n\r\n\r> 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.\r\n\r\n## Permissions\r\n\r\nAny user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Shopping Cart Full Access** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.",
+        "operationId": "GetSellersByRegion",
+        "security": [],
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "regionId",
+            "in": "path",
+            "description": "ID of the region corresponding to the shopper's location.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "v2.1BB18CE648B5111D0933734ED83EC783"
+            }
+          },
+          {
+            "name": "country",
+            "in": "query",
+            "description": "Three letter country code refering to the `postalCode` field.",
+            "required": true,
+            "style": "form",
+            "schema": {
+              "type": "string",
+              "example": "BRA"
+            }
+          },
+          {
+            "name": "postalCode",
+            "in": "query",
+            "description": "Postal code corresponding to the shopper's location.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "string",
+              "example": "1234000"
+            }
+          },
+          {
+            "name": "geoCoordinates",
+            "in": "query",
+            "description": "Geocoordinates (first longitude, semicolon, then latitude) corresponding to the shopper's location.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "array",
+              "example": [
+                -47.924747467041016,
+                -15.832582473754883
+              ],
+              "items": {
+                "description": "Geocoordinates.",
+                "type": "number",
+                "example": -47.924747467041016
+              }
+            }
+          },
+          {
+            "name": "individualShippingEstimates",
+            "in": "query",
+            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "boolean",
+              "example": true
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "type": "string",
+                      "description": "Region ID."
+                    },
+                    "sellers": {
+                      "type": "array",
+                      "description": "Array with information on each seller retrieved for the given region.",
+                      "items": {
+                        "description": "Seller information.",
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "Seller ID."
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "Seller name."
+                          },
+                          "logo": {
+                            "type": "string",
+                            "description": "Seller logo.",
+                            "nullable": true
+                          }
+                        }
+                      }
+                    }
+                  }
+                },
+                "example": {
+                  "id": "v2.1BB18CE648B5111D0933734ED83EC783",
+                  "sellers": [
+                    {
+                      "id": "abacaba",
+                      "name": "Abacaba Store",
+                      "logo": null
+                    },
+                    {
+                      "id": "abacaba2",
+                      "name": "Abacaba VTEX Outlet",
+                      "logo": null
+                    },
+                    {
+                      "id": "abacaba3",
+                      "name": "Abacaba VTEX Mall",
+                      "logo": null
+                    }
+                  ]
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "components": {
+    "schemas": {
+      "orderForm": {
+        "type": "object",
+        "properties": {
+          "orderFormId": {
+            "type": "string",
+            "description": "ID of the orderForm corresponding to a specific cart."
+          },
+          "salesChannel": {
+            "type": "string",
+            "description": "Attribute created by the seller, in their VTEX store configuration."
+          },
+          "loggedIn": {
+            "type": "boolean",
+            "description": "Indicates whether the user is logged into the store."
+          },
+          "isCheckedIn": {
+            "type": "boolean",
+            "description": "Indicates whether order is checked in."
+          },
+          "storeId": {
+            "type": "string",
+            "description": "ID of the store.",
+            "nullable": true
+          },
+          "allowManualPrice": {
+            "type": "boolean",
+            "description": "Permission to modify item price manually."
+          },
+          "canEditData": {
+            "type": "boolean",
+            "description": "Data can be edited."
+          },
+          "userProfileId": {
+            "type": "string",
+            "description": "Unique ID associated with the customer profile."
+          },
+          "profileProvider": {
+            "type": "string",
+            "description": "Profile provider."
+          },
+          "availableAccounts": {
+            "type": "array",
+            "description": "Available accounts.",
+            "items": {
+              "type": "string",
+              "description": "Account."
+            }
+          },
+          "availableAddresses": {
+            "type": "array",
+            "description": "Information on each available address.",
+            "items": {
+              "description": "Address information.",
+              "type": "object",
+              "properties": {
+                "addressType": {
+                  "type": "string",
+                  "description": "Address type."
+                },
+                "receiverName": {
+                  "type": "string",
+                  "description": "Name of the receiver."
+                },
+                "addressId": {
+                  "type": "string",
+                  "description": "Address ID.",
+                  "nullable": true
+                },
+                "isDisposable": {
+                  "type": "boolean",
+                  "description": "Indicates whether address is disposable."
+                },
+                "city": {
+                  "type": "string",
+                  "description": "City of the address."
+                },
+                "state": {
+                  "type": "string",
+                  "description": "State of the address."
+                },
+                "country": {
+                  "type": "string",
+                  "description": "Country of the address. ISO three-letter code."
+                },
+                "street": {
+                  "type": "string",
+                  "description": "Street of the address."
+                },
+                "number": {
+                  "type": "string",
+                  "description": "Number of the address."
+                },
+                "neighborhood": {
+                  "type": "string",
+                  "description": "Neighborhood of the address."
+                },
+                "complement": {
+                  "description": "Complement to the shipping address, in case it applies.",
+                  "type": "string",
+                  "nullable": true
+                },
+                "reference": {
+                  "type": "string",
+                  "description": "Reference that may help in the location of the address.",
+                  "nullable": true
+                },
+                "geoCoordinates": {
+                  "type": "array",
+                  "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                  "items": {
+                    "type": "number",
+                    "description": "Geocoordinates."
+                  }
+                }
+              }
+            }
+          },
+          "userType": {
+            "type": "string",
+            "description": "User type.",
+            "nullable": true
+          },
+          "ignoreProfileData": {
+            "type": "boolean",
+            "description": "Ignore customer profile data."
+          },
+          "value": {
+            "type": "integer",
+            "description": "Total value of the order without separating cents. For example, $24.99 is represented as `2499`."
+          },
+          "messages": {
+            "type": "array",
+            "description": "Array containing an object for each message generated by our servers while processing the request.",
+            "items": {
+              "type": "string",
+              "description": "Message."
+            }
+          },
+          "items": {
+            "type": "array",
+            "description": "Information on each item in the order.",
+            "items": {
+              "description": "Item information.",
+              "type": "object",
+              "properties": {
+                "uniqueId": {
+                  "type": "string",
+                  "description": "Unique ID."
+                },
+                "id": {
+                  "type": "string",
+                  "description": "ID of the item."
+                },
+                "productId": {
+                  "type": "string",
+                  "description": "Product ID."
+                },
+                "productRefId": {
+                  "type": "string",
+                  "description": "Product Ref ID."
+                },
+                "refId": {
+                  "type": "string",
+                  "description": "Ref ID."
+                },
+                "ean": {
+                  "type": "string",
+                  "description": "European Article Number.",
+                  "nullable": true
+                },
+                "name": {
+                  "type": "string",
+                  "description": "Product name."
+                },
+                "skuName": {
+                  "type": "string",
+                  "description": "SKU name."
+                },
+                "modalType": {
+                  "type": "string",
+                  "description": "Modal type.",
+                  "nullable": true
+                },
+                "parentItemIndex": {
+                  "type": "integer",
+                  "description": "Parent item index.",
+                  "nullable": true
+                },
+                "parentAssemblyBinding": {
+                  "type": "string",
+                  "description": "Parent assembly binding.",
+                  "nullable": true
+                },
+                "priceValidUntil": {
+                  "type": "string",
+                  "description": "Price expiration date and time."
+                },
+                "tax": {
+                  "type": "integer",
+                  "description": "Tax value in cents."
+                },
+                "taxCode": {
+                  "type": "string",
+                  "description": "A unique identifier code assigned to a tax within the VTEX Admin."
+                },
+                "price": {
+                  "type": "integer",
+                  "description": "Price in cents."
+                },
+                "listPrice": {
+                  "type": "integer",
+                  "description": "List price in cents."
+                },
+                "manualPrice": {
+                  "type": "integer",
+                  "description": "Manual price in cents.",
+                  "nullable": true
+                },
+                "manualPriceAppliedBy": {
+                  "type": "string",
+                  "description": "User that applied the manual price, if that is the case.",
+                  "nullable": true
+                },
+                "sellingPrice": {
+                  "type": "integer",
+                  "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
+                },
+                "rewardValue": {
+                  "type": "integer",
+                  "description": "Reward value in cents."
+                },
+                "isGift": {
+                  "type": "boolean",
+                  "description": "Indicates whether item is a gift."
+                },
+                "additionalInfo": {
+                  "type": "object",
+                  "description": "Additional information.",
+                  "properties": {
+                    "dimension": {
+                      "type": "string",
+                      "description": "Dimension.",
+                      "nullable": true
+                    },
+                    "brandName": {
+                      "type": "string",
+                      "description": "Brand name."
+                    },
+                    "brandId": {
+                      "type": "string",
+                      "description": "Brand ID."
+                    },
+                    "offeringInfo": {
+                      "type": "string",
+                      "description": "Offering information.",
+                      "nullable": true
+                    },
+                    "offeringType": {
+                      "type": "string",
+                      "description": "Offering type.",
+                      "nullable": true
+                    },
+                    "offeringTypeId": {
+                      "type": "string",
+                      "description": "Offering type ID.",
+                      "nullable": true
+                    }
+                  }
+                },
+                "preSaleDate": {
+                  "type": "string",
+                  "description": "Presale date.",
+                  "nullable": true
+                },
+                "productCategoryIds": {
+                  "type": "string",
+                  "description": "Product category IDs."
+                },
+                "productCategories": {
+                  "type": "object",
+                  "description": "Object, where each field is an ID from `productCategoryIds`.",
+                  "properties": {
+                    "{ID}": {
+                      "type": "string",
+                      "description": "Product category corresponding to the ID in the field key."
+                    }
+                  }
+                },
+                "quantity": {
+                  "type": "integer",
+                  "description": "Quantity."
+                },
+                "seller": {
+                  "type": "string",
+                  "description": "Seller."
+                },
+                "sellerChain": {
+                  "type": "array",
+                  "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
+                  "items": {
+                    "type": "string",
+                    "description": "Seller."
+                  }
+                },
+                "imageUrl": {
+                  "type": "string",
+                  "description": "Image URL."
+                },
+                "detailUrl": {
+                  "type": "string",
+                  "description": "Detail URL."
+                },
+                "bundleItems": {
+                  "type": "array",
+                  "description": "Information on services sold along with the SKU. Example: a gift package.",
+                  "items": {
+                    "description": "Service information.",
+                    "type": "object",
+                    "properties": {
+                      "type": {
+                        "type": "string",
+                        "description": "Service type."
+                      },
+                      "id": {
+                        "type": "integer",
+                        "description": "Service identifier."
+                      },
+                      "name": {
+                        "type": "string",
+                        "description": "Service name."
+                      },
+                      "price": {
+                        "type": "integer",
+                        "description": "Service price in cents."
+                      }
+                    }
+                  }
+                },
+                "attachments": {
+                  "type": "array",
+                  "description": "Array containing information on attachments.",
+                  "items": {
+                    "type": "string",
+                    "description": "Attachment."
+                  }
+                },
+                "priceTags": {
+                  "type": "array",
+                  "description": "Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.",
+                  "items": {
+                    "description": "Price tag information.",
+                    "type": "object",
+                    "properties": {
+                      "identifier": {
+                        "type": "string",
+                        "description": "Promotion unique identifier.",
+                        "nullable": true
+                      },
+                      "isPercentual": {
+                        "type": "boolean",
+                        "description": "Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly."
+                      },
+                      "name": {
+                        "type": "string",
+                        "description": "Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:\r\n- `type` indicates whether the tag refers to a discount or tax.\r\n- `where` specifies the context, either price or shipping.\r\n- `identifier` is the promotion ID.\r\n- `calculationId` is a hash that may vary with each price calculation."
+                      },
+                      "rawValue": {
+                        "type": "number",
+                        "description": "Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations."
+                      },
+                      "value": {
+                        "type": "integer",
+                        "description": "Price tag value representing either a promotion (value decrease) or a tax (value increase)."
+                      }
+                    }
+                  }
+                },
+                "availability": {
+                  "type": "string",
+                  "description": "Availability."
+                },
+                "measurementUnit": {
+                  "type": "string",
+                  "description": "Measurement unit."
+                },
+                "unitMultiplier": {
+                  "type": "integer",
+                  "description": "Unit multiplier."
+                },
+                "manufacturerCode": {
+                  "type": "string",
+                  "description": "Manufacturer code.",
+                  "nullable": true
+                },
+                "priceDefinition": {
+                  "type": "object",
+                  "description": "Price information for all units of a specific item.",
+                  "properties": {
+                    "calculatedSellingPrice": {
+                      "type": "integer",
+                      "description": "Item's calculated unitary selling price in cents."
+                    },
+                    "total": {
+                      "type": "integer",
+                      "description": "Total value for all units of the item in cents."
+                    },
+                    "sellingPrices": {
+                      "type": "array",
+                      "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
+                      "items": {
+                        "description": "Rounding information.",
+                        "type": "object",
+                        "properties": {
+                          "value": {
+                            "type": "integer",
+                            "description": "Value in cents for that specific rounding."
+                          },
+                          "quantity": {
+                            "type": "integer",
+                            "description": "Rounding quantity, meaning how many items are rounded to this value."
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "selectableGifts": {
+            "type": "array",
+            "description": "Array containing the data of the item selected as a gift.",
+            "items": {
+              "type": "string",
+              "description": "Gift."
+            }
+          },
+          "totalizers": {
+            "type": "array",
+            "description": "Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).",
+            "items": {
+              "type": "object",
+              "description": "Totalizer of purchases."
+            }
+          },
+          "shippingData": {
+            "type": "object",
+            "description": "Shipping information pertinent to the order.",
+            "nullable": true,
+            "properties": {
+              "address": {
+                "type": "object",
+                "description": "Address information.",
+                "nullable": true,
+                "properties": {
+                  "addressType": {
+                    "type": "string",
+                    "description": "Type of address. For example, `Residential` or `Pickup`."
+                  },
+                  "receiverName": {
+                    "type": "string",
+                    "description": "Name of the person who is going to receive the order."
+                  },
+                  "addressId": {
+                    "type": "string",
+                    "description": "Address ID.",
+                    "nullable": true
+                  },
+                  "isDisposable": {
+                    "type": "boolean",
+                    "description": "Indicates whether address is disposable."
+                  },
+                  "postalCode": {
+                    "type": "string",
+                    "description": "Postal code."
+                  },
+                  "city": {
+                    "type": "string",
+                    "description": "City of the shipping address."
+                  },
+                  "state": {
+                    "type": "string",
+                    "description": "State of the shipping address."
+                  },
+                  "country": {
+                    "type": "string",
+                    "description": "Three letter ISO code of the country of the shipping address."
+                  },
+                  "street": {
+                    "type": "string",
+                    "description": "Street of the shipping address."
+                  },
+                  "number": {
+                    "type": "string",
+                    "description": "Number of the building, house or apartment in the shipping address."
+                  },
+                  "neighborhood": {
+                    "type": "string",
+                    "description": "Neighborhood of the shipping address."
+                  },
+                  "complement": {
+                    "type": "string",
+                    "description": "Complement to the shipping address, in case it applies.",
+                    "nullable": true
+                  },
+                  "reference": {
+                    "type": "string",
+                    "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                    "nullable": true
+                  },
+                  "geoCoordinates": {
+                    "type": "array",
+                    "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                    "items": {
+                      "type": "number",
+                      "description": "Geocoordinates."
+                    }
+                  }
+                }
+              },
+              "logisticsInfo": {
+                "type": "array",
+                "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.",
+                "items": {
+                  "description": "Logistics information.",
+                  "type": "object",
+                  "properties": {
+                    "itemIndex": {
+                      "type": "integer",
+                      "description": "Index corresponding to the position of the object in the `items` array."
+                    },
+                    "selectedSla": {
+                      "type": "string",
+                      "description": "SLA selected by the customer.",
+                      "nullable": true
+                    },
+                    "selectedDeliveryChannel": {
+                      "type": "string",
+                      "description": "Delivery channel selected by the customer.",
+                      "nullable": true
+                    },
+                    "addressId": {
+                      "type": "string",
+                      "description": "Address ID.",
+                      "nullable": true
+                    },
+                    "slas": {
+                      "type": "array",
+                      "description": "Information on available SLAs.",
+                      "items": {
+                        "description": "SLA information.",
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "SLA ID."
+                          },
+                          "deliveryChannel": {
+                            "type": "string",
+                            "description": "Delivery channel."
+                          },
+                          "name": {
+                            "type": "string",
+                            "description": "SLA name."
+                          },
+                          "deliveryIds": {
+                            "type": "array",
+                            "description": "Information on each delivery ID.",
+                            "items": {
+                              "description": "Delivery ID information.",
+                              "type": "object",
+                              "properties": {
+                                "courierId": {
+                                  "type": "string",
+                                  "description": "Courier ID."
+                                },
+                                "warehouseId": {
+                                  "type": "string",
+                                  "description": "Warehouse ID."
+                                },
+                                "dockId": {
+                                  "type": "string",
+                                  "description": "Warehouse ID."
+                                },
+                                "courierName": {
+                                  "type": "string",
+                                  "description": "Courier name."
+                                },
+                                "quantity": {
+                                  "type": "integer",
+                                  "description": "Quantity."
+                                }
+                              }
+                            }
+                          },
+                          "attachmentOfferings": {
+                            "type": "array",
+                            "description": "List of attachments details.",
+                            "nullable": true,
+                            "items": {
+                              "description": "Attachment details.",
+                              "type": "object",
+                              "required": [
+                                "name",
+                                "required",
+                                "schema"
+                              ],
+                              "properties": {
+                                "name": {
+                                  "type": "string",
+                                  "description": "Name of the attachment.",
+                                  "nullable": true
+                                },
+                                "required": {
+                                  "type": "boolean",
+                                  "description": "Defines if the attachment is required (`true`) or not (`false`).",
+                                  "nullable": true
+                                },
+                                "schema": {
+                                  "type": "object",
+                                  "description": "Custom values [created into attachment](https://help.vtex.com/en/tutorial/adding-an-attachment--7zHMUpuoQE4cAskqEUWScU).",
+                                  "nullable": true
+                                }
+                              }
+                            }
+                          },
+                          "shippingEstimate": {
+                            "type": "string",
+                            "description": "Shipping estimate. For instance, \"three business days\" will be represented as `3bd`."
+                          },
+                          "shippingEstimateDate": {
+                            "type": "string",
+                            "description": "When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.",
+                            "nullable": true
+                          },
+                          "useIndividualShippingEstimates": {
+                            "type": "boolean",
+                            "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`."
+                          },
+                          "lockTTL": {
+                            "type": "string",
+                            "description": "Estimate date of delivery.",
+                            "nullable": true
+                          },
+                          "price": {
+                            "type": "integer",
+                            "description": "Price in cents."
+                          },
+                          "listPrice": {
+                            "type": "integer",
+                            "description": "List price in cents."
+                          },
+                          "tax": {
+                            "type": "integer",
+                            "description": "Tax in cents."
+                          },
+                          "pickupStoreInfo": {
+                            "type": "object",
+                            "description": "Information on the pickup store.",
+                            "properties": {
+                              "isPickupStore": {
+                                "type": "boolean",
+                                "description": "Indicates whether it is the pickup store."
+                              },
+                              "friendlyName": {
+                                "type": "string",
+                                "description": "Friendly name.",
+                                "nullable": true
+                              },
+                              "address": {
+                                "type": "object",
+                                "description": "Address information.",
+                                "nullable": true,
+                                "properties": {
+                                  "addressType": {
+                                    "type": "string",
+                                    "description": "Type of address. For example, `Residential` or `Pickup`."
+                                  },
+                                  "postalCode": {
+                                    "type": "string",
+                                    "description": "Postal code."
+                                  },
+                                  "city": {
+                                    "type": "string",
+                                    "description": "City of the shipping address."
+                                  },
+                                  "state": {
+                                    "type": "string",
+                                    "description": "State of the shipping address."
+                                  },
+                                  "country": {
+                                    "type": "string",
+                                    "description": "Three letter ISO code of the country of the shipping address."
+                                  },
+                                  "street": {
+                                    "type": "string",
+                                    "description": "Street of the shipping address."
+                                  },
+                                  "number": {
+                                    "type": "string",
+                                    "description": "Number of the building, house or apartment in the shipping address."
+                                  },
+                                  "neighborhood": {
+                                    "type": "string",
+                                    "description": "Neighborhood of the shipping address."
+                                  },
+                                  "complement": {
+                                    "type": "string",
+                                    "description": "Complement to the shipping address, in case it applies.",
+                                    "nullable": true
+                                  },
+                                  "reference": {
+                                    "type": "string",
+                                    "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                                    "nullable": true
+                                  },
+                                  "geoCoordinates": {
+                                    "type": "array",
+                                    "description": "Array with two strings that repesent geocoordinates: first latitude, then longitude.",
+                                    "items": {
+                                      "type": "number",
+                                      "description": "Geocoordinates."
+                                    }
+                                  }
+                                }
+                              },
+                              "additionalInfo": {
+                                "type": "string",
+                                "description": "Additional information.",
+                                "nullable": true
+                              },
+                              "dockId": {
+                                "type": "string",
+                                "description": "Corresponding dock ID.",
+                                "nullable": true
+                              }
+                            }
+                          },
+                          "pickupPointId": {
+                            "type": "string",
+                            "description": "Pickup point ID.",
+                            "nullable": true
+                          },
+                          "pickupDistance": {
+                            "type": "integer",
+                            "description": "Pickup point distance."
+                          },
+                          "polygonName": {
+                            "type": "string",
+                            "description": "Polygon name.",
+                            "nullable": true
+                          },
+                          "transitTime": {
+                            "type": "string",
+                            "description": "Transit time. For instance, \"three business days\" is represented as `3bd`."
+                          }
+                        }
+                      }
+                    },
+                    "shipsTo": {
+                      "type": "array",
+                      "description": "List of countries that the item may be shipped to.",
+                      "items": {
+                        "type": "string",
+                        "description": "Three letter country code."
+                      }
+                    },
+                    "itemId": {
+                      "type": "string",
+                      "description": "Item ID."
+                    },
+                    "deliveryChannels": {
+                      "type": "array",
+                      "description": "List of available delivery channels.",
+                      "items": {
+                        "description": "Delivery channel information.",
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "Delivery channel ID."
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              },
+              "selectedAddresses": {
+                "type": "array",
+                "description": "Array with information on the selected addresses for the order.",
+                "items": {
+                  "description": "Selected address information.",
+                  "type": "object",
+                  "properties": {
+                    "addressType": {
+                      "type": "string",
+                      "description": "Type of address. For example, `Residential` or `Pickup`."
+                    },
+                    "receiverName": {
+                      "type": "string",
+                      "description": "Name of the person who is going to receive the order."
+                    },
+                    "addressId": {
+                      "type": "string",
+                      "description": "Address ID.",
+                      "nullable": true
+                    },
+                    "isDisposable": {
+                      "type": "boolean",
+                      "description": "Indicates whether address is disposable."
+                    },
+                    "postalCode": {
+                      "type": "string",
+                      "description": "Postal code."
+                    },
+                    "city": {
+                      "type": "string",
+                      "description": "City of the shipping address."
+                    },
+                    "state": {
+                      "type": "string",
+                      "description": "State of the shipping address."
+                    },
+                    "country": {
+                      "type": "string",
+                      "description": "Three letter ISO code of the country of the shipping address."
+                    },
+                    "street": {
+                      "type": "string",
+                      "description": "Street of the shipping address."
+                    },
+                    "number": {
+                      "type": "string",
+                      "description": "Number of the building, house or apartment in the shipping address."
+                    },
+                    "neighborhood": {
+                      "type": "string",
+                      "description": "Neighborhood of the shipping address."
+                    },
+                    "complement": {
+                      "type": "string",
+                      "description": "Complement to the shipping address, in case it applies.",
+                      "nullable": true
+                    },
+                    "reference": {
+                      "type": "string",
+                      "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                      "nullable": true
+                    },
+                    "geoCoordinates": {
+                      "type": "array",
+                      "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                      "items": {
+                        "type": "number",
+                        "description": "Geocoordinates."
+                      }
+                    }
+                  }
+                }
+              },
+              "availableAddresses": {
+                "type": "array",
+                "description": "Array with information on the available addresses for the order.",
+                "items": {
+                  "description": "Available address information.",
+                  "type": "object",
+                  "properties": {
+                    "addressType": {
+                      "type": "string",
+                      "description": "Type of address. For example, `Residential` or `Pickup`."
+                    },
+                    "receiverName": {
+                      "type": "string",
+                      "description": "Name of the person who is going to receive the order."
+                    },
+                    "addressId": {
+                      "type": "string",
+                      "description": "Address ID.",
+                      "nullable": true
+                    },
+                    "isDisposable": {
+                      "type": "boolean",
+                      "description": "Indicates whether address is disposable."
+                    },
+                    "postalCode": {
+                      "type": "string",
+                      "description": "Postal code."
+                    },
+                    "city": {
+                      "type": "string",
+                      "description": "City of the shipping address."
+                    },
+                    "state": {
+                      "type": "string",
+                      "description": "State of the shipping address."
+                    },
+                    "country": {
+                      "type": "string",
+                      "description": "Three letter ISO code of the country of the shipping address."
+                    },
+                    "street": {
+                      "type": "string",
+                      "description": "Street of the shipping address."
+                    },
+                    "number": {
+                      "type": "string",
+                      "description": "Number of the building, house or apartment in the shipping address."
+                    },
+                    "neighborhood": {
+                      "type": "string",
+                      "description": "Neighborhood of the shipping address."
+                    },
+                    "complement": {
+                      "type": "string",
+                      "description": "Complement to the shipping address, in case it applies.",
+                      "nullable": true
+                    },
+                    "reference": {
+                      "type": "string",
+                      "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
+                      "nullable": true
+                    },
+                    "geoCoordinates": {
+                      "type": "array",
+                      "description": "Array with two strings that represent geocoordinates: first latitude, then longitude.",
+                      "items": {
+                        "type": "number",
+                        "description": "Geocoordinates."
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "clientProfileData": {
+            "type": "object",
+            "description": "Customer's profile information.",
+            "nullable": true,
+            "properties": {
+              "email": {
+                "type": "string",
+                "description": "Email address.",
+                "nullable": true
+              },
+              "firstName": {
+                "type": "string",
+                "description": "First name.",
+                "nullable": true
+              },
+              "lastName": {
+                "type": "string",
+                "description": "Last name."
+              },
+              "documentType": {
+                "type": "string",
+                "description": "Type of the document informed by the customer."
+              },
+              "document": {
+                "type": "string",
+                "description": "Document informed by the customer."
+              },
+              "phone": {
+                "type": "string",
+                "description": "Phone number."
+              },
+              "corporateName": {
+                "type": "string",
+                "description": "Company name, if the customer is a legal entity.",
+                "nullable": true
+              },
+              "tradeName": {
+                "type": "string",
+                "description": "Trade name, if the customer is a legal entity.",
+                "nullable": true
+              },
+              "corporateDocument": {
+                "type": "string",
+                "description": "Corporate document, if the customer is a legal entity.",
+                "nullable": true
+              },
+              "stateInscription": {
+                "type": "string",
+                "description": "State inscription, if the customer is a legal entity.",
+                "nullable": true
+              },
+              "corporatePhone": {
+                "type": "string",
+                "description": "Corporate phone number, if the customer is a legal entity.",
+                "nullable": true
+              },
+              "isCorporate": {
+                "type": "boolean",
+                "description": "Indicates whether the customer is a legal entity."
+              },
+              "profileCompleteOnLoading": {
+                "type": "boolean",
+                "description": "Indicates whether profile is complete on loading."
+              },
+              "profileErrorOnLoading": {
+                "type": "boolean",
+                "description": "Indicates whether profile presents error on loading.",
+                "nullable": true
+              },
+              "customerClass": {
+                "type": "string",
+                "description": "Customer class.",
+                "nullable": true
+              }
+            }
+          },
+          "paymentData": {
+            "type": "object",
+            "description": "Information on the order's payment.",
+            "properties": {
+              "giftCards": {
+                "type": "array",
+                "description": "Gift card information, if it applies to the order.",
+                "items": {
+                  "description": "Gift card information.",
+                  "type": "object",
+                  "properties": {
+                    "redemptionCode": {
+                      "type": "string",
+                      "description": "Gift card redemption code."
+                    },
+                    "value": {
+                      "type": "integer",
+                      "description": "Gift card value in cents."
+                    },
+                    "balance": {
+                      "type": "integer",
+                      "description": "Gift card balance in cents."
+                    },
+                    "name": {
+                      "type": "string",
+                      "description": "Gift card name."
+                    },
+                    "id": {
+                      "type": "string",
+                      "description": "Gift card ID."
+                    },
+                    "inUse": {
+                      "type": "boolean",
+                      "description": "Indicates whether gift card is in use."
+                    },
+                    "isSpecialCard": {
+                      "type": "boolean",
+                      "description": "Indicates whether gift card is special."
+                    }
+                  }
+                }
+              },
+              "transactions": {
+                "type": "array",
+                "description": "Information on each transaction pertinent to the order.",
+                "items": {
+                  "description": "Transaction information.",
+                  "nullable": true,
+                  "type": "object",
+                  "properties": {
+                    "isActive": {
+                      "type": "boolean",
+                      "description": "Indicates whether transaction is active."
+                    },
+                    "transactionId": {
+                      "type": "string",
+                      "description": "Transaction ID."
+                    },
+                    "merchantName": {
+                      "type": "string",
+                      "description": "Merchant name."
+                    },
+                    "payments": {
+                      "type": "array",
+                      "description": "Information on each payment.",
+                      "items": {
+                        "description": "Payment information.",
+                        "type": "object",
+                        "properties": {
+                          "accountId": {
+                            "type": "string",
+                            "description": "Account ID."
+                          },
+                          "bin": {
+                            "type": "string",
+                            "description": "Bin.",
+                            "nullable": true
+                          },
+                          "installments": {
+                            "type": "integer",
+                            "description": "Number of installments."
+                          },
+                          "paymentSystem": {
+                            "type": "string",
+                            "description": "Payment system."
+                          },
+                          "referenceValue": {
+                            "type": "integer",
+                            "description": "Reference value for calculating interest rates, in case it applies. Displayed in cents."
+                          },
+                          "value": {
+                            "type": "integer",
+                            "description": "Value including interest, in case it applies. Displayed in cents."
+                          }
+                        }
+                      }
+                    },
+                    "sharedTransaction": {
+                      "type": "boolean",
+                      "description": "Indicates whather transaction is shared."
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "marketingData": {
+            "type": "object",
+            "nullable": true,
+            "description": "Object containing promotion data such as coupon tracking information and internal or external UTMs.",
+            "properties": {
+              "coupon": {
+                "type": "string",
+                "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.",
+                "example": "free-shipping"
+              },
+              "utmSource": {
+                "type": "string",
+                "description": "UTM source.",
+                "example": "Facebook"
+              },
+              "utmMedium": {
+                "type": "string",
+                "description": "UTM medium.",
+                "example": "CPC"
+              },
+              "utmCampaign": {
+                "type": "string",
+                "description": "UTM campaign.",
+                "example": "Black friday"
+              },
+              "utmiPage": {
+                "type": "string",
+                "description": "utmi_page (internal utm).",
+                "example": "utmi_page-example",
+                "nullable": true
+              },
+              "utmiPart": {
+                "type": "string",
+                "description": "utmi_part (internal utm).",
+                "example": "utmi_part-example",
+                "nullable": true
+              },
+              "utmiCampaign": {
+                "type": "string",
+                "description": "utmi_campaign (internal utm).",
+                "example": "utmi_campaign-example",
+                "nullable": true
+              }
+            }
+          },
+          "sellers": {
+            "type": "array",
+            "description": "Information on each seller.",
+            "items": {
+              "description": "Seller information.",
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "string",
+                  "description": "Seller ID."
+                },
+                "name": {
+                  "type": "string",
+                  "description": "Seller name."
+                },
+                "logo": {
+                  "type": "string",
+                  "description": "Seller logo.",
+                  "nullable": true
+                }
+              }
+            }
+          },
+          "clientPreferencesData": {
+            "type": "object",
+            "description": "Object containing preferences from the client who placed the order.",
+            "properties": {
+              "locale": {
+                "type": "string",
+                "description": "Client's locale. Examples: `pt-BR` and `en-US`."
+              },
+              "optinNewsLetter": {
+                "type": "boolean",
+                "description": "`true` if the client opted to receive newsletter from the store.",
+                "example": false,
+                "nullable": true
+              }
+            }
+          },
+          "commercialConditionData": {
+            "type": "object",
+            "description": "Object containing commercial condition information.",
+            "nullable": true
+          },
+          "storePreferencesData": {
+            "type": "object",
+            "description": "Object containing data from the store's configuration (stored in VTEX's License Manager)."
+          },
+          "giftRegistryData": {
+            "type": "object",
+            "description": "Gift registry list information.",
+            "nullable": true
+          },
+          "openTextField": {
+            "type": "string",
+            "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).",
+            "example": "open-text-example",
+            "nullable": true
+          },
+          "invoiceData": {
+            "type": "object",
+            "nullable": true,
+            "description": "Invoice data including billing address.",
+            "properties": {
+              "address": {
+                "type": "object",
+                "description": "Billing address.",
+                "properties": {
+                  "postalCode": {
+                    "type": "string",
+                    "description": "Postal code."
+                  },
+                  "city": {
+                    "type": "string",
+                    "description": "City name."
+                  },
+                  "state": {
+                    "type": "string",
+                    "description": "State name."
+                  },
+                  "country": {
+                    "type": "string",
+                    "description": "Country."
+                  },
+                  "street": {
+                    "type": "string",
+                    "description": "Street name."
+                  },
+                  "number": {
+                    "type": "string",
+                    "description": "Street number."
+                  },
+                  "neighborhood": {
+                    "type": "string",
+                    "description": "Neighborhood."
+                  },
+                  "complement": {
+                    "type": "string",
+                    "description": "Address complement."
+                  },
+                  "reference": {
+                    "type": "string",
+                    "description": "Reference for location."
+                  },
+                  "geoCoordinates": {
+                    "type": "array",
+                    "description": "Geographic coordinates (latitude, longitude).",
+                    "items": {
+                      "type": "number"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "customData": {
+            "type": "object",
+            "description": "Customer additional information.",
+            "nullable": true
+          },
+          "itemMetadata": {
+            "type": "object",
+            "description": "Item metadata.",
+            "properties": {
+              "items": {
+                "type": "array",
+                "description": "List of objects containing metadata on each item in the order.",
+                "items": {
+                  "description": "Item metadata.",
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "type": "string",
+                      "description": "Item ID."
+                    },
+                    "seller": {
+                      "type": "string",
+                      "description": "Seller."
+                    },
+                    "name": {
+                      "type": "string",
+                      "description": "Product name."
+                    },
+                    "skuName": {
+                      "type": "string",
+                      "description": "SKU name."
+                    },
+                    "productId": {
+                      "type": "string",
+                      "description": "Product ID."
+                    },
+                    "refId": {
+                      "type": "string",
+                      "description": "Ref ID."
+                    },
+                    "ean": {
+                      "type": "string",
+                      "description": "European Article Number.",
+                      "nullable": true
+                    },
+                    "imageUrl": {
+                      "type": "string",
+                      "description": "Image URL."
+                    },
+                    "detailUrl": {
+                      "type": "string",
+                      "description": "Detail URL."
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "hooksData": {
+            "type": "object",
+            "description": "Hooks information.",
+            "nullable": true
+          },
+          "ratesAndBenefitsData": {
+            "type": "object",
+            "description": "Information on rates and benefits that apply to the order.",
+            "properties": {
+              "rateAndBenefitsIdentifiers": {
+                "type": "array",
+                "description": "List with rates and benefits identifiers.",
+                "items": {
+                  "type": "string",
+                  "description": "Benefit identifier."
+                }
+              },
+              "teaser": {
+                "type": "array",
+                "description": "List with rates and benefits teasers.",
+                "items": {
+                  "type": "string",
+                  "description": "Benefit teaser."
+                }
+              }
+            }
+          },
+          "subscriptionData": {
+            "type": "object",
+            "description": "Subscription information.",
+            "nullable": true
+          },
+          "itemsOrdination": {
+            "type": "object",
+            "description": "Object containing information about the ordering of items within the `orderForm`.",
+            "properties": {
+              "criteria": {
+                "type": "string",
+                "description": "Criteria adopted to order the items in the list."
+              },
+              "ascending": {
+                "type": "boolean",
+                "description": "Indicates whether the ordering is ascending."
+              }
+            }
+          }
+        }
+      },
+      "OrderFormSimulationRequest": {
+        "required": [
+          "items",
+          "country"
+        ],
+        "type": "object",
+        "properties": {
+          "items": {
+            "type": "array",
+            "items": {
+              "description": "Information about the SKUs inside the cart to be simulated.",
+              "title": "Item",
+              "required": [
+                "id",
+                "quantity",
+                "seller"
+              ],
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "string",
+                  "description": "The SKU ID."
+                },
+                "quantity": {
+                  "type": "integer",
+                  "format": "int32",
+                  "description": "The quantity of items of this specific SKU in the cart to be simulated."
+                },
+                "seller": {
+                  "type": "string",
+                  "description": "The ID of the seller responsible for this SKU. This ID can be found in your VTEX Admin."
+                }
+              },
+              "example": {
+                "id": "{{skuId}}",
+                "quantity": 1,
+                "seller": "1"
+              }
+            },
+            "description": "Array containing information about the SKUs inside the cart to be simulated."
+          },
+          "country": {
+            "type": "string"
+          }
+        },
+        "example": {
+          "items": [
+            {
+              "id": "{{skuId}}",
+              "quantity": 1,
+              "seller": "1"
+            }
+          ],
+          "country": "{{countryCode-ISO-3-digits}}"
+        }
+      },
+      "Item": {
+        "title": "Item",
+        "required": [
+          "id",
+          "quantity",
+          "seller"
+        ],
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "description": "The SKU ID."
+          },
+          "quantity": {
+            "type": "integer",
+            "format": "int32",
+            "description": "The quantity of items of this specific SKU in the cart to be simulated."
+          },
+          "seller": {
+            "type": "string",
+            "description": "The ID of the seller responsible for this SKU. This ID can be found in your VTEX Admin."
+          }
+        },
+        "example": {
+          "id": "{{skuId}}",
+          "quantity": 1,
+          "seller": "1"
+        }
+      },
+      "PriceChangeRequest": {
+        "required": [
+          "price"
+        ],
+        "type": "object",
+        "properties": {
+          "price": {
+            "type": "integer",
+            "format": "int32",
+            "description": "The new price of the item."
+          }
+        },
+        "example": {
+          "price": 10000
+        }
+      },
+      "SetsinglecustomfieldvalueRequest": {
+        "required": [
+          "value"
+        ],
+        "type": "object",
+        "properties": {
+          "value": {
+            "type": "string",
+            "description": "The value you want to set to the specified field."
+          }
+        }
+      },
+      "UpdateorderFormconfigurationRequest": {
+        "required": [
+          "paymentConfiguration",
+          "taxConfiguration",
+          "minimumQuantityAccumulatedForItems",
+          "decimalDigitsPrecision",
+          "minimumValueAccumulated",
+          "apps",
+          "allowMultipleDeliveries",
+          "allowManualPrice"
+        ],
+        "type": "object",
+        "properties": {
+          "paymentConfiguration": {
+            "title": "PaymentConfiguration",
+            "description": "Payment Configuration object.",
+            "required": [
+              "requiresAuthenticationForPreAuthorizedPaymentOption"
+            ],
+            "type": "object",
+            "properties": {
+              "requiresAuthenticationForPreAuthorizedPaymentOption": {
+                "type": "boolean",
+                "description": "Determines whether pre-authorized payments require authentication."
+              },
+              "allowInstallmentsMerge": {
+                "type": "boolean",
+                "description": "By default (when `false`), on a multi-seller purchase is on the run, a simple intersection with installments options configured by every seller will be available. When `true`, this option allows a more complex but flexible installment option, since it considers max installments of every seller configuration, even if those don't match. Installment values ​​may not be equal in this case."
+              },
+              "blockPaymentSession": {
+                "type": "boolean",
+                "description": "Indicates whether shoppers can add credit cards in your store's `My Account` section."
+              }
+            },
+            "example": {
+              "requiresAuthenticationForPreAuthorizedPaymentOption": false,
+              "allowInstallmentsMerge": false,
+              "blockPaymentSession": false
+            }
+          },
+          "taxConfiguration": {
+            "type": "object",
+            "description": "External tax service configuration.",
+            "nullable": true,
+            "properties": {
+              "url": {
+                "type": "string",
+                "nullable": true,
+                "description": "Endpoint URL."
+              },
+              "authorizationHeader": {
+                "type": "string",
+                "description": "Authorization header.",
+                "nullable": true
+              },
+              "appId": {
+                "type": "string",
+                "description": "Custom data ID sent to the tax system.",
+                "example": "12345"
+              },
+              "isMarketplaceResponsibleForTaxes": {
+                "description": "Indicates whether the marketplace is responsible for the products taxes."
+              }
+            }
+          },
+          "minimumQuantityAccumulatedForItems": {
+            "type": "integer",
+            "format": "int32",
+            "description": "Minimum SKU quantity by cart."
+          },
+          "decimalDigitsPrecision": {
+            "type": "integer",
+            "format": "int32",
+            "description": "Number of price digits."
+          },
+          "minimumValueAccumulated": {
+            "type": "integer",
+            "nullable": true,
+            "description": "Minimum cart value."
+          },
+          "apps": {
+            "type": "array",
+            "nullable": true,
+            "description": "Array of objects containing Apps configuration information.",
+            "items": {
+              "type": "object",
+              "description": "App configuration information.",
+              "properties": {
+                "id": {
+                  "type": "string",
+                  "description": "App ID.",
+                  "example": "birthdayApp"
+                },
+                "fields": {
+                  "type": "array",
+                  "description": "Array of fields available to the app.",
+                  "items": {
+                    "type": "string",
+                    "example": "birthdayField",
+                    "description": "Available field."
+                  }
+                },
+                "major": {
+                  "type": "integer",
+                  "description": "App major version.",
+                  "example": 1
+                }
+              }
+            }
+          },
+          "allowMultipleDeliveries": {
+            "type": "boolean",
+            "nullable": true,
+            "description": "On the same purchase, allows the selection of items from multiple delivery channels."
+          },
+          "allowManualPrice": {
+            "type": "boolean",
+            "nullable": true,
+            "description": "Allows the editing of SKU prices right in the cart."
+          },
+          "maxNumberOfWhiteLabelSellers": {
+            "type": "integer",
+            "description": "Allows the input of a limit of white label sellers involved on the cart."
+          },
+          "maskFirstPurchaseData": {
+            "type": "boolean",
+            "description": "Allows, on a first purchase, masking client's data. It could be useful when a shared cart is used and the client doesn't want to share its data."
+          },
+          "maskStateOnAddress": {
+            "type": "boolean",
+            "description": "If the response body is masked, on a first purchase, this flag causes the state (UF) to be masked. The default behavior is to be masked.",
+            "default": true
+          },
+          "recaptchaValidation": {
+            "type": "string",
+            "nullable": true,
+            "description": "Configures reCAPTCHA validation for the account, defining in which situations the shopper will be prompted to validate a purchase with reCAPTCHA. Learn more about [reCAPTCHA validation for VTEX stores](https://help.vtex.com/tutorial/recaptcha-no-checkout--18Te3oDd7f4qcjKu9jhNzP)\r\n\r\nPossible values are:\r\n\r\n- `\"never\"`: no purchases are validated with reCAPTCHA.\r\n- `null`: no purchases are validated with reCAPTCHA. The same as `never`.\r\n- `\"always\"`: every purchase is validated with reCAPTCHA.\r\n- `\"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.",
+            "example": "vtexCriteria"
+          },
+          "paymentSystemToCheckFirstInstallment": {
+            "type": "string",
+            "description": "If you want to apply a first installment discount to a particular payment system, set this field to that payment system's ID. Learn more: [Configuring a discount for orders prepaid in full](https://help.vtex.com/en/tutorial/configurar-desconto-de-preco-a-vista--7Lfcj9Wb5dpYfA2gKkACIt).",
+            "example": "6"
+          }
+        },
+        "example": {
+          "paymentConfiguration": {
+            "requiresAuthenticationForPreAuthorizedPaymentOption": false
+          },
+          "taxConfiguration": null,
+          "minimumQuantityAccumulatedForItems": 1,
+          "decimalDigitsPrecision": 2,
+          "minimumValueAccumulated": null,
+          "apps": null,
+          "allowMultipleDeliveries": null,
+          "allowManualPrice": null
+        }
+      },
+      "PaymentConfiguration": {
+        "title": "PaymentConfiguration",
+        "description": "Payment Configuration object.",
+        "required": [
+          "requiresAuthenticationForPreAuthorizedPaymentOption"
+        ],
+        "type": "object",
+        "properties": {
+          "requiresAuthenticationForPreAuthorizedPaymentOption": {
+            "type": "boolean",
+            "description": "Determines whether pre-authorized payments require authentication."
+          },
+          "allowInstallmentsMerge": {
+            "type": "boolean",
+            "description": "By default (when `false`), on a multi-seller purchase is on the run, a simple intersection with installments options configured by every seller will be available. When `true`, this option allows a more complex but flexible installment option, since it considers max installments of every seller configuration, even if those don't match. Installment values ​​may not be equal in this case."
+          },
+          "blockPaymentSession": {
+            "type": "boolean",
+            "description": "Indicates whether shoppers can add credit cards in your store's `My Account` section."
+          }
+        },
+        "example": {
+          "requiresAuthenticationForPreAuthorizedPaymentOption": false,
+          "allowInstallmentsMerge": false,
+          "blockPaymentSession": false
+        }
+      },
+      "WaitingTime": {
+        "type": "object",
+        "description": "Object containing the days after order cancelation by a seller.",
+        "required": [
+          "waitingTime"
+        ],
+        "properties": {
+          "waitingTime": {
+            "type": "integer",
+            "description": "Number of days after order cancelation by a seller, during which another seller may be assigned to fulfill the order."
+          }
+        }
+      }
+    },
+    "securitySchemes": {
+      "appKey": {
+        "type": "apiKey",
+        "in": "header",
+        "name": "X-VTEX-API-AppKey",
+        "description": "Unique identifier of the [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys)."
+      },
+      "appToken": {
+        "type": "apiKey",
+        "in": "header",
+        "name": "X-VTEX-API-AppToken",
+        "description": "Secret token of the [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys)."
+      },
+      "VtexIdclientAutCookie": {
+        "type": "apiKey",
+        "in": "header",
+        "name": "VtexIdclientAutCookie",
+        "description": "[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours."
+      }
+    },
+    "parameters": {
+      "Content-Type": {
+        "name": "Content-Type",
+        "in": "header",
+        "description": "Type of the content being sent.",
+        "required": true,
+        "style": "simple",
+        "schema": {
+          "type": "string",
+          "default": "application/json"
+        }
+      },
+      "Accept": {
+        "name": "Accept",
+        "in": "header",
+        "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+        "required": true,
+        "style": "simple",
+        "schema": {
+          "type": "string",
+          "default": "application/json"
+        }
+      },
+      "individualShippingEstimates": {
+        "name": "individualShippingEstimates",
+        "in": "query",
+        "description": "Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.",
+        "required": false,
+        "style": "form",
+        "schema": {
+          "type": "boolean",
+          "example": true
+        }
+      }
+    }
+  },
+  "tags": [
+    {
+      "name": "Shopping cart"
+    },
+    {
+      "name": "Cart attachments"
+    },
+    {
+      "name": "Custom data"
+    },
+    {
+      "name": "Configuration"
+    },
+    {
+      "name": "Fulfillment"
+    },
+    {
+      "name": "Order placement"
+    },
+    {
+      "name": "Region"
+    }
+  ],
+  "security": [
+    {
+      "appKey": [],
+      "appToken": []
+    },
+    {
+      "VtexIdclientAutCookie": []
+    }
+  ]
+}
diff --git a/vtex/utils/openapi/logistics.openapi.json b/vtex/utils/openapi/logistics.openapi.json
index caa7b98a6..27884203d 100644
--- a/vtex/utils/openapi/logistics.openapi.json
+++ b/vtex/utils/openapi/logistics.openapi.json
@@ -12349,4 +12349,4 @@
       "name": "Freight values"
     }
   ]
-}
\ No newline at end of file
+}
diff --git a/vtex/utils/openapi/vcs.openapi.gen.ts b/vtex/utils/openapi/vcs.openapi.gen.ts
index 76183efff..951447922 100644
--- a/vtex/utils/openapi/vcs.openapi.gen.ts
+++ b/vtex/utils/openapi/vcs.openapi.gen.ts
@@ -51,18 +51,6 @@ IsActive?: boolean
  */
 IsStockKeepingUnit?: boolean
 }[]
-/**
- * ID of the `orderForm` corresponding to the cart from which to place the order. This is the same as the `orderFormId` parameter.
- */
-export type ReferenceId = string
-/**
- * `true` if the shopper's data provided during checkout should be saved for future reference.
- */
-export type SavePersonalData = boolean
-/**
- * True if the shopper opted to receive the newsletter.
- */
-export type OptinNewsLetter = boolean
 
 export interface OpenAPI {
 /**
@@ -10329,58 +10317,6 @@ 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`.
- * 
- * 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.
- */
-"GET /api/checkout/pub/orderForm": {
-searchParams: {
-/**
- * Use this query parameter to create a new empty shopping cart.
- */
-forceNewCart?: boolean
-}
-}
-/**
- * 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.
- */
-"GET /api/checkout/pub/orderForm/:orderFormId": {
-searchParams: {
-/**
- * It is possible to use the [Update cart items request](https://developers.vtex.com/vtex-rest-api/reference/cart-update#itemsupdate) so as to allow outdated information in the `orderForm`, which may improve performance in some cases. To guarantee that all cart information is updated, send this request with this parameter as `true`. We recommend doing this in the final stages of the shopping experience, starting from the checkout page.
- */
-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.
- * 
- * **Important**: **Request Body** must always be sent with empty value "{ }" in this endpoint.
- */
-"POST /api/checkout/pub/orderForm/:orderFormId/items/removeAll": {
-/**
- * This object must be empty.
- */
-body: {
-
-}
-response: {
-
 }
 }
 /**
@@ -10394,74 +10330,27 @@ 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).
+ * Retrieve a client's profile information by providing an email address.
  * 
- * **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.
+ * 
If the response body fields are empty, the following situations may have occurred:
  * 
- * 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.
+ * 
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).
  * 
- * 
> This request has a time out of 45 seconds.
+ * >⚠️ 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.
  */
-"POST /api/checkout/pub/orderForm/:orderFormId/items/update": {
+"GET /api/checkout/pub/profiles": {
 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”`.
- */
-allowedOutdatedData?: any[]
-}
-body: {
-/**
- * Avoid split items on cart
- */
-noSplitItem?: boolean
-/**
- * Array containing the cart items. Each object inside this array corresponds to a different item.
- */
-orderItems?: {
-/**
- * The quantity of the item in the cart.
+ * Client's email address to be searched.
  */
-quantity: number
+email: string
 /**
- * The position of the item in the array.
+ * Indicates whether the returned profiles must be complete or not.
  */
-index: number
-}[]
+ensureComplete?: boolean
 }
 response: {
-/**
- * ID of the orderForm corresponding to a specific cart.
- */
-orderFormId?: string
-/**
- * Attribute created by the seller, in their VTEX store configuration.
- */
-salesChannel?: string
-/**
- * Indicates whether the user is logged into the store.
- */
-loggedIn?: boolean
-/**
- * Indicates whether order is checked in.
- */
-isCheckedIn?: boolean
-/**
- * ID of the store.
- */
-storeId?: (null | string)
-/**
- * Permission to modify item price manually.
- */
-allowManualPrice?: boolean
-/**
- * Data can be edited.
- */
-canEditData?: boolean
 /**
  * Unique ID associated with the customer profile.
  */
@@ -10527,7200 +10416,217 @@ complement?: (null | string)
  */
 reference?: (null | string)
 /**
- * List with the two geocoordinates.
+ * Array containing two floats with geocoordinates, first longitude, then latitude.
  */
-geoCoordinates?: string[]
+geoCoordinates?: number[]
 }[]
 /**
- * User type.
+ * Customer profile information.
  */
-userType?: (null | string)
+userProfile?: {
 /**
- * Ignore customer profile data.
+ * Email address.
  */
-ignoreProfileData?: boolean
+email?: string
 /**
- * Total value of the order without separating cents. For example, $24.99 is represented as `2499`.
+ * First name.
  */
-value?: number
+firstName?: string
 /**
- * Array containing an object for each message generated by our servers while processing the request.
+ * Last name.
  */
-messages?: any[]
+lastName?: string
 /**
- * Information on each item in the order.
+ * Document.
  */
-items?: {
+document?: string
 /**
- * Unique ID.
+ * Document type.
  */
-uniqueId?: string
+documentType?: string
 /**
- * ID of the item.
+ * Telephone number.
  */
-id?: string
+phone?: string
 /**
- * Product ID.
+ * Name of the company. Used for corporate clients.
  */
-productId?: string
+corporateName?: (null | string)
 /**
- * Product Ref ID.
+ * Trade name. Used for corporate clients.
  */
-productRefId?: string
+tradeName?: (null | string)
 /**
- * Ref ID.
+ * Document. Used for corporate clients.
  */
-refId?: string
+corporateDocument?: (null | string)
 /**
- * European Article Number.
+ * State inscription. Used for corporate clients.
  */
-ean?: (null | string)
+stateInscription?: (null | string)
 /**
- * Product name.
+ * Telephone number. Used for corporate clients.
  */
-name?: string
+corporatePhone?: (null | string)
 /**
- * SKU name.
+ * Indicates whether client is corporate.
  */
-skuName?: string
+isCorporate?: boolean
 /**
- * Modal type.
+ * Profile complete when loading.
  */
-modalType?: (null | string)
+profileCompleteOnLoading?: (null | string)
 /**
- * Parent item index.
+ * Profile error when loading.
  */
-parentItemIndex?: (null | number)
+profileErrorOnLoading?: (null | string)
 /**
- * Parent assembly binding.
+ * Customer class.
  */
-parentAssemblyBinding?: (null | string)
+customerClass?: (null | string)
+}
 /**
- * Price expiration date and time.
+ * Indicates whether customer profile is complete.
  */
-priceValidUntil?: string
+isComplete?: boolean
+}
+}
 /**
- * Tax value in cents.
+ * 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.
  */
-tax?: number
+"GET /api/checkout/pvt/configuration/orderForm": {
+response: {
 /**
- * A unique identifier code assigned to a tax within the VTEX Admin.
+ * Payment configuration information.
  */
-taxCode?: string
+paymentConfiguration?: {
 /**
- * Price in cents.
+ * Determines whether pre-authorized payments require authentication.
  */
-price?: number
+requiresAuthenticationForPreAuthorizedPaymentOption?: boolean
 /**
- * List price in cents.
+ * By default (when `false`), on a multi-seller purchase is on the run, a simple intersection with installment options configured by every seller will be available. When indicated as `true`, this option allows a more complex but flexible installment option, since it considers max installments of every seller configuration, even if those do not match. Installment values may not be equal in this case.
  */
-listPrice?: number
+allowInstallmentsMerge?: boolean
+}
 /**
- * Manual price in cents.
+ * External tax service configuration information.
  */
-manualPrice?: (null | number)
+taxConfiguration?: (null | {
 /**
- * User that applied the manual price, if that is the case.
+ * Endpoint URL.
  */
-manualPriceAppliedBy?: (null | string)
+url?: (null | string)
 /**
- * Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
+ * Authorization header.
  */
-sellingPrice?: number
+authorizationHeader?: (null | string)
 /**
- * Reward value in cents.
+ * Custom data ID sent to the tax system.
  */
-rewardValue?: number
+appId?: string
+})
 /**
- * Indicates whether item is a gift.
+ * Minimum SKU quantity by cart.
  */
-isGift?: boolean
+minimumQuantityAccumulatedForItems?: number
 /**
- * Additional information.
+ * Number of price digits.
  */
-additionalInfo?: {
+decimalDigitsPrecision?: number
 /**
- * Dimension.
+ * Minimum cart value.
  */
-dimension?: (null | string)
+minimumValueAccumulated?: (null | number)
 /**
- * Brand name.
+ * Array of objects containing Apps configuration information.
  */
-brandName?: string
+apps?: (null | {
 /**
- * Brand ID.
+ * App ID.
  */
-brandId?: string
+id?: string
 /**
- * Offering information.
+ * Array of fields available to the app.
  */
-offeringInfo?: (null | string)
+fields?: string[]
 /**
- * Offering type.
+ * App major version.
  */
-offeringType?: (null | string)
+major?: number
+}[])
 /**
- * Offering type ID.
+ * On the same purchase, allows the selection of items from multiple delivery channels.
  */
-offeringTypeId?: (null | string)
-}
+allowMultipleDeliveries?: (null | boolean)
 /**
- * Presale date.
+ * Allows the editing of SKU prices right in the cart.
  */
-preSaleDate?: (null | string)
+allowManualPrice?: (null | boolean)
 /**
- * Product category IDs.
+ * Allows users to select whether they want the store to keep their personal and payment data saved.
  */
-productCategoryIds?: string
+savePersonalDataAsOptIn?: (null | boolean)
 /**
- * Object, where each field is an ID from `productCategoryIds`.
+ * Allows the input of a limit of white label sellers involved on the cart.
  */
-productCategories?: {
+maxNumberOfWhiteLabelSellers?: (null | number)
 /**
- * Product category corresponding to the ID in the field key.
+ * Allows, on a first purchase, masking client's data. It could be useful when a shared cart is used and the client does not want to share its data.
  */
-"{ID}"?: string
-}
+maskFirstPurchaseData?: (null | boolean)
 /**
- * Quantity.
+ * 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.
  */
-quantity?: number
+recaptchaValidation?: string
 /**
- * Seller.
+ * Indicates whether authentication is required for completing purchases.
  */
-seller?: string
+requiresLoginToPlaceOrder?: boolean
 /**
- * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
+ * Minimum interval (in seconds) between successive purchases.
  */
-sellerChain?: string[]
+minimumPurchaseDowntimeSeconds?: number
 /**
- * Image URL.
- */
-imageUrl?: string
-/**
- * Detail URL.
- */
-detailUrl?: string
-/**
- * Information on services sold along with the SKU. Example: a gift package.
- */
-bundleItems?: {
-/**
- * Service type.
- */
-type?: string
-/**
- * Service identifier.
- */
-id?: number
-/**
- * Service name.
- */
-name?: string
-/**
- * Service price in cents.
- */
-price?: number
-}[]
-/**
- * Array containing information on attachments.
- */
-attachments?: string[]
-/**
- * Array of price tags, each of which, modifies the price in some way, like discounts or rates that apply to the item in the context of the order.
- */
-priceTags?: {
-/**
- * Price tag identifier.
- */
-identifier?: string
-/**
- * Indicates whether price tag value is applied through a percentage.
- */
-isPercentual?: boolean
-/**
- * Price tag name.
- */
-name?: string
-/**
- * Price tag raw value.
- */
-rawValue?: number
-/**
- * Price tag value.
- */
-value?: number
-}[]
-/**
- * Availability.
- */
-availability?: string
-/**
- * Measurement unit.
- */
-measurementUnit?: string
-/**
- * Unit multiplier.
- */
-unitMultiplier?: number
-/**
- * Manufacturer code.
- */
-manufacturerCode?: (null | string)
-/**
- * Price information for all units of a specific item.
- */
-priceDefinition?: {
-/**
- * Item's calculated unitary selling price in cents.
- */
-calculatedSellingPrice?: number
-/**
- * Total value for all units of the item in cents.
- */
-total?: number
-/**
- * Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
- */
-sellingPrices?: {
-/**
- * Value in cents for that specific rounding.
- */
-value?: number
-/**
- * Rounding quantity, meaning how many items are rounded to this value.
- */
-quantity?: number
-}[]
-}
-}[]
-/**
- * Array containing the data of the item selected as a gift.
- */
-selectableGifts?: any[]
-/**
- * Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).
- */
-totalizers?: any[]
-/**
- * Shipping information pertinent to the order.
- */
-shippingData?: {
-/**
- * Address information.
- */
-address?: {
-/**
- * Type of address. For example, `Residential` or `Pickup`.
- */
-addressType?: string
-/**
- * Name of the person who is going to receive the order.
- */
-receiverName?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Indicates whether address is disposable.
- */
-isDisposable?: boolean
-/**
- * Postal code.
- */
-postalCode?: string
-/**
- * City of the shipping address.
- */
-city?: string
-/**
- * State of the shipping address.
- */
-state?: string
-/**
- * Three letter ISO code of the country of the shipping address.
- */
-country?: string
-/**
- * Street of the shipping address.
- */
-street?: string
-/**
- * Number of the building, house or apartment in the shipping address.
- */
-number?: string
-/**
- * Neighborhood of the shipping address.
- */
-neighborhood?: string
-/**
- * Complement to the shipping address, in case it applies.
- */
-complement?: (null | string)
-/**
- * Complement that might help locate the shipping address more precisely in case of delivery.
- */
-reference?: (null | string)
-/**
- * Array with two strings with geocoordinates, first latitude, then longitude.
- */
-geoCoordinates?: string[]
-}
-/**
- * Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.
- */
-logisticsInfo?: {
-/**
- * Index corresponding to the position of the object in the `items` array.
- */
-itemIndex?: number
-/**
- * SLA selected by the customer.
- */
-selectedSla?: string
-/**
- * Delivery channel selected by the customer.
- */
-selectedDeliveryChannel?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Information on available SLAs.
- */
-slas?: {
-/**
- * SLA ID.
- */
-id?: string
-/**
- * Delivery channel.
- */
-deliveryChannel?: string
-/**
- * SLA name.
- */
-name?: string
-/**
- * Information on each delivery ID.
- */
-deliveryIds?: {
-/**
- * Courier ID.
- */
-courierId?: string
-/**
- * Warehouse ID.
- */
-warehouseId?: string
-/**
- * Warehouse ID.
- */
-dockId?: string
-/**
- * Courier name.
- */
-courierName?: string
-/**
- * Quantity.
- */
-quantity?: number
-}[]
-/**
- * Shipping estimate. For instance, "three business days" will be represented as `3bd`.
- */
-shippingEstimate?: string
-/**
- * Shipping estimate date.
- */
-shippingEstimateDate?: (null | string)
-/**
- * Estimate date of delivery.
- */
-lockTTL?: string
-/**
- * Price in cents.
- */
-price?: number
-/**
- * List price in cents.
- */
-listPrice?: number
-/**
- * Tax in cents.
- */
-tax?: number
-/**
- * Information on the pickup store.
- */
-pickupStoreInfo?: {
-/**
- * Indicates whether it is the pickup store.
- */
-isPickupStore?: boolean
-/**
- * Friendly name.
- */
-friendlyName?: (null | string)
-/**
- * Address information.
- */
-address?: (null | {
-/**
- * Type of address. For example, `Residential` or `Pickup`.
- */
-addressType?: string
-/**
- * Postal code.
- */
-postalCode?: string
-/**
- * City of the shipping address.
- */
-city?: string
-/**
- * State of the shipping address.
- */
-state?: string
-/**
- * Three letter ISO code of the country of the shipping address.
- */
-country?: string
-/**
- * Street of the shipping address.
- */
-street?: string
-/**
- * Number of the building, house or apartment in the shipping address.
- */
-number?: string
-/**
- * Neighborhood of the shipping address.
- */
-neighborhood?: string
-/**
- * Complement to the shipping address, in case it applies.
- */
-complement?: (null | string)
-/**
- * Complement that might help locate the shipping address more precisely in case of delivery.
- */
-reference?: (null | string)
-/**
- * Array with two strings with geocoordinates, first latitude, then longitude.
- */
-geoCoordinates?: string[]
-})
-/**
- * Additional information.
- */
-additionalInfo?: (null | string)
-/**
- * Corresponding dock ID.
- */
-dockId?: (null | string)
-}
-/**
- * Pickup point ID.
- */
-pickupPointId?: (null | string)
-/**
- * Pickup point distance.
- */
-pickupDistance?: number
-/**
- * Polygon name.
- */
-polygonName?: (null | string)
-/**
- * Transit time. For instance, "three business days" is represented as `3bd`.
- */
-transitTime?: string
-}[]
-/**
- * List of countries that the item may be shipped to.
- */
-shipsTo?: string[]
-/**
- * Item ID.
- */
-itemId?: string
-/**
- * List of available delivery channels.
- */
-deliveryChannels?: {
-/**
- * Delivery channel ID.
- */
-id?: string
-}[]
-}[]
-/**
- * Array with information on the selected addresses for the order.
- */
-selectedAddresses?: {
-/**
- * Type of address. For example, `Residential` or `Pickup`.
- */
-addressType?: string
-/**
- * Name of the person who is going to receive the order.
- */
-receiverName?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Indicates whether address is disposable.
- */
-isDisposable?: boolean
-/**
- * Postal code.
- */
-postalCode?: string
-/**
- * City of the shipping address.
- */
-city?: string
-/**
- * State of the shipping address.
- */
-state?: string
-/**
- * Three letter ISO code of the country of the shipping address.
- */
-country?: string
-/**
- * Street of the shipping address.
- */
-street?: string
-/**
- * Number of the building, house or apartment in the shipping address.
- */
-number?: string
-/**
- * Neighborhood of the shipping address.
- */
-neighborhood?: string
-/**
- * Complement to the shipping address, in case it applies.
- */
-complement?: string
-/**
- * Complement that might help locate the shipping address more precisely in case of delivery.
- */
-reference?: (null | string)
-/**
- * Array with two strings with geocoordinates, first latitude, then longitude.
- */
-geoCoordinates?: string[]
-}[]
-/**
- * Array with information on the available addresses for the order.
- */
-availableAddresses?: {
-/**
- * Type of address. For example, `Residential` or `Pickup`.
- */
-addressType?: string
-/**
- * Name of the person who is going to receive the order.
- */
-receiverName?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Indicates whether address is disposable.
- */
-isDisposable?: boolean
-/**
- * Postal code.
- */
-postalCode?: string
-/**
- * City of the shipping address.
- */
-city?: string
-/**
- * State of the shipping address.
- */
-state?: string
-/**
- * Three letter ISO code of the country of the shipping address.
- */
-country?: string
-/**
- * Street of the shipping address.
- */
-street?: string
-/**
- * Number of the building, house or apartment in the shipping address.
- */
-number?: string
-/**
- * Neighborhood of the shipping address.
- */
-neighborhood?: string
-/**
- * Complement to the shipping address, in case it applies.
- */
-complement?: string
-/**
- * Complement that might help locate the shipping address more precisely in case of delivery.
- */
-reference?: (null | string)
-/**
- * Array with two strings with geocoordinates, first latitude, then longitude.
- */
-geoCoordinates?: string[]
-}[]
-}
-/**
- * Customer's profile information.
- */
-clientProfileData?: {
-/**
- * Email address.
- */
-email?: string
-/**
- * First name.
- */
-firstName?: string
-/**
- * Last name.
- */
-lastName?: string
-/**
- * Type of the document informed by the customer.
- */
-documentType?: string
-/**
- * Document informed by the customer.
- */
-document?: string
-/**
- * Phone number.
- */
-phone?: string
-/**
- * Company name, if the customer is a legal entity.
- */
-corporateName?: (null | string)
-/**
- * Trade name, if the customer is a legal entity.
- */
-tradeName?: (null | string)
-/**
- * Corporate document, if the customer is a legal entity.
- */
-corporateDocument?: (null | string)
-/**
- * State inscription, if the customer is a legal entity.
- */
-stateInscription?: (null | string)
-/**
- * Corporate phone number, if the customer is a legal entity.
- */
-corporatePhone?: (null | string)
-/**
- * Indicates whether the customer is a legal entity.
- */
-isCorporate?: boolean
-/**
- * Indicates whether profile is complete on loading.
- */
-profileCompleteOnLoading?: boolean
-/**
- * Indicates whether profile presents error on loading.
- */
-profileErrorOnLoading?: (null | boolean)
-/**
- * Customer class.
- */
-customerClass?: (null | string)
-}
-/**
- * Information on the order's payment.
- */
-paymentData?: {
-/**
- * Gift card information, if it applies to the order.
- */
-giftCards?: {
-/**
- * Gift card redemption code.
- */
-redemptionCode?: string
-/**
- * Gift card value in cents.
- */
-value?: number
-/**
- * Gift card balance in cents.
- */
-balance?: number
-/**
- * Gift card name.
- */
-name?: string
-/**
- * Gift card ID.
- */
-id?: string
-/**
- * Indicates whether gift card is in use.
- */
-inUse?: boolean
-/**
- * Indicates whether gift card is special.
- */
-isSpecialCard?: boolean
-}[]
-/**
- * Information on each transaction pertinent to the order.
- */
-transactions?: {
-/**
- * Indicates whether transaction is active.
- */
-isActive?: boolean
-/**
- * Transaction ID.
- */
-transactionId?: string
-/**
- * Merchant name.
- */
-merchantName?: string
-/**
- * Information on each payment.
- */
-payments?: {
-/**
- * Account ID.
- */
-accountId?: string
-/**
- * Bin.
- */
-bin?: string
-/**
- * Number of installments.
- */
-installments?: number
-/**
- * Payment system.
- */
-paymentSystem?: string
-/**
- * Reference value for calculating interest rates, in case it applies. Displayed in cents.
- */
-referenceValue?: number
-/**
- * Value including interest, in case it applies. Displayed in cents.
- */
-value?: number
-}[]
-/**
- * Indicates whather transaction is shared.
- */
-sharedTransaction?: boolean
-}[]
-}
-/**
- * Object containing promotion data such as coupon tracking information and internal or external UTMs.
- */
-marketingData?: {
-/**
- * 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.
- */
-coupon?: string
-/**
- * UTM source.
- */
-utmSource?: string
-/**
- * UTM medium.
- */
-utmMedium?: string
-/**
- * UTM campaign
- */
-utmCampaign?: string
-/**
- * utmi_page (internal utm).
- */
-utmiPage?: (null | string)
-/**
- * utmi_part (internal utm).
- */
-utmiPart?: (null | string)
-/**
- * utmi_campaign (internal utm).
- */
-utmiCampaign?: (null | string)
-}
-/**
- * Information on each seller.
- */
-sellers?: {
-/**
- * Seller ID.
- */
-id?: string
-/**
- * Seller name.
- */
-name?: string
-/**
- * Seller logo.
- */
-logo?: (null | string)
-}[]
-/**
- * Object containing preferences from the client who placed the order.
- */
-clientPreferencesData?: {
-/**
- * Client's locale. Examples: `pt-BR` and `en-US`.
- */
-locale?: string
-/**
- * `true` if the client opted to receive newsletter from the store.
- */
-optinNewsLetter?: boolean
-}
-/**
- * Object containing commercial condition information.
- */
-commercialConditionData?: (null | {
-
-})
-/**
- * Object containing data from the store's configuration (stored in VTEX's License Manager).
- */
-storePreferencesData?: {
-
-}
-/**
- * Gift registry list information.
- */
-giftRegistryData?: (null | {
-
-})
-/**
- * Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).
- */
-openTextField?: (null | string)
-/**
- * Object containing information pertinent to the order's invoice.
- */
-invoiceData?: (null | {
-
-})
-/**
- * Customer additional information.
- */
-customData?: (null | {
-
-})
-/**
- * Item metadata.
- */
-itemMetadata?: {
-/**
- * List of objects containing metadata on each item in the order.
- */
-items?: {
-/**
- * Item ID.
- */
-id?: string
-/**
- * Seller.
- */
-seller?: string
-/**
- * Product name.
- */
-name?: string
-/**
- * SKU name.
- */
-skuName?: string
-/**
- * Product ID.
- */
-productId?: string
-/**
- * Ref ID.
- */
-refId?: string
-/**
- * European Article Number.
- */
-ean?: (null | string)
-/**
- * Image URL.
- */
-imageUrl?: string
-/**
- * Detail URL.
- */
-detailUrl?: string
-}[]
-}
-/**
- * Hooks information.
- */
-hooksData?: (null | {
-
-})
-/**
- * Information on rates and benefits that apply to the order.
- */
-ratesAndBenefitsData?: {
-/**
- * List with rates and benefits identifiers.
- */
-rateAndBenefitsIdentifiers?: string[]
-/**
- * List with rates and benefits teasers.
- */
-teaser?: string[]
-}
-/**
- * Subscription information.
- */
-subscriptionData?: (null | {
-
-})
-/**
- * Object containing information about the ordering of items within the `orderForm`.
- */
-itemsOrdination?: {
-/**
- * Criteria adopted to order the items in the list.
- */
-criteria?: string
-/**
- * Indicates whether the ordering is ascending.
- */
-ascending?: boolean
-}
-}
-}
-/**
- * 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.
- */
-"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”`.
- */
-allowedOutdatedData?: any[]
-}
-body: {
-/**
- * Array containing the cart items. Each object inside this array corresponds to a different item.
- */
-orderItems?: {
-/**
- * The quantity of the item (SKU) in the cart.
- */
-quantity: number
-/**
- * The seller responsible for the SKU.
- */
-seller: string
-/**
- * The ID of the SKU in VTEX platform.
- */
-id: string
-/**
- * The position of the item in the array.
- */
-index: number
-/**
- * Price of the item in cents. Send this value in case you want to make a bulk price change.
- */
-price?: number
-}[]
-}
-response: {
-/**
- * ID of the orderForm corresponding to a specific cart.
- */
-orderFormId?: string
-/**
- * Attribute created by the seller, in their VTEX store configuration.
- */
-salesChannel?: string
-/**
- * Indicates whether the user is logged into the store.
- */
-loggedIn?: boolean
-/**
- * Indicates whether order is checked in.
- */
-isCheckedIn?: boolean
-/**
- * ID of the store.
- */
-storeId?: (null | string)
-/**
- * Permission to modify item price manually.
- */
-allowManualPrice?: boolean
-/**
- * Data can be edited.
- */
-canEditData?: boolean
-/**
- * Unique ID associated with the customer profile.
- */
-userProfileId?: string
-/**
- * Profile provider.
- */
-profileProvider?: string
-/**
- * Available accounts.
- */
-availableAccounts?: string[]
-/**
- * Information on each available address.
- */
-availableAddresses?: {
-/**
- * Address type.
- */
-addressType?: string
-/**
- * Name of the receiver.
- */
-receiverName?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Indicates whether address is disposable.
- */
-isDisposable?: boolean
-/**
- * City of the address.
- */
-city?: string
-/**
- * State of the address.
- */
-state?: string
-/**
- * Country of the address. ISO three-letter code.
- */
-country?: string
-/**
- * Street of the address.
- */
-street?: string
-/**
- * Number of the address.
- */
-number?: string
-/**
- * Neighborhood of the address.
- */
-neighborhood?: string
-/**
- * Complement to the address.
- */
-complement?: (null | string)
-/**
- * Reference that may help in the location of the address.
- */
-reference?: (null | string)
-/**
- * Array containing two floats with geocoordinates, first longitude, then latitude.
- */
-geoCoordinates?: number[]
-}[]
-/**
- * User type.
- */
-userType?: (null | string)
-/**
- * Ignore customer profile data.
- */
-ignoreProfileData?: boolean
-/**
- * Total value of the order without separating cents. For example, $24.99 is represented `2499`.
- */
-value?: number
-/**
- * Array containing an object for each message generated by our servers while processing the request.
- */
-messages?: any[]
-/**
- * Information on each item in the order.
- */
-items?: {
-/**
- * Unique ID.
- */
-uniqueId?: string
-/**
- * ID of the item.
- */
-id?: string
-/**
- * Product ID.
- */
-productId?: string
-/**
- * Product Ref ID.
- */
-productRefId?: string
-/**
- * Ref ID.
- */
-refId?: string
-/**
- * European Article Number.
- */
-ean?: (null | string)
-/**
- * Product name.
- */
-name?: string
-/**
- * SKU name.
- */
-skuName?: string
-/**
- * Modal type.
- */
-modalType?: (null | string)
-/**
- * Parent item index.
- */
-parentItemIndex?: (null | number)
-/**
- * Parent assembly binding.
- */
-parentAssemblyBinding?: (null | string)
-/**
- * Price expiration date and time.
- */
-priceValidUntil?: string
-/**
- * Tax value in cents.
- */
-tax?: number
-/**
- * A unique identifier code assigned to a tax within the VTEX Admin.
- */
-taxCode?: string
-/**
- * Price in cents.
- */
-price?: number
-/**
- * List price in cents.
- */
-listPrice?: number
-/**
- * Manual price in cents.
- */
-manualPrice?: (null | number)
-/**
- * User that applied the manual price, if that is the case.
- */
-manualPriceAppliedBy?: (null | string)
-/**
- * Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
- */
-sellingPrice?: number
-/**
- * Reward value in cents.
- */
-rewardValue?: number
-/**
- * Indicates whether item is a gift.
- */
-isGift?: boolean
-/**
- * Additional information.
- */
-additionalInfo?: {
-/**
- * Dimension.
- */
-dimension?: (null | string)
-/**
- * Brand name.
- */
-brandName?: string
-/**
- * Brand ID.
- */
-brandId?: string
-/**
- * Offering information.
- */
-offeringInfo?: (null | string)
-/**
- * Offering type.
- */
-offeringType?: (null | string)
-/**
- * Offering type ID.
- */
-offeringTypeId?: (null | string)
-}
-/**
- * Presale date.
- */
-preSaleDate?: (null | string)
-/**
- * Product category IDs.
- */
-productCategoryIds?: string
-/**
- * Object, where each field is an ID from `productCategoryIds`.
- */
-productCategories?: {
-/**
- * Product category corresponding to the ID in the field key.
- */
-"{ID}"?: string
-}
-/**
- * Quantity.
- */
-quantity?: number
-/**
- * Seller.
- */
-seller?: string
-/**
- * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
- */
-sellerChain?: string[]
-/**
- * Image URL.
- */
-imageUrl?: string
-/**
- * Detail URL.
- */
-detailUrl?: string
-/**
- * Information on services sold along with the SKU. Example: a gift package.
- */
-bundleItems?: {
-/**
- * Service type.
- */
-type?: string
-/**
- * Service identifier.
- */
-id?: number
-/**
- * Service name.
- */
-name?: string
-/**
- * Service price in cents.
- */
-price?: number
-}[]
-/**
- * Array containing information on attachments.
- */
-attachments?: string[]
-/**
- * Array of price tags, each of which, modifies the price in some way, like discounts or rates that apply to the item in the context of the order.
- */
-priceTags?: {
-/**
- * Price tag identifier.
- */
-identifier?: string
-/**
- * Indicates whether price tag value is applied through a percentage.
- */
-isPercentual?: boolean
-/**
- * Price tag name.
- */
-name?: string
-/**
- * Price tag raw value.
- */
-rawValue?: number
-/**
- * Price tag value.
- */
-value?: number
-}[]
-/**
- * Availability.
- */
-availability?: string
-/**
- * Measurement unit.
- */
-measurementUnit?: string
-/**
- * Unit multiplier.
- */
-unitMultiplier?: number
-/**
- * Manufacturer code.
- */
-manufacturerCode?: (null | string)
-/**
- * Price information for all units of a specific item.
- */
-priceDefinition?: {
-/**
- * Item's calculated unitary selling price in cents.
- */
-calculatedSellingPrice?: number
-/**
- * Total value for all units of the item in cents.
- */
-total?: number
-/**
- * Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
- */
-sellingPrices?: {
-/**
- * Value in cents for that specific rounding.
- */
-value?: number
-/**
- * Rounding quantity, meaning how many items are rounded to this value.
- */
-quantity?: number
-}[]
-}
-}[]
-/**
- * Array containing the data of the item selected as a gift.
- */
-selectableGifts?: any[]
-/**
- * Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).
- */
-totalizers?: any[]
-/**
- * Shipping information pertinent to the order.
- */
-shippingData?: {
-/**
- * Address information.
- */
-address?: {
-/**
- * Type of address. For example, `Residential` or `Pickup`.
- */
-addressType?: string
-/**
- * Name of the person who is going to receive the order.
- */
-receiverName?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Indicates whether address is disposable.
- */
-isDisposable?: boolean
-/**
- * Postal code.
- */
-postalCode?: string
-/**
- * City of the shipping address.
- */
-city?: string
-/**
- * State of the shipping address.
- */
-state?: string
-/**
- * Three letter ISO code of the country of the shipping address.
- */
-country?: string
-/**
- * Street of the shipping address.
- */
-street?: string
-/**
- * Number of the building, house or apartment in the shipping address.
- */
-number?: string
-/**
- * Neighborhood of the shipping address.
- */
-neighborhood?: string
-/**
- * Complement to the shipping address, in case it applies.
- */
-complement?: (null | string)
-/**
- * Complement that might help locate the shipping address more precisely in case of delivery.
- */
-reference?: (null | string)
-/**
- * Array containing two floats with geocoordinates, first longitude, then latitude.
- */
-geoCoordinates?: number[]
-}
-/**
- * Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.
- */
-logisticsInfo?: {
-/**
- * Index corresponding to the position of the object in the `items` array.
- */
-itemIndex?: number
-/**
- * SLA selected by the customer.
- */
-selectedSla?: string
-/**
- * Delivery channel selected by the customer.
- */
-selectedDeliveryChannel?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Information on available SLAs.
- */
-slas?: {
-/**
- * SLA ID.
- */
-id?: string
-/**
- * Delivery channel.
- */
-deliveryChannel?: string
-/**
- * SLA name.
- */
-name?: string
-/**
- * Information on each delivery ID.
- */
-deliveryIds?: {
-/**
- * Courier ID.
- */
-courierId?: string
-/**
- * Warehouse ID.
- */
-warehouseId?: string
-/**
- * Warehouse ID.
- */
-dockId?: string
-/**
- * Courier name.
- */
-courierName?: string
-/**
- * Quantity.
- */
-quantity?: number
-}[]
-/**
- * Shipping estimate. For instance, Three business days will be represented `3bd`.
- */
-shippingEstimate?: string
-/**
- * Shipping estimate date.
- */
-shippingEstimateDate?: (null | string)
-/**
- * Estimate date of delivery.
- */
-lockTTL?: string
-/**
- * Price in cents.
- */
-price?: number
-/**
- * List price in cents.
- */
-listPrice?: number
-/**
- * Tax in cents.
- */
-tax?: number
-/**
- * Information on the pickup store.
- */
-pickupStoreInfo?: {
-/**
- * Indicates whether it is the pickup store.
- */
-isPickupStore?: boolean
-/**
- * Friendly name.
- */
-friendlyName?: (null | string)
-/**
- * Address information.
- */
-address?: (null | {
-/**
- * Type of address. For example, `Residential` or `Pickup`.
- */
-addressType?: string
-/**
- * Postal code.
- */
-postalCode?: string
-/**
- * City of the shipping address.
- */
-city?: string
-/**
- * State of the shipping address.
- */
-state?: string
-/**
- * Three letter ISO code of the country of the shipping address.
- */
-country?: string
-/**
- * Street of the shipping address.
- */
-street?: string
-/**
- * Number of the building, house or apartment in the shipping address.
- */
-number?: string
-/**
- * Neighborhood of the shipping address.
- */
-neighborhood?: string
-/**
- * Complement to the shipping address, in case it applies.
- */
-complement?: (null | string)
-/**
- * Complement that might help locate the shipping address more precisely in case of delivery.
- */
-reference?: (null | string)
-/**
- * Array containing two floats with geocoordinates, first longitude, then latitude.
- */
-geoCoordinates?: number[]
-})
-/**
- * Additional information.
- */
-additionalInfo?: (null | string)
-/**
- * Corresponding dock ID.
- */
-dockId?: (null | string)
-}
-/**
- * Pickup point ID.
- */
-pickupPointId?: (null | string)
-/**
- * Pickup point distance.
- */
-pickupDistance?: number
-/**
- * Polygon name.
- */
-polygonName?: (null | string)
-/**
- * Transit time. For instance, "three business days" is represented `3bd`.
- */
-transitTime?: string
-}[]
-/**
- * List of countries that the item may be shipped to.
- */
-shipsTo?: string[]
-/**
- * Item ID.
- */
-itemId?: string
-/**
- * List of available delivery channels.
- */
-deliveryChannels?: {
-/**
- * Delivery channel ID.
- */
-id?: string
-}[]
-}[]
-/**
- * Array with information on the selected addresses for the order.
- */
-selectedAddresses?: {
-/**
- * Type of address. For example, `Residential` or `Pickup`.
- */
-addressType?: string
-/**
- * Name of the person who is going to receive the order.
- */
-receiverName?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Indicates whether address is disposable.
- */
-isDisposable?: boolean
-/**
- * Postal code.
- */
-postalCode?: string
-/**
- * City of the shipping address.
- */
-city?: string
-/**
- * State of the shipping address.
- */
-state?: string
-/**
- * Three letter ISO code of the country of the shipping address.
- */
-country?: string
-/**
- * Street of the shipping address.
- */
-street?: string
-/**
- * Number of the building, house or apartment in the shipping address.
- */
-number?: string
-/**
- * Neighborhood of the shipping address.
- */
-neighborhood?: string
-/**
- * Complement to the shipping address, in case it applies.
- */
-complement?: string
-/**
- * Complement that might help locate the shipping address more precisely in case of delivery.
- */
-reference?: (null | string)
-/**
- * Array containing two floats with geocoordinates, first longitude, then latitude.
- */
-geoCoordinates?: number[]
-}[]
-/**
- * Array with information on the available addresses for the order.
- */
-availableAddresses?: {
-/**
- * Type of address. For example, `Residential` or `Pickup`.
- */
-addressType?: string
-/**
- * Name of the person who is going to receive the order.
- */
-receiverName?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Indicates whether address is disposable.
- */
-isDisposable?: boolean
-/**
- * Postal code.
- */
-postalCode?: string
-/**
- * City of the shipping address.
- */
-city?: string
-/**
- * State of the shipping address.
- */
-state?: string
-/**
- * Three letter ISO code of the country of the shipping address.
- */
-country?: string
-/**
- * Street of the shipping address.
- */
-street?: string
-/**
- * Number of the building, house or apartment in the shipping address.
- */
-number?: string
-/**
- * Neighborhood of the shipping address.
- */
-neighborhood?: string
-/**
- * Complement to the shipping address, in case it applies.
- */
-complement?: string
-/**
- * Complement that might help locate the shipping address more precisely in case of delivery.
- */
-reference?: (null | string)
-/**
- * Array containing two floats with geocoordinates, first longitude, then latitude.
- */
-geoCoordinates?: number[]
-}[]
-}
-/**
- * Customer's profile information.
- */
-clientProfileData?: {
-/**
- * Email address.
- */
-email?: string
-/**
- * First name.
- */
-firstName?: string
-/**
- * Last name.
- */
-lastName?: string
-/**
- * Type of the document informed by the customer.
- */
-documentType?: string
-/**
- * Document informed by the customer.
- */
-document?: string
-/**
- * Phone number.
- */
-phone?: string
-/**
- * Company name, if the customer is a legal entity.
- */
-corporateName?: (null | string)
-/**
- * Trade name, if the customer is a legal entity.
- */
-tradeName?: (null | string)
-/**
- * Corporate document, if the customer is a legal entity.
- */
-corporateDocument?: (null | string)
-/**
- * State inscription, if the customer is a legal entity.
- */
-stateInscription?: (null | string)
-/**
- * Corporate phone number, if the customer is a legal entity.
- */
-corporatePhone?: (null | string)
-/**
- * Indicates whether the customer is a legal entity.
- */
-isCorporate?: boolean
-/**
- * Indicates whether profile is complete on loading.
- */
-profileCompleteOnLoading?: boolean
-/**
- * Indicates whether profile presents error on loading.
- */
-profileErrorOnLoading?: (null | boolean)
-/**
- * Customer class.
- */
-customerClass?: (null | string)
-}
-/**
- * Information on the order's payment.
- */
-paymentData?: {
-/**
- * Gift card information, if it applies to the order.
- */
-giftCards?: {
-/**
- * Gift card redemption code.
- */
-redemptionCode?: string
-/**
- * Gift card value in cents.
- */
-value?: number
-/**
- * Gift card balance in cents.
- */
-balance?: number
-/**
- * Gift card name.
- */
-name?: string
-/**
- * Gift card ID.
- */
-id?: string
-/**
- * Indicates whether gift card is in use.
- */
-inUse?: boolean
-/**
- * Indicates whether gift card is special.
- */
-isSpecialCard?: boolean
-}[]
-/**
- * Information on each transaction pertinent to the order.
- */
-transactions?: {
-/**
- * Indicates whether transaction is active.
- */
-isActive?: boolean
-/**
- * Transaction ID.
- */
-transactionId?: string
-/**
- * Merchant name.
- */
-merchantName?: string
-/**
- * Information on each payment.
- */
-payments?: {
-/**
- * Account ID.
- */
-accountId?: string
-/**
- * Bin.
- */
-bin?: string
-/**
- * Number of installments.
- */
-installments?: number
-/**
- * Payment system.
- */
-paymentSystem?: string
-/**
- * Reference value for calculating interest rates, in case it applies. Displayed in cents.
- */
-referenceValue?: number
-/**
- * Value including interest, in case it applies. Displayed in cents.
- */
-value?: number
-}[]
-/**
- * Indicates whather transaction is shared.
- */
-sharedTransaction?: boolean
-}[]
-}
-/**
- * Object containing promotion data such as coupon tracking information and internal or external UTMs.
- */
-marketingData?: {
-/**
- * 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.
- */
-coupon?: string
-/**
- * UTM source.
- */
-utmSource?: string
-/**
- * UTM medium.
- */
-utmMedium?: string
-/**
- * UTM campaign
- */
-utmCampaign?: string
-/**
- * utmi_page (internal utm).
- */
-utmiPage?: (null | string)
-/**
- * utmi_part (internal utm).
- */
-utmiPart?: (null | string)
-/**
- * utmi_campaign (internal utm).
- */
-utmiCampaign?: (null | string)
-}
-/**
- * Information on each seller.
- */
-sellers?: {
-/**
- * Seller ID.
- */
-id?: string
-/**
- * Seller name.
- */
-name?: string
-/**
- * Seller logo.
- */
-logo?: (null | string)
-}[]
-/**
- * Object containing preferences from the client who placed the order.
- */
-clientPreferencesData?: {
-/**
- * Client's locale. Examples: `pt-BR` and `en-US`.
- */
-locale?: string
-/**
- * `true` if the client opted to receive newsletter from the store.
- */
-optinNewsLetter?: boolean
-}
-/**
- * Object containing commercial condition information.
- */
-commercialConditionData?: (null | {
-
-})
-/**
- * Object containing data from the store's configuration (stored in VTEX's License Manager).
- */
-storePreferencesData?: {
-
-}
-/**
- * Gift registry list information.
- */
-giftRegistryData?: (null | {
-
-})
-/**
- * Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).
- */
-openTextField?: (null | string)
-/**
- * Object containing information pertinent to the order's invoice.
- */
-invoiceData?: (null | {
-
-})
-/**
- * Customer additional information.
- */
-customData?: (null | {
-
-})
-/**
- * Item metadata.
- */
-itemMetadata?: {
-/**
- * List of objects containing metadata on each item in the order.
- */
-items?: {
-/**
- * Item ID.
- */
-id?: string
-/**
- * Seller.
- */
-seller?: string
-/**
- * Product name.
- */
-name?: string
-/**
- * SKU name.
- */
-skuName?: string
-/**
- * Product ID.
- */
-productId?: string
-/**
- * Ref ID.
- */
-refId?: string
-/**
- * European Article Number.
- */
-ean?: (null | string)
-/**
- * Image URL.
- */
-imageUrl?: string
-/**
- * Detail URL.
- */
-detailUrl?: string
-}[]
-}
-/**
- * Hooks information.
- */
-hooksData?: (null | {
-
-})
-/**
- * Information on rates and benefits that apply to the order.
- */
-ratesAndBenefitsData?: {
-/**
- * List with rates and benefits identifiers.
- */
-rateAndBenefitsIdentifiers?: string[]
-/**
- * List with rates and benefits teasers.
- */
-teaser?: string[]
-}
-/**
- * Subscription information.
- */
-subscriptionData?: (null | {
-
-})
-/**
- * Object containing information about the ordering of items within the orderForm.
- */
-itemsOrdination?: {
-/**
- * Criteria adopted to order the items in the list.
- */
-criteria?: string
-/**
- * Indicates whether the ordering is ascending.
- */
-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.
- * 
- * 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.
- */
-"PATCH /api/checkout/pub/orderForm/:orderFormId/items": {
-body: {
-/**
- * Array containing the cart items. Each object inside this array corresponds to a different item.
- */
-orderItems?: {
-/**
- * The ID of the SKU in VTEX platform.
- */
-id: string
-/**
- * The quantity of the item (SKU) in the cart.
- */
-quantity: number
-/**
- * The seller responsible for the SKU.
- */
-seller: string
-/**
- * The position of the item in the array. This string should be sent only to modify price or quantity of an item. NOTE: This string should not be sent when you are adding a new item to the cart.
- */
-index?: number
-/**
- * Price of the item in cents. Send this value in case you want to make a bulk price change.
- */
-price?: number
-/**
- * Array containing information on attachments.
- */
-attachments?: {
-/**
- * Attachment identification.
- */
-name?: string
-/**
- * Attachment content data. E.g. `"Do you want to receive packages?": "Yes"`.
- */
-content?: (null | {
-
-})
-}[]
-/**
- * Indicates whether the item can be splitted.
- */
-noSplitItem?: boolean
-/**
- * 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"`.
- */
-allowedOutdatedData?: string[]
-}[]
-}
-response: {
-/**
- * ID of the orderForm corresponding to a specific cart.
- */
-orderFormId?: string
-/**
- * Attribute created by the seller, in their VTEX store configuration.
- */
-salesChannel?: string
-/**
- * Indicates whether the user is logged into the store.
- */
-loggedIn?: boolean
-/**
- * Indicates whether order is checked in.
- */
-isCheckedIn?: boolean
-/**
- * ID of the store.
- */
-storeId?: (null | string)
-/**
- * Permission to modify item price manually.
- */
-allowManualPrice?: boolean
-/**
- * Data can be edited.
- */
-canEditData?: boolean
-/**
- * Unique ID associated with the customer profile.
- */
-userProfileId?: string
-/**
- * Profile provider.
- */
-profileProvider?: string
-/**
- * Available accounts.
- */
-availableAccounts?: string[]
-/**
- * Information on each available address.
- */
-availableAddresses?: {
-/**
- * Address type.
- */
-addressType?: string
-/**
- * Name of the receiver.
- */
-receiverName?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Indicates whether address is disposable.
- */
-isDisposable?: boolean
-/**
- * City of the address.
- */
-city?: string
-/**
- * State of the address.
- */
-state?: string
-/**
- * Country of the address. ISO three-letter code.
- */
-country?: string
-/**
- * Street of the address.
- */
-street?: string
-/**
- * Number of the address.
- */
-number?: string
-/**
- * Neighborhood of the address.
- */
-neighborhood?: string
-/**
- * Complement to the address.
- */
-complement?: (null | string)
-/**
- * Reference that may help in the location of the address.
- */
-reference?: (null | string)
-/**
- * Array containing two floats with geocoordinates, first longitude, then latitude.
- */
-geoCoordinates?: number[]
-}[]
-/**
- * User type.
- */
-userType?: (null | string)
-/**
- * Ignore customer profile data.
- */
-ignoreProfileData?: boolean
-/**
- * Total value of the order without separating cents. For example, $24.99 is represented `2499`.
- */
-value?: number
-/**
- * Array containing an object for each message generated by our servers while processing the request.
- */
-messages?: any[]
-/**
- * Information on each item in the order.
- */
-items?: {
-/**
- * Unique ID.
- */
-uniqueId?: string
-/**
- * ID of the item.
- */
-id?: string
-/**
- * Product ID.
- */
-productId?: string
-/**
- * Product Ref ID.
- */
-productRefId?: string
-/**
- * Ref ID.
- */
-refId?: string
-/**
- * European Article Number.
- */
-ean?: (null | string)
-/**
- * Product name.
- */
-name?: string
-/**
- * SKU name.
- */
-skuName?: string
-/**
- * Modal type.
- */
-modalType?: (null | string)
-/**
- * Parent item index.
- */
-parentItemIndex?: (null | number)
-/**
- * Parent assembly binding.
- */
-parentAssemblyBinding?: (null | string)
-/**
- * Price expiration date and time.
- */
-priceValidUntil?: string
-/**
- * Tax value in cents.
- */
-tax?: number
-/**
- * A unique identifier code assigned to a tax within the VTEX Admin.
- */
-taxCode?: string
-/**
- * Price in cents.
- */
-price?: number
-/**
- * List price in cents.
- */
-listPrice?: number
-/**
- * Manual price in cents.
- */
-manualPrice?: (null | number)
-/**
- * User that applied the manual price, if that is the case.
- */
-manualPriceAppliedBy?: (null | string)
-/**
- * Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
- */
-sellingPrice?: number
-/**
- * Reward value in cents.
- */
-rewardValue?: number
-/**
- * Indicates whether item is a gift.
- */
-isGift?: boolean
-/**
- * Additional information.
- */
-additionalInfo?: {
-/**
- * Dimension.
- */
-dimension?: (null | string)
-/**
- * Brand name.
- */
-brandName?: string
-/**
- * Brand ID.
- */
-brandId?: string
-/**
- * Offering information.
- */
-offeringInfo?: (null | string)
-/**
- * Offering type.
- */
-offeringType?: (null | string)
-/**
- * Offering type ID.
- */
-offeringTypeId?: (null | string)
-}
-/**
- * Presale date.
- */
-preSaleDate?: (null | string)
-/**
- * Product category IDs.
- */
-productCategoryIds?: string
-/**
- * Object, where each field is an ID from `productCategoryIds`.
- */
-productCategories?: {
-/**
- * Product category corresponding to the ID in the field key.
- */
-"{ID}"?: string
-}
-/**
- * Quantity.
- */
-quantity?: number
-/**
- * Seller.
- */
-seller?: string
-/**
- * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
- */
-sellerChain?: string[]
-/**
- * Image URL.
- */
-imageUrl?: string
-/**
- * Detail URL.
- */
-detailUrl?: string
-/**
- * Information on services sold along with the SKU. Example: a gift package.
- */
-bundleItems?: {
-/**
- * Service type.
- */
-type?: string
-/**
- * Service identifier.
- */
-id?: number
-/**
- * Service name.
- */
-name?: string
-/**
- * Service price in cents.
- */
-price?: number
-}[]
-/**
- * Array containing information on attachments.
- */
-attachments?: string[]
-/**
- * Array of price tags, each of which, modifies the price in some way, like discounts or rates that apply to the item in the context of the order.
- */
-priceTags?: {
-/**
- * Price tag identifier.
- */
-identifier?: string
-/**
- * Indicates whether price tag value is applied through a percentage.
- */
-isPercentual?: boolean
-/**
- * Price tag name.
- */
-name?: string
-/**
- * Price tag raw value.
- */
-rawValue?: number
-/**
- * Price tag value.
- */
-value?: number
-}[]
-/**
- * Availability.
- */
-availability?: string
-/**
- * Measurement unit.
- */
-measurementUnit?: string
-/**
- * Unit multiplier.
- */
-unitMultiplier?: number
-/**
- * Manufacturer code.
- */
-manufacturerCode?: (null | string)
-/**
- * Price information for all units of a specific item.
- */
-priceDefinition?: {
-/**
- * Item's calculated unitary selling price in cents.
- */
-calculatedSellingPrice?: number
-/**
- * Total value for all units of the item in cents.
- */
-total?: number
-/**
- * Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
- */
-sellingPrices?: {
-/**
- * Value in cents for that specific rounding.
- */
-value?: number
-/**
- * Rounding quantity, meaning how many items are rounded to this value.
- */
-quantity?: number
-}[]
-}
-}[]
-/**
- * Array containing the data of the item selected as a gift.
- */
-selectableGifts?: any[]
-/**
- * Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).
- */
-totalizers?: any[]
-/**
- * Shipping information pertinent to the order.
- */
-shippingData?: {
-/**
- * Address information.
- */
-address?: {
-/**
- * Type of address. For example, `Residential` or `Pickup`.
- */
-addressType?: string
-/**
- * Name of the person who is going to receive the order.
- */
-receiverName?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Indicates whether address is disposable.
- */
-isDisposable?: boolean
-/**
- * Postal code.
- */
-postalCode?: string
-/**
- * City of the shipping address.
- */
-city?: string
-/**
- * State of the shipping address.
- */
-state?: string
-/**
- * Three letter ISO code of the country of the shipping address.
- */
-country?: string
-/**
- * Street of the shipping address.
- */
-street?: string
-/**
- * Number of the building, house or apartment in the shipping address.
- */
-number?: string
-/**
- * Neighborhood of the shipping address.
- */
-neighborhood?: string
-/**
- * Complement to the shipping address, in case it applies.
- */
-complement?: (null | string)
-/**
- * Complement that might help locate the shipping address more precisely in case of delivery.
- */
-reference?: (null | string)
-/**
- * Array containing two floats with geocoordinates, first longitude, then latitude.
- */
-geoCoordinates?: number[]
-}
-/**
- * Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.
- */
-logisticsInfo?: {
-/**
- * Index corresponding to the position of the object in the `items` array.
- */
-itemIndex?: number
-/**
- * SLA selected by the customer.
- */
-selectedSla?: string
-/**
- * Delivery channel selected by the customer.
- */
-selectedDeliveryChannel?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Information on available SLAs.
- */
-slas?: {
-/**
- * SLA ID.
- */
-id?: string
-/**
- * Delivery channel.
- */
-deliveryChannel?: string
-/**
- * SLA name.
- */
-name?: string
-/**
- * Information on each delivery ID.
- */
-deliveryIds?: {
-/**
- * Courier ID.
- */
-courierId?: string
-/**
- * Warehouse ID.
- */
-warehouseId?: string
-/**
- * Warehouse ID.
- */
-dockId?: string
-/**
- * Courier name.
- */
-courierName?: string
-/**
- * Quantity.
- */
-quantity?: number
-}[]
-/**
- * Shipping estimate. For instance, Three business days will be represented `3bd`.
- */
-shippingEstimate?: string
-/**
- * Shipping estimate date.
- */
-shippingEstimateDate?: (null | string)
-/**
- * Estimate date of delivery.
- */
-lockTTL?: string
-/**
- * Price in cents.
- */
-price?: number
-/**
- * List price in cents.
- */
-listPrice?: number
-/**
- * Tax in cents.
- */
-tax?: number
-/**
- * Information on the pickup store.
- */
-pickupStoreInfo?: {
-/**
- * Indicates whether it is the pickup store.
- */
-isPickupStore?: boolean
-/**
- * Friendly name.
- */
-friendlyName?: (null | string)
-/**
- * Address information.
- */
-address?: (null | {
-/**
- * Type of address. For example, `Residential` or `Pickup`.
- */
-addressType?: string
-/**
- * Postal code.
- */
-postalCode?: string
-/**
- * City of the shipping address.
- */
-city?: string
-/**
- * State of the shipping address.
- */
-state?: string
-/**
- * Three letter ISO code of the country of the shipping address.
- */
-country?: string
-/**
- * Street of the shipping address.
- */
-street?: string
-/**
- * Number of the building, house or apartment in the shipping address.
- */
-number?: string
-/**
- * Neighborhood of the shipping address.
- */
-neighborhood?: string
-/**
- * Complement to the shipping address, in case it applies.
- */
-complement?: (null | string)
-/**
- * Complement that might help locate the shipping address more precisely in case of delivery.
- */
-reference?: (null | string)
-/**
- * Array containing two floats with geocoordinates, first longitude, then latitude.
- */
-geoCoordinates?: number[]
-})
-/**
- * Additional information.
- */
-additionalInfo?: (null | string)
-/**
- * Corresponding dock ID.
- */
-dockId?: (null | string)
-}
-/**
- * Pickup point ID.
- */
-pickupPointId?: (null | string)
-/**
- * Pickup point distance.
- */
-pickupDistance?: number
-/**
- * Polygon name.
- */
-polygonName?: (null | string)
-/**
- * Transit time. For instance, "three business days" is represented `3bd`.
- */
-transitTime?: string
-}[]
-/**
- * List of countries that the item may be shipped to.
- */
-shipsTo?: string[]
-/**
- * Item ID.
- */
-itemId?: string
-/**
- * List of available delivery channels.
- */
-deliveryChannels?: {
-/**
- * Delivery channel ID.
- */
-id?: string
-}[]
-}[]
-/**
- * Array with information on the selected addresses for the order.
- */
-selectedAddresses?: {
-/**
- * Type of address. For example, `Residential` or `Pickup`.
- */
-addressType?: string
-/**
- * Name of the person who is going to receive the order.
- */
-receiverName?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Indicates whether address is disposable.
- */
-isDisposable?: boolean
-/**
- * Postal code.
- */
-postalCode?: string
-/**
- * City of the shipping address.
- */
-city?: string
-/**
- * State of the shipping address.
- */
-state?: string
-/**
- * Three letter ISO code of the country of the shipping address.
- */
-country?: string
-/**
- * Street of the shipping address.
- */
-street?: string
-/**
- * Number of the building, house or apartment in the shipping address.
- */
-number?: string
-/**
- * Neighborhood of the shipping address.
- */
-neighborhood?: string
-/**
- * Complement to the shipping address, in case it applies.
- */
-complement?: string
-/**
- * Complement that might help locate the shipping address more precisely in case of delivery.
- */
-reference?: (null | string)
-/**
- * Array containing two floats with geocoordinates, first longitude, then latitude.
- */
-geoCoordinates?: number[]
-}[]
-/**
- * Array with information on the available addresses for the order.
- */
-availableAddresses?: {
-/**
- * Type of address. For example, `Residential` or `Pickup`.
- */
-addressType?: string
-/**
- * Name of the person who is going to receive the order.
- */
-receiverName?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Indicates whether address is disposable.
- */
-isDisposable?: boolean
-/**
- * Postal code.
- */
-postalCode?: string
-/**
- * City of the shipping address.
- */
-city?: string
-/**
- * State of the shipping address.
- */
-state?: string
-/**
- * Three letter ISO code of the country of the shipping address.
- */
-country?: string
-/**
- * Street of the shipping address.
- */
-street?: string
-/**
- * Number of the building, house or apartment in the shipping address.
- */
-number?: string
-/**
- * Neighborhood of the shipping address.
- */
-neighborhood?: string
-/**
- * Complement to the shipping address, in case it applies.
- */
-complement?: string
-/**
- * Complement that might help locate the shipping address more precisely in case of delivery.
- */
-reference?: (null | string)
-/**
- * Array containing two floats with geocoordinates, first longitude, then latitude.
- */
-geoCoordinates?: number[]
-}[]
-}
-/**
- * Customer's profile information.
- */
-clientProfileData?: {
-/**
- * Email address.
- */
-email?: string
-/**
- * First name.
- */
-firstName?: string
-/**
- * Last name.
- */
-lastName?: string
-/**
- * Type of the document informed by the customer.
- */
-documentType?: string
-/**
- * Document informed by the customer.
- */
-document?: string
-/**
- * Phone number.
- */
-phone?: string
-/**
- * Company name, if the customer is a legal entity.
- */
-corporateName?: (null | string)
-/**
- * Trade name, if the customer is a legal entity.
- */
-tradeName?: (null | string)
-/**
- * Corporate document, if the customer is a legal entity.
- */
-corporateDocument?: (null | string)
-/**
- * State inscription, if the customer is a legal entity.
- */
-stateInscription?: (null | string)
-/**
- * Corporate phone number, if the customer is a legal entity.
- */
-corporatePhone?: (null | string)
-/**
- * Indicates whether the customer is a legal entity.
- */
-isCorporate?: boolean
-/**
- * Indicates whether profile is complete on loading.
- */
-profileCompleteOnLoading?: boolean
-/**
- * Indicates whether profile presents error on loading.
- */
-profileErrorOnLoading?: (null | boolean)
-/**
- * Customer class.
- */
-customerClass?: (null | string)
-}
-/**
- * Information on the order's payment.
- */
-paymentData?: {
-/**
- * Gift card information, if it applies to the order.
- */
-giftCards?: {
-/**
- * Gift card redemption code.
- */
-redemptionCode?: string
-/**
- * Gift card value in cents.
- */
-value?: number
-/**
- * Gift card balance in cents.
- */
-balance?: number
-/**
- * Gift card name.
- */
-name?: string
-/**
- * Gift card ID.
- */
-id?: string
-/**
- * Indicates whether gift card is in use.
- */
-inUse?: boolean
-/**
- * Indicates whether gift card is special.
- */
-isSpecialCard?: boolean
-}[]
-/**
- * Information on each transaction pertinent to the order.
- */
-transactions?: {
-/**
- * Indicates whether transaction is active.
- */
-isActive?: boolean
-/**
- * Transaction ID.
- */
-transactionId?: string
-/**
- * Merchant name.
- */
-merchantName?: string
-/**
- * Information on each payment.
- */
-payments?: {
-/**
- * Account ID.
- */
-accountId?: string
-/**
- * Bin.
- */
-bin?: string
-/**
- * Number of installments.
- */
-installments?: number
-/**
- * Payment system.
- */
-paymentSystem?: string
-/**
- * Reference value for calculating interest rates, in case it applies. Displayed in cents.
- */
-referenceValue?: number
-/**
- * Value including interest, in case it applies. Displayed in cents.
- */
-value?: number
-}[]
-/**
- * Indicates whather transaction is shared.
- */
-sharedTransaction?: boolean
-}[]
-}
-/**
- * Object containing promotion data such as coupon tracking information and internal or external UTMs.
- */
-marketingData?: {
-/**
- * Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pub/orderForms/simulation) request to check which coupons might apply before placing the order.
- */
-coupon?: string
-/**
- * UTM source.
- */
-utmSource?: string
-/**
- * UTM medium.
- */
-utmMedium?: string
-/**
- * UTM campaign
- */
-utmCampaign?: string
-/**
- * utmi_page (internal utm).
- */
-utmiPage?: (null | string)
-/**
- * utmi_part (internal utm).
- */
-utmiPart?: (null | string)
-/**
- * utmi_campaign (internal utm).
- */
-utmiCampaign?: (null | string)
-}
-/**
- * Information on each seller.
- */
-sellers?: {
-/**
- * Seller ID.
- */
-id?: string
-/**
- * Seller name.
- */
-name?: string
-/**
- * Seller logo.
- */
-logo?: (null | string)
-}[]
-/**
- * Object containing preferences from the client who placed the order.
- */
-clientPreferencesData?: {
-/**
- * Client's locale. Examples: `pt-BR` and `en-US`.
- */
-locale?: string
-/**
- * `true` if the client opted to receive newsletter from the store.
- */
-optinNewsLetter?: boolean
-}
-/**
- * Object containing commercial condition information.
- */
-commercialConditionData?: (null | {
-
-})
-/**
- * Object containing data from the store's configuration (stored in VTEX's License Manager).
- */
-storePreferencesData?: {
-
-}
-/**
- * Gift registry list information.
- */
-giftRegistryData?: (null | {
-
-})
-/**
- * Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/docs/guides/customizable-fields-with-checkout-api).
- */
-openTextField?: (null | string)
-/**
- * Object containing information pertinent to the order's invoice.
- */
-invoiceData?: (null | {
-
-})
-/**
- * Customer additional information.
- */
-customData?: (null | {
-
-})
-/**
- * Item metadata.
- */
-itemMetadata?: {
-/**
- * List of objects containing metadata on each item in the order.
- */
-items?: {
-/**
- * Item ID.
- */
-id?: string
-/**
- * Seller.
- */
-seller?: string
-/**
- * Product name.
- */
-name?: string
-/**
- * SKU name.
- */
-skuName?: string
-/**
- * Product ID.
- */
-productId?: string
-/**
- * Ref ID.
- */
-refId?: string
-/**
- * European Article Number.
- */
-ean?: (null | string)
-/**
- * Image URL.
- */
-imageUrl?: string
-/**
- * Detail URL.
- */
-detailUrl?: string
-}[]
-}
-/**
- * Hooks information.
- */
-hooksData?: (null | {
-
-})
-/**
- * Information on rates and benefits that apply to the order.
- */
-ratesAndBenefitsData?: {
-/**
- * List with rates and benefits identifiers.
- */
-rateAndBenefitsIdentifiers?: string[]
-/**
- * List with rates and benefits teasers.
- */
-teaser?: string[]
-}
-/**
- * Subscription information.
- */
-subscriptionData?: (null | {
-
-})
-/**
- * Object containing information about the ordering of items within the orderForm.
- */
-itemsOrdination?: {
-/**
- * Criteria adopted to order the items in the list.
- */
-criteria?: string
-/**
- * Indicates whether the ordering is ascending.
- */
-ascending?: boolean
-}
-}
-}
-/**
- * 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.
- */
-"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.
- * 
- * 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": {
-body: {
-/**
- * Indicates whether profile data should be ignored.
- */
-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).
- * 
- * >⚠️ 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": {
-searchParams: {
-/**
- * Client's email address to be searched.
- */
-email: string
-/**
- * Indicates whether the returned profiles must be complete or not.
- */
-ensureComplete?: boolean
-}
-response: {
-/**
- * Unique ID associated with the customer profile.
- */
-userProfileId?: string
-/**
- * Profile provider.
- */
-profileProvider?: string
-/**
- * Available accounts.
- */
-availableAccounts?: string[]
-/**
- * Information on each available address.
- */
-availableAddresses?: {
-/**
- * Address type.
- */
-addressType?: string
-/**
- * Name of the receiver.
- */
-receiverName?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Indicates whether address is disposable.
- */
-isDisposable?: boolean
-/**
- * City of the address.
- */
-city?: string
-/**
- * State of the address.
- */
-state?: string
-/**
- * Country of the address. ISO three-letter code.
- */
-country?: string
-/**
- * Street of the address.
- */
-street?: string
-/**
- * Number of the address.
- */
-number?: string
-/**
- * Neighborhood of the address.
- */
-neighborhood?: string
-/**
- * Complement to the address.
- */
-complement?: (null | string)
-/**
- * Reference that may help in the location of the address.
- */
-reference?: (null | string)
-/**
- * Array containing two floats with geocoordinates, first longitude, then latitude.
- */
-geoCoordinates?: number[]
-}[]
-/**
- * Customer profile information.
- */
-userProfile?: {
-/**
- * Email address.
- */
-email?: string
-/**
- * First name.
- */
-firstName?: string
-/**
- * Last name.
- */
-lastName?: string
-/**
- * Document.
- */
-document?: string
-/**
- * Document type.
- */
-documentType?: string
-/**
- * Telephone number.
- */
-phone?: string
-/**
- * Name of the company. Used for corporate clients.
- */
-corporateName?: (null | string)
-/**
- * Trade name. Used for corporate clients.
- */
-tradeName?: (null | string)
-/**
- * Document. Used for corporate clients.
- */
-corporateDocument?: (null | string)
-/**
- * State inscription. Used for corporate clients.
- */
-stateInscription?: (null | string)
-/**
- * Telephone number. Used for corporate clients.
- */
-corporatePhone?: (null | string)
-/**
- * Indicates whether client is corporate.
- */
-isCorporate?: boolean
-/**
- * Profile complete when loading.
- */
-profileCompleteOnLoading?: (null | string)
-/**
- * Profile error when loading.
- */
-profileErrorOnLoading?: (null | string)
-/**
- * Customer class.
- */
-customerClass?: (null | string)
-}
-/**
- * Indicates whether customer profile is complete.
- */
-isComplete?: boolean
-}
-}
-/**
- * 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.
- * 
- * >⚠️ 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": {
-/**
- * Customer's profile information.
- */
-body: {
-/**
- * Customer's email address.
- */
-email: string
-/**
- * Customer's first name.
- */
-firstName: string
-/**
- * Customer's last name.
- */
-lastName: string
-/**
- * Type of the document informed by the customer.
- */
-documentType: string
-/**
- * Document number informed by the customer.
- */
-document: string
-/**
- * Customer's phone number.
- */
-phone?: string
-/**
- * Company name, if the customer is a legal entity.
- */
-corporateName?: string
-/**
- * Trade name, if the customer is a legal entity.
- */
-tradeName?: string
-/**
- * Corporate document, if the customer is a legal entity.
- */
-corporateDocument?: string
-/**
- * State inscription, if the customer is a legal entity.
- */
-stateInscription?: string
-/**
- * Corporate phone number, if the customer is a legal entity.
- */
-corporatePhone?: string
-/**
- * `true` if the customer is a legal entity.
- */
-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.
- * 
- * 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.
- * 
- * >⚠️ 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": {
-body: {
-/**
- * This field should be sent as `false` to prevent the address information from being filled in automatically based on the `postalCode` information.
- */
-clearAddressIfPostalCodeNotFound?: boolean
-/**
- * List of objects with addresses information.
- */
-selectedAddresses?: {
-/**
- * Type of address. For example, `Residential` or `Pickup`, among others.
- */
-addressType?: string
-/**
- * Name of the person who is going to receive the order.
- */
-receiverName?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Postal Code.
- */
-postalCode?: string
-/**
- * City of the shipping address.
- */
-city?: string
-/**
- * State of the shipping address.
- */
-state?: string
-/**
- * Three letter ISO code of the country of the shipping address.
- */
-country?: string
-/**
- * Street of the shipping address.
- */
-street?: string
-/**
- * Number of the building, house or apartment in the shipping address.
- */
-number?: string
-/**
- * Neighborhood of the shipping address.
- */
-neighborhood?: string
-/**
- * Complement to the shipping address in case it applies.
- */
-complement?: string
-/**
- * Complement that might help locate the shipping address more precisely in case of delivery.
- */
-reference?: string
-/**
- * Array containing two floats with geocoordinates, first longitude, then latitude.
- */
-geoCoordinates?: number[]
-}[]
-/**
- * Array with logistics information on each item of the `items` array in the `orderForm`.
- */
-logisticsInfo?: {
-/**
- * Index of item in items array
- */
-itemIndex?: number
-/**
- * Delivery channel selected by the customer. For example, `"delivery"` or `"pickup-in-point"`.
- */
-selectedDeliveryChannel?: string
-/**
- * Selected SLA. For example, `"normal"` or `"express"`.
- */
-selectedSla?: string
-}[]
-}
-response: {
-/**
- * ID of the `orderForm` corresponding to a specific cart.
- */
-orderFormId?: string
-/**
- * Attribute created by the seller, in their VTEX store configuration.
- */
-salesChannel?: string
-/**
- * Indicates whether the user is logged into the store.
- */
-loggedIn?: boolean
-/**
- * Indicates whether order is checked in.
- */
-isCheckedIn?: boolean
-/**
- * ID of the store.
- */
-storeId?: (null | string)
-/**
- * Checked in pickuppoint identification.
- */
-checkedInPickupPointId?: (null | string)
-/**
- * Permission to modify item price manually.
- */
-allowManualPrice?: boolean
-/**
- * Data can be edited.
- */
-canEditData?: boolean
-/**
- * Unique ID associated with the customer profile.
- */
-userProfileId?: (null | string)
-/**
- * User type.
- */
-userType?: (null | string)
-/**
- * Ignore customer profile data.
- */
-ignoreProfileData?: boolean
-/**
- * Total value of the order without separating cents. For example, $24.99 is represented `2499`.
- */
-value?: number
-/**
- * Array containing an object for each message generated by our servers while processing the request.
- */
-messages?: any[]
-/**
- * Information on each item in the order.
- */
-items?: {
-/**
- * Unique ID.
- */
-uniqueId?: string
-/**
- * ID of the item.
- */
-id?: string
-/**
- * Product ID.
- */
-productId?: string
-/**
- * Product Ref ID.
- */
-productRefId?: string
-/**
- * Ref ID.
- */
-refId?: string
-/**
- * European Article Number.
- */
-ean?: (null | string)
-/**
- * Product name.
- */
-name?: string
-/**
- * SKU name.
- */
-skuName?: string
-/**
- * Modal type.
- */
-modalType?: (null | string)
-/**
- * Parent item index.
- */
-parentItemIndex?: (null | number)
-/**
- * Parent assembly binding.
- */
-parentAssemblyBinding?: (null | string)
-/**
- * Price expiration date and time.
- */
-priceValidUntil?: string
-/**
- * Tax value in cents.
- */
-tax?: number
-/**
- * Price in cents.
- */
-price?: number
-/**
- * List price in cents.
- */
-listPrice?: number
-/**
- * Manual price in cents.
- */
-manualPrice?: (null | number)
-/**
- * User that applied the manual price, if that is the case.
- */
-manualPriceAppliedBy?: (null | string)
-/**
- * Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
- */
-sellingPrice?: number
-/**
- * Reward value in cents.
- */
-rewardValue?: number
-/**
- * Indicates whether item is a gift.
- */
-isGift?: boolean
-/**
- * Additional information.
- */
-additionalInfo?: {
-/**
- * Dimension.
- */
-dimension?: (null | string)
-/**
- * Brand name.
- */
-brandName?: string
-/**
- * Brand ID.
- */
-brandId?: string
-/**
- * Offering information.
- */
-offeringInfo?: (null | string)
-/**
- * Offering type.
- */
-offeringType?: (null | string)
-/**
- * Offering type ID.
- */
-offeringTypeId?: (null | string)
-}
-/**
- * Presale date.
- */
-preSaleDate?: (null | string)
-/**
- * Product category IDs.
- */
-productCategoryIds?: string
-/**
- * Object, where each field is an ID from `productCategoryIds`.
- */
-productCategories?: {
-/**
- * Product category corresponding to the ID in the field key.
- */
-"{ID}"?: string
-}
-/**
- * Quantity.
- */
-quantity?: number
-/**
- * Seller.
- */
-seller?: string
-/**
- * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
- */
-sellerChain?: string[]
-/**
- * Image URL.
- */
-imageUrl?: string
-/**
- * Detail URL.
- */
-detailUrl?: string
-/**
- * Information on services sold along with the SKU. Example: a gift package.
- */
-bundleItems?: {
-/**
- * Service type.
- */
-type?: string
-/**
- * Service identifier.
- */
-id?: number
-/**
- * Service name.
- */
-name?: string
-/**
- * Service price in cents.
- */
-price?: number
-}[]
-/**
- * Array containing information on attachments.
- */
-attachments?: string[]
-/**
- * Array of price tags, each of which, modifies the price in some way, like discounts or rates that apply to the item in the context of the order.
- */
-priceTags?: {
-/**
- * Price tag identifier.
- */
-identifier?: string
-/**
- * Indicates whether price tag value is applied through a percentage.
- */
-isPercentual?: boolean
-/**
- * Price tag name.
- */
-name?: string
-/**
- * Price tag raw value.
- */
-rawValue?: number
-/**
- * Price tag value.
- */
-value?: number
-}[]
-/**
- * Availability.
- */
-availability?: string
-/**
- * Measurement unit.
- */
-measurementUnit?: string
-/**
- * Unit multiplier.
- */
-unitMultiplier?: number
-/**
- * Manufacturer code.
- */
-manufacturerCode?: (null | string)
-/**
- * Price information for all units of a specific item.
- */
-priceDefinition?: {
-/**
- * Item's calculated unitary selling price in cents.
- */
-calculatedSellingPrice?: number
-/**
- * Total value for all units of the item in cents.
- */
-total?: number
-/**
- * Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
- */
-sellingPrices?: {
-/**
- * Value in cents for that specific rounding.
- */
-value?: number
-/**
- * Rounding quantity, meaning how many items are rounded to this value.
- */
-quantity?: number
-}[]
-}
-}[]
-/**
- * Array containing the data of the item selected as a gift.
- */
-selectableGifts?: any[]
-/**
- * Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).
- */
-totalizers?: any[]
-/**
- * Shipping information pertinent to the order.
- */
-shippingData?: {
-/**
- * Address information.
- */
-address?: {
-/**
- * Type of address. For example, `Residential` or `Pickup`.
- */
-addressType?: string
-/**
- * Name of the person who is going to receive the order.
- */
-receiverName?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Indicates whether address is disposable.
- */
-isDisposable?: boolean
-/**
- * Postal code.
- */
-postalCode?: string
-/**
- * City of the shipping address.
- */
-city?: string
-/**
- * State of the shipping address.
- */
-state?: string
-/**
- * Three letter ISO code of the country of the shipping address.
- */
-country?: string
-/**
- * Street of the shipping address.
- */
-street?: string
-/**
- * Number of the building, house or apartment in the shipping address.
- */
-number?: string
-/**
- * Neighborhood of the shipping address.
- */
-neighborhood?: string
-/**
- * Complement to the shipping address, in case it applies.
- */
-complement?: (null | string)
-/**
- * Complement that might help locate the shipping address more precisely in case of delivery.
- */
-reference?: (null | string)
-/**
- * Array containing two floats with geocoordinates, first longitude, then latitude.
- */
-geoCoordinates?: number[]
-}
-/**
- * Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.
- */
-logisticsInfo?: {
-/**
- * Index corresponding to the position of the object in the `items` array.
- */
-itemIndex?: number
-/**
- * SLA selected by the customer.
- */
-selectedSla?: (null | string)
-/**
- * Delivery channel selected by the customer.
- */
-selectedDeliveryChannel?: (null | string)
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Information on available SLAs.
- */
-slas?: {
-/**
- * SLA ID.
- */
-id?: string
-/**
- * Delivery channel.
- */
-deliveryChannel?: string
-/**
- * SLA name.
- */
-name?: string
-/**
- * Information on each delivery ID.
- */
-deliveryIds?: {
-/**
- * Courier ID.
- */
-courierId?: string
-/**
- * Warehouse ID.
- */
-warehouseId?: string
-/**
- * Warehouse ID.
- */
-dockId?: string
-/**
- * Courier name.
- */
-courierName?: string
-/**
- * Quantity.
- */
-quantity?: number
-}[]
-/**
- * Shipping estimate. For instance, Three business days will be represented `3bd`.
- */
-shippingEstimate?: string
-/**
- * Shipping estimate date.
- */
-shippingEstimateDate?: (null | string)
-/**
- * Estimate date of delivery.
- */
-lockTTL?: (null | string)
-/**
- * This object contains information about the delivery window available to the shopper.
- */
-availableDeliveryWindows?: {
-/**
- * Delivery window starting day and time in UTC.
- */
-startDateUtc?: string
-/**
- * Delivery window ending day and time in UTC.
- */
-endDateUtc?: string
-/**
- * Delivery window price.
- */
-price?: number
-/**
- * Delivery window list price.
- */
-lisPrice?: number
-/**
- * Delivery window tax.
- */
-tax?: number
-}
-/**
- * In case of scheduled delivery, this object will contain information on the delivery window selected by the shopper.
- */
-deliveryWindow?: {
-/**
- * Delivery window starting day and time in UTC.
- */
-startDateUtc?: string
-/**
- * Delivery window ending day and time in UTC.
- */
-endDateUtc?: string
-/**
- * Delivery window price.
- */
-price?: number
-/**
- * Delivery window list price.
- */
-lisPrice?: number
-/**
- * Delivery window tax.
- */
-tax?: number
-}
-/**
- * Price in cents.
- */
-price?: number
-/**
- * List price in cents.
- */
-listPrice?: number
-/**
- * Tax in cents.
- */
-tax?: number
-/**
- * Information on the pickup store.
- */
-pickupStoreInfo?: {
-/**
- * Indicates whether it is the pickup store.
- */
-isPickupStore?: boolean
-/**
- * Friendly name.
- */
-friendlyName?: (null | string)
-/**
- * Address information.
- */
-address?: (null | {
-/**
- * Type of address. For example, `Residential` or `Pickup`.
- */
-addressType?: string
-/**
- * Name of the person who is going to receive the order.
- */
-receiverName?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Indicates whether address is disposable.
- */
-isDisposable?: boolean
-/**
- * Postal code.
- */
-postalCode?: string
-/**
- * City of the shipping address.
- */
-city?: string
-/**
- * State of the shipping address.
- */
-state?: string
-/**
- * Three letter ISO code of the country of the shipping address.
- */
-country?: string
-/**
- * Street of the shipping address.
- */
-street?: string
-/**
- * Number of the building, house or apartment in the shipping address.
- */
-number?: string
-/**
- * Neighborhood of the shipping address.
- */
-neighborhood?: string
-/**
- * Complement to the shipping address, in case it applies.
- */
-complement?: (null | string)
-/**
- * Complement that might help locate the shipping address more precisely in case of delivery.
- */
-reference?: (null | string)
-/**
- * Array containing two floats with geocoordinates, first longitude, then latitude.
- */
-geoCoordinates?: number[]
-})
-/**
- * Additional information.
- */
-additionalInfo?: (null | string)
-/**
- * Corresponding dock ID.
- */
-dockId?: (null | string)
-}
-/**
- * Pickup point ID.
- */
-pickupPointId?: (null | string)
-/**
- * Pickup point distance.
- */
-pickupDistance?: number
-/**
- * Polygon name.
- */
-polygonName?: (null | string)
-/**
- * Transit time. For instance, "three business days" is represented `3bd`.
- */
-transitTime?: string
-}[]
-/**
- * List of countries that the item may be shipped to.
- */
-shipsTo?: string[]
-/**
- * Item ID.
- */
-itemId?: string
-/**
- * List of available delivery channels.
- */
-deliveryChannels?: {
-/**
- * Delivery channel ID.
- */
-id?: string
-}[]
-}[]
-/**
- * Array with information on the selected addresses for the order.
- */
-selectedAddresses?: {
-/**
- * Type of address. For example, `Residential` or `Pickup`.
- */
-addressType?: string
-/**
- * Name of the person who is going to receive the order.
- */
-receiverName?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Indicates whether address is disposable.
- */
-isDisposable?: boolean
-/**
- * Postal code.
- */
-postalCode?: string
-/**
- * City of the shipping address.
- */
-city?: string
-/**
- * State of the shipping address.
- */
-state?: string
-/**
- * Three letter ISO code of the country of the shipping address.
- */
-country?: string
-/**
- * Street of the shipping address.
- */
-street?: string
-/**
- * Number of the building, house or apartment in the shipping address.
- */
-number?: string
-/**
- * Neighborhood of the shipping address.
- */
-neighborhood?: string
-/**
- * Complement to the shipping address, in case it applies.
- */
-complement?: (null | string)
-/**
- * Complement that might help locate the shipping address more precisely in case of delivery.
- */
-reference?: (null | string)
-/**
- * Array containing two floats with geocoordinates, first longitude, then latitude.
- */
-geoCoordinates?: number[]
-}[]
-/**
- * Information on each available address.
- */
-availableAddresses?: {
-/**
- * Address type.
- */
-addressType?: string
-/**
- * Name of the receiver.
- */
-receiverName?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Indicates whether address is disposable.
- */
-isDisposable?: boolean
-/**
- * City of the address.
- */
-city?: string
-/**
- * State of the address.
- */
-state?: string
-/**
- * Country of the address. ISO three-letter code.
- */
-country?: string
-/**
- * Street of the address.
- */
-street?: string
-/**
- * Number of the address.
- */
-number?: string
-/**
- * Neighborhood of the address.
- */
-neighborhood?: string
-/**
- * Complement to the address.
- */
-complement?: (null | string)
-/**
- * Reference that may help in the location of the address.
- */
-reference?: (null | string)
-/**
- * Array containing two floats with geocoordinates, first longitude, then latitude.
- */
-geoCoordinates?: number[]
-}[]
-/**
- * Array containing pickup points information.
- */
-pickupPoints?: any[]
-}
-/**
- * Customer's profile information.
- */
-clientProfileData?: {
-/**
- * Email address.
- */
-email?: string
-/**
- * First name.
- */
-firstName?: string
-/**
- * Last name.
- */
-lastName?: string
-/**
- * Type of the document informed by the customer.
- */
-documentType?: string
-/**
- * Document informed by the customer.
- */
-document?: string
-/**
- * Phone number.
- */
-phone?: string
-/**
- * Company name, if the customer is a legal entity.
- */
-corporateName?: (null | string)
-/**
- * Trade name, if the customer is a legal entity.
- */
-tradeName?: (null | string)
-/**
- * Corporate document, if the customer is a legal entity.
- */
-corporateDocument?: (null | string)
-/**
- * State inscription, if the customer is a legal entity.
- */
-stateInscription?: (null | string)
-/**
- * Corporate phone number, if the customer is a legal entity.
- */
-corporatePhone?: (null | string)
-/**
- * Indicates whether the customer is a legal entity.
- */
-isCorporate?: boolean
-/**
- * Indicates whether profile is complete on loading.
- */
-profileCompleteOnLoading?: boolean
-/**
- * Indicates whether profile presents error on loading.
- */
-profileErrorOnLoading?: (null | boolean)
-/**
- * Customer class.
- */
-customerClass?: (null | string)
-}
-/**
- * Payment data information.
- */
-paymentData?: {
-/**
- * Indicate whether this object's information is up to date according to the order's items. An order can not be placed if `"outdated"`
- */
-updateStatus?: string
-/**
- * Installment options information.
- */
-installmentOptions?: any[]
-/**
- * Information on payment systems.
- */
-paymentSystems?: {
-/**
- * Payment system ID.
- */
-id?: number
-/**
- * Payment system name.
- */
-name?: string
-/**
- * Payment group name.
- */
-groupName?: string
-/**
- * Payment system validator.
- */
-validator?: (null | {
-
-})
-/**
- * String ID.
- */
-stringId?: string
-/**
- * Template.
- */
-template?: string
-/**
- * Indicates whether a document is required.
- */
-requiresDocument?: boolean
-/**
- * Indicates whether a document is shown.
- */
-displayDocument?: boolean
-/**
- * Indicates whether it is custom.
- */
-isCustom?: boolean
-/**
- * Description.
- */
-description?: string
-/**
- * Indicates whether a authentication is required.
- */
-requiresAuthentication?: boolean
-/**
- * Payment due date.
- */
-dueDate?: string
-/**
- * Availability of payment.
- */
-availablePayments?: (null | string)
-}[]
-/**
- * Information on each payment.
- */
-payments?: any[]
-/**
- * Gift card information, if it applies to the order.
- */
-giftCards?: any[]
-/**
- * Array of gift card messages.
- */
-giftCardMessages?: any[]
-/**
- * Available accounts.
- */
-availableAccounts?: any[]
-/**
- * Available tokens.
- */
-availableTokens?: any[]
-/**
- * Available associations.
- */
-availableAssociations?: {
-
-}
-}
-/**
- * Object containing promotion data such as coupon tracking information and internal or external UTMs.
- */
-marketingData?: (null | {
-
-})
-/**
- * Information on each seller.
- */
-sellers?: {
-/**
- * Seller ID.
- */
-id?: string
-/**
- * Seller name.
- */
-name?: string
-/**
- * Seller logo.
- */
-logo?: (null | string)
-}[]
-/**
- * Object containing preferences from the client who placed the order.
- */
-clientPreferencesData?: {
-/**
- * Client's locale. Examples: `pt-BR` and `en-US`.
- */
-locale?: string
-/**
- * `true` if the client opted to receive newsletter from the store.
- */
-optinNewsLetter?: boolean
-}
-/**
- * Object containing commercial condition information.
- */
-commercialConditionData?: (null | {
-
-})
-/**
- * Object containing data from the store's configuration (stored in VTEX's License Manager).
- */
-storePreferencesData?: {
-/**
- * Three letters ISO code of the country (ISO 3166 ALPHA-3).
- */
-countryCode?: string
-/**
- * Defines whether the customer want the store to keep their personal and payment data saved.
- */
-saveUserData?: boolean
-/**
- * Time zone from where the order was made.
- */
-timeZone?: string
-/**
- * Currency code in ISO 4217. For example, `BRL`.
- */
-currencyCode?: string
-/**
- * Currency Locale Code in LCID in decimal.
- */
-currencyLocale?: number
-/**
- * Currency symbol.
- */
-currencySymbol?: string
-/**
- * Object with currency format details.
- */
-CurrencyFormatInfo?: {
-/**
- * Quantity of currency decimal digits.
- */
-CurrencyDecimalDigits?: number
-/**
- * Defines what currency decimal separator will be applied.
- */
-CurrencyDecimalSeparator?: string
-/**
- * Defines what currency group separator will be applied.
- */
-CurrencyGroupSeparator?: string
-/**
- * Defines how many characters will be grouped.
- */
-CurrencyGroupSize?: number
-/**
- * Defines if all prices will be initiated with the currency symbol (`true`) or not (`false`).
- */
-StartsWithCurrencySymbol?: boolean
-}
-}
-/**
- * Gift registry list information.
- */
-giftRegistryData?: (null | {
-
-})
-/**
- * Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).
- */
-openTextField?: (null | string)
-/**
- * Object containing information pertinent to the order's invoice.
- */
-invoiceData?: (null | {
-
-})
-/**
- * Customer additional information.
- */
-customData?: (null | {
-
-})
-/**
- * Item metadata.
- */
-itemMetadata?: (null | {
-
-})
-/**
- * Hooks information.
- */
-hooksData?: (null | {
-
-})
-/**
- * Information on rates and benefits that apply to the order.
- */
-ratesAndBenefitsData?: (null | {
-
-})
-/**
- * Subscription information.
- */
-subscriptionData?: (null | {
-
-})
-/**
- * Object containing information about the ordering of items within the orderForm.
- */
-itemsOrdination?: (null | {
-
-})
-}
-}
-/**
- * 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.
- */
-"POST /api/checkout/pub/orderForm/:orderFormId/attachments/clientPreferencesData": {
-body: {
-/**
- * Locale chosen by the shopper. Determines website language.
- */
-locale?: string
-/**
- * Indicates whether the shopper opted in to receive the store's news letter.
- */
-optinNewsLetter?: boolean
-}
-response: any
-}
-/**
- * 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.
- */
-"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"`.
- */
-coupon?: string
-/**
- * Marketing tags. Limited to a maximum of 50 items.
- */
-marketingTags?: string[]
-/**
- * UTM source.
- */
-utmSource?: string
-/**
- * UTM medium.
- */
-utmMedium?: string
-/**
- * UTM campaign
- */
-utmCampaign?: string
-/**
- * utmi_page (internal utm)
- */
-utmiPage?: string
-/**
- * utmi_part (internal utm)
- */
-utmiPart?: string
-/**
- * utmi_campaign (internal utm)
- */
-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.
- * 
- * 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.
- */
-"POST /api/checkout/pub/orderForm/:orderFormId/attachments/paymentData": {
-body: {
-/**
- * Array with information on each payment chosen by the shopper.
- */
-payments?: {
-/**
- * Payment system ID.
- */
-paymentSystem?: number
-/**
- * Payment system name.
- */
-paymentSystemName?: string
-/**
- * Payment system group.
- */
-group?: string
-/**
- * Selected number of installments.
- */
-installments?: number
-/**
- * Installments' interest rate.
- */
-installmentsInterestRate?: number
-/**
- * Value of the installments.
- */
-installmentsValue?: number
-/**
- * Total value assigned to this payment.
- */
-value?: number
-/**
- * Reference value used to calculate total order value with interest.
- */
-referenceValue?: number
-/**
- * Indicates whether billing address for this payment is the default address.
- */
-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.
- * 
- * 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.
- */
-"POST /api/checkout/pub/orderForm/:orderFormId/attachments/merchantContextData": {
-body: {
-/**
- * Sales Associate information.
- */
-salesAssociateData: {
-/**
- * Sales Associate (Seller) identification code. All information should be registered by the merchant. Maximum of 100 characters.
- */
-salesAssociateId?: string
-}
-}
-response: {
-/**
- * Sales Associate (Seller) identification code.
- */
-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`).
- * 
- * 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": {
-/**
- * Here you must add the pairs of Field Name and Field Value.
- */
-body: {
-[k: string]: any
-}
-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).
- * 
- * 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": {
-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.
- */
-"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.
- */
-"GET /api/checkout/pvt/configuration/orderForm": {
-response: {
-/**
- * Payment configuration information.
- */
-paymentConfiguration?: {
-/**
- * Determines whether pre-authorized payments require authentication.
- */
-requiresAuthenticationForPreAuthorizedPaymentOption?: boolean
-/**
- * By default (when `false`), on a multi-seller purchase is on the run, a simple intersection with installment options configured by every seller will be available. When indicated as `true`, this option allows a more complex but flexible installment option, since it considers max installments of every seller configuration, even if those do not match. Installment values may not be equal in this case.
- */
-allowInstallmentsMerge?: boolean
-}
-/**
- * External tax service configuration information.
- */
-taxConfiguration?: (null | {
-/**
- * Endpoint URL.
- */
-url?: (null | string)
-/**
- * Authorization header.
- */
-authorizationHeader?: (null | string)
-/**
- * Custom data ID sent to the tax system.
- */
-appId?: string
-})
-/**
- * Minimum SKU quantity by cart.
- */
-minimumQuantityAccumulatedForItems?: number
-/**
- * Number of price digits.
- */
-decimalDigitsPrecision?: number
-/**
- * Minimum cart value.
- */
-minimumValueAccumulated?: (null | number)
-/**
- * Array of objects containing Apps configuration information.
- */
-apps?: (null | {
-/**
- * App ID.
- */
-id?: string
-/**
- * Array of fields available to the app.
- */
-fields?: string[]
-/**
- * App major version.
- */
-major?: number
-}[])
-/**
- * On the same purchase, allows the selection of items from multiple delivery channels.
- */
-allowMultipleDeliveries?: (null | boolean)
-/**
- * Allows the editing of SKU prices right in the cart.
- */
-allowManualPrice?: (null | boolean)
-/**
- * Allows users to select whether they want the store to keep their personal and payment data saved.
- */
-savePersonalDataAsOptIn?: (null | boolean)
-/**
- * Allows the input of a limit of white label sellers involved on the cart.
- */
-maxNumberOfWhiteLabelSellers?: (null | number)
-/**
- * Allows, on a first purchase, masking client's data. It could be useful when a shared cart is used and the client does not want to share its data.
- */
-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.
- */
-recaptchaValidation?: string
-/**
- * Indicates whether authentication is required for completing purchases.
- */
-requiresLoginToPlaceOrder?: boolean
-/**
- * Minimum interval (in seconds) between successive purchases.
- */
-minimumPurchaseDowntimeSeconds?: number
-/**
- * Minimum cart existence period (in seconds) before allowing the use of a new credit card.
- */
-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).
- */
-"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.
- */
-"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.
- */
-"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.
- * 
- * **Important**: **Request Body** must always be sent with empty value "{ }" in this endpoint.
- */
-"POST /api/checkout/pub/orderForm/:orderFormId/messages/clear": {
-/**
- * This object must be empty.
- */
-body: {
-
-}
-response: {
-/**
- * ID of the orderForm corresponding to a specific cart.
- */
-orderFormId?: string
-/**
- * Attribute created by the seller, in their VTEX store configuration.
- */
-salesChannel?: string
-/**
- * Indicates whether the user is logged into the store.
- */
-loggedIn?: boolean
-/**
- * Indicates whether order is checked in.
- */
-isCheckedIn?: boolean
-/**
- * ID of the store.
- */
-storeId?: (null | string)
-/**
- * Permission to modify item price manually.
- */
-allowManualPrice?: boolean
-/**
- * Data can be edited.
- */
-canEditData?: boolean
-/**
- * Unique ID associated with the customer profile.
- */
-userProfileId?: string
-/**
- * Profile provider.
- */
-profileProvider?: string
-/**
- * Available accounts.
- */
-availableAccounts?: string[]
-/**
- * Information on each available address.
- */
-availableAddresses?: {
-/**
- * Address type.
- */
-addressType?: string
-/**
- * Name of the receiver.
- */
-receiverName?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Indicates whether address is disposable.
- */
-isDisposable?: boolean
-/**
- * City of the address.
- */
-city?: string
-/**
- * State of the address.
- */
-state?: string
-/**
- * Country of the address. ISO three-letter code.
- */
-country?: string
-/**
- * Street of the address.
- */
-street?: string
-/**
- * Number of the address.
- */
-number?: string
-/**
- * Neighborhood of the address.
- */
-neighborhood?: string
-/**
- * Complement to the address.
- */
-complement?: (null | string)
-/**
- * Reference that may help in the location of the address.
- */
-reference?: (null | string)
-/**
- * Array containing two floats with geocoordinates, first longitude, then latitude.
- */
-geoCoordinates?: number[]
-}[]
-/**
- * User type.
- */
-userType?: (null | string)
-/**
- * Ignore customer profile data.
- */
-ignoreProfileData?: boolean
-/**
- * Total value of the order without separating cents. For example, $24.99 is represented `2499`.
- */
-value?: number
-/**
- * Array containing an object for each message generated by our servers while processing the request.
- */
-messages?: any[]
-/**
- * Information on each item in the order.
- */
-items?: {
-/**
- * Unique ID.
- */
-uniqueId?: string
-/**
- * ID of the item.
- */
-id?: string
-/**
- * Product ID.
- */
-productId?: string
-/**
- * Product Ref ID.
- */
-productRefId?: string
-/**
- * Ref ID.
- */
-refId?: string
-/**
- * European Article Number.
- */
-ean?: (null | string)
-/**
- * Product name.
- */
-name?: string
-/**
- * SKU name.
- */
-skuName?: string
-/**
- * Modal type.
- */
-modalType?: (null | string)
-/**
- * Parent item index.
- */
-parentItemIndex?: (null | number)
-/**
- * Parent assembly binding.
- */
-parentAssemblyBinding?: (null | string)
-/**
- * Price expiration date and time.
- */
-priceValidUntil?: string
-/**
- * Tax value in cents.
- */
-tax?: number
-/**
- * Price in cents.
- */
-price?: number
-/**
- * List price in cents.
- */
-listPrice?: number
-/**
- * Manual price in cents.
- */
-manualPrice?: (null | number)
-/**
- * User that applied the manual price, if that is the case.
- */
-manualPriceAppliedBy?: (null | string)
-/**
- * Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
- */
-sellingPrice?: number
-/**
- * Reward value in cents.
- */
-rewardValue?: number
-/**
- * Indicates whether item is a gift.
- */
-isGift?: boolean
-/**
- * Additional information.
- */
-additionalInfo?: {
-/**
- * Dimension.
- */
-dimension?: (null | string)
-/**
- * Brand name.
- */
-brandName?: string
-/**
- * Brand ID.
- */
-brandId?: string
-/**
- * Offering information.
- */
-offeringInfo?: (null | string)
-/**
- * Offering type.
- */
-offeringType?: (null | string)
-/**
- * Offering type ID.
- */
-offeringTypeId?: (null | string)
-}
-/**
- * Presale date.
- */
-preSaleDate?: (null | string)
-/**
- * Product category IDs.
- */
-productCategoryIds?: string
-/**
- * Object, where each field is an ID from `productCategoryIds`.
- */
-productCategories?: {
-/**
- * Product category corresponding to the ID in the field key.
- */
-"{ID}"?: string
-}
-/**
- * Quantity.
- */
-quantity?: number
-/**
- * Seller.
- */
-seller?: string
-/**
- * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
- */
-sellerChain?: string[]
-/**
- * Image URL.
- */
-imageUrl?: string
-/**
- * Detail URL.
- */
-detailUrl?: string
-/**
- * Information on services sold along with the SKU. Example: a gift package.
- */
-bundleItems?: {
-/**
- * Service type.
- */
-type?: string
-/**
- * Service identifier.
- */
-id?: number
-/**
- * Service name.
- */
-name?: string
-/**
- * Service price in cents.
- */
-price?: number
-}[]
-/**
- * Array containing information on attachments.
- */
-attachments?: string[]
-/**
- * Array of price tags, each of which, modifies the price in some way, like discounts or rates that apply to the item in the context of the order.
- */
-priceTags?: {
-/**
- * Price tag identifier.
- */
-identifier?: string
-/**
- * Indicates whether price tag value is applied through a percentage.
- */
-isPercentual?: boolean
-/**
- * Price tag name.
- */
-name?: string
-/**
- * Price tag raw value.
- */
-rawValue?: number
-/**
- * Price tag value.
- */
-value?: number
-}[]
-/**
- * Availability.
- */
-availability?: string
-/**
- * Measurement unit.
- */
-measurementUnit?: string
-/**
- * Unit multiplier.
- */
-unitMultiplier?: number
-/**
- * Manufacturer code.
- */
-manufacturerCode?: (null | string)
-/**
- * Price information for all units of a specific item.
- */
-priceDefinition?: {
-/**
- * Item's calculated unitary selling price in cents.
- */
-calculatedSellingPrice?: number
-/**
- * Total value for all units of the item in cents.
- */
-total?: number
-/**
- * Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
- */
-sellingPrices?: {
-/**
- * Value in cents for that specific rounding.
- */
-value?: number
-/**
- * Rounding quantity, meaning how many items are rounded to this value.
- */
-quantity?: number
-}[]
-}
-}[]
-/**
- * Array containing the data of the item selected as a gift.
- */
-selectableGifts?: any[]
-/**
- * Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).
- */
-totalizers?: any[]
-/**
- * Shipping information pertinent to the order.
- */
-shippingData?: {
-/**
- * Address information.
- */
-address?: {
-/**
- * Type of address. For example, `Residential` or `Pickup`.
- */
-addressType?: string
-/**
- * Name of the person who is going to receive the order.
- */
-receiverName?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Indicates whether address is disposable.
- */
-isDisposable?: boolean
-/**
- * Postal code.
- */
-postalCode?: string
-/**
- * City of the shipping address.
- */
-city?: string
-/**
- * State of the shipping address.
- */
-state?: string
-/**
- * Three letter ISO code of the country of the shipping address.
- */
-country?: string
-/**
- * Street of the shipping address.
- */
-street?: string
-/**
- * Number of the building, house or apartment in the shipping address.
- */
-number?: string
-/**
- * Neighborhood of the shipping address.
- */
-neighborhood?: string
-/**
- * Complement to the shipping address, in case it applies.
- */
-complement?: (null | string)
-/**
- * Complement that might help locate the shipping address more precisely in case of delivery.
- */
-reference?: (null | string)
-/**
- * Array containing two floats with geocoordinates, first longitude, then latitude.
- */
-geoCoordinates?: number[]
-}
-/**
- * Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.
- */
-logisticsInfo?: {
-/**
- * Index corresponding to the position of the object in the `items` array.
- */
-itemIndex?: number
-/**
- * SLA selected by the customer.
- */
-selectedSla?: string
-/**
- * Delivery channel selected by the customer.
- */
-selectedDeliveryChannel?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Information on available SLAs.
- */
-slas?: {
-/**
- * SLA ID.
- */
-id?: string
-/**
- * Delivery channel.
- */
-deliveryChannel?: string
-/**
- * SLA name.
- */
-name?: string
-/**
- * Information on each delivery ID.
- */
-deliveryIds?: {
-/**
- * Courier ID.
- */
-courierId?: string
-/**
- * Warehouse ID.
- */
-warehouseId?: string
-/**
- * Warehouse ID.
- */
-dockId?: string
-/**
- * Courier name.
- */
-courierName?: string
-/**
- * Quantity.
- */
-quantity?: number
-}[]
-/**
- * Shipping estimate. For instance, Three business days will be represented `3bd`.
- */
-shippingEstimate?: string
-/**
- * Shipping estimate date.
- */
-shippingEstimateDate?: (null | string)
-/**
- * Estimate date of delivery.
- */
-lockTTL?: string
-/**
- * Price in cents.
- */
-price?: number
-/**
- * List price in cents.
- */
-listPrice?: number
-/**
- * Tax in cents.
- */
-tax?: number
-/**
- * Information on the pickup store.
- */
-pickupStoreInfo?: {
-/**
- * Indicates whether it is the pickup store.
- */
-isPickupStore?: boolean
-/**
- * Friendly name.
- */
-friendlyName?: (null | string)
-/**
- * Address information.
- */
-address?: (null | {
-/**
- * Type of address. For example, `Residential` or `Pickup`.
- */
-addressType?: string
-/**
- * Postal code.
- */
-postalCode?: string
-/**
- * City of the shipping address.
- */
-city?: string
-/**
- * State of the shipping address.
- */
-state?: string
-/**
- * Three letter ISO code of the country of the shipping address.
- */
-country?: string
-/**
- * Street of the shipping address.
- */
-street?: string
-/**
- * Number of the building, house or apartment in the shipping address.
- */
-number?: string
-/**
- * Neighborhood of the shipping address.
- */
-neighborhood?: string
-/**
- * Complement to the shipping address, in case it applies.
- */
-complement?: (null | string)
-/**
- * Complement that might help locate the shipping address more precisely in case of delivery.
- */
-reference?: (null | string)
-/**
- * Array containing two floats with geocoordinates, first longitude, then latitude.
- */
-geoCoordinates?: number[]
-})
-/**
- * Additional information.
- */
-additionalInfo?: (null | string)
-/**
- * Corresponding dock ID.
- */
-dockId?: (null | string)
-}
-/**
- * Pickup point ID.
- */
-pickupPointId?: (null | string)
-/**
- * Pickup point distance.
- */
-pickupDistance?: number
-/**
- * Polygon name.
- */
-polygonName?: (null | string)
-/**
- * Transit time. For instance, "three business days" is represented `3bd`.
- */
-transitTime?: string
-}[]
-/**
- * List of countries that the item may be shipped to.
- */
-shipsTo?: string[]
-/**
- * Item ID.
- */
-itemId?: string
-/**
- * List of available delivery channels.
- */
-deliveryChannels?: {
-/**
- * Delivery channel ID.
- */
-id?: string
-}[]
-}[]
-/**
- * Array with information on the selected addresses for the order.
- */
-selectedAddresses?: {
-/**
- * Type of address. For example, `Residential` or `Pickup`.
- */
-addressType?: string
-/**
- * Name of the person who is going to receive the order.
- */
-receiverName?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Indicates whether address is disposable.
- */
-isDisposable?: boolean
-/**
- * Postal code.
- */
-postalCode?: string
-/**
- * City of the shipping address.
- */
-city?: string
-/**
- * State of the shipping address.
- */
-state?: string
-/**
- * Three letter ISO code of the country of the shipping address.
- */
-country?: string
-/**
- * Street of the shipping address.
- */
-street?: string
-/**
- * Number of the building, house or apartment in the shipping address.
- */
-number?: string
-/**
- * Neighborhood of the shipping address.
- */
-neighborhood?: string
-/**
- * Complement to the shipping address, in case it applies.
- */
-complement?: string
-/**
- * Complement that might help locate the shipping address more precisely in case of delivery.
- */
-reference?: (null | string)
-/**
- * Array containing two floats with geocoordinates, first longitude, then latitude.
- */
-geoCoordinates?: number[]
-}[]
-/**
- * Array with information on the available addresses for the order.
- */
-availableAddresses?: {
-/**
- * Type of address. For example, `Residential` or `Pickup`.
- */
-addressType?: string
-/**
- * Name of the person who is going to receive the order.
- */
-receiverName?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Indicates whether address is disposable.
- */
-isDisposable?: boolean
-/**
- * Postal code.
- */
-postalCode?: string
-/**
- * City of the shipping address.
- */
-city?: string
-/**
- * State of the shipping address.
- */
-state?: string
-/**
- * Three letter ISO code of the country of the shipping address.
- */
-country?: string
-/**
- * Street of the shipping address.
- */
-street?: string
-/**
- * Number of the building, house or apartment in the shipping address.
- */
-number?: string
-/**
- * Neighborhood of the shipping address.
- */
-neighborhood?: string
-/**
- * Complement to the shipping address, in case it applies.
- */
-complement?: string
-/**
- * Complement that might help locate the shipping address more precisely in case of delivery.
- */
-reference?: (null | string)
-/**
- * Array containing two floats with geocoordinates, first longitude, then latitude.
- */
-geoCoordinates?: number[]
-}[]
-}
-/**
- * Customer's profile information.
- */
-clientProfileData?: {
-/**
- * Email address.
- */
-email?: string
-/**
- * First name.
- */
-firstName?: string
-/**
- * Last name.
- */
-lastName?: string
-/**
- * Type of the document informed by the customer.
- */
-documentType?: string
-/**
- * Document informed by the customer.
- */
-document?: string
-/**
- * Phone number.
- */
-phone?: string
-/**
- * Company name, if the customer is a legal entity.
- */
-corporateName?: (null | string)
-/**
- * Trade name, if the customer is a legal entity.
- */
-tradeName?: (null | string)
-/**
- * Corporate document, if the customer is a legal entity.
- */
-corporateDocument?: (null | string)
-/**
- * State inscription, if the customer is a legal entity.
- */
-stateInscription?: (null | string)
-/**
- * Corporate phone number, if the customer is a legal entity.
- */
-corporatePhone?: (null | string)
-/**
- * Indicates whether the customer is a legal entity.
- */
-isCorporate?: boolean
-/**
- * Indicates whether profile is complete on loading.
- */
-profileCompleteOnLoading?: boolean
-/**
- * Indicates whether profile presents error on loading.
- */
-profileErrorOnLoading?: (null | boolean)
-/**
- * Customer class.
- */
-customerClass?: (null | string)
-}
-/**
- * Information on the order's payment.
- */
-paymentData?: {
-/**
- * Gift card information, if it applies to the order.
- */
-giftCards?: {
-/**
- * Gift card redemption code.
- */
-redemptionCode?: string
-/**
- * Gift card value in cents.
- */
-value?: number
-/**
- * Gift card balance in cents.
- */
-balance?: number
-/**
- * Gift card name.
- */
-name?: string
-/**
- * Gift card ID.
- */
-id?: string
-/**
- * Indicates whether gift card is in use.
- */
-inUse?: boolean
-/**
- * Indicates whether gift card is special.
- */
-isSpecialCard?: boolean
-}[]
-/**
- * Information on each transaction pertinent to the order.
- */
-transactions?: {
-/**
- * Indicates whether transaction is active.
- */
-isActive?: boolean
-/**
- * Transaction ID.
- */
-transactionId?: string
-/**
- * Merchant name.
- */
-merchantName?: string
-/**
- * Information on each payment.
- */
-payments?: {
-/**
- * Account ID.
- */
-accountId?: string
-/**
- * Bin.
- */
-bin?: string
-/**
- * Number of installments.
- */
-installments?: number
-/**
- * Payment system.
- */
-paymentSystem?: string
-/**
- * Reference value for calculating interest rates, in case it applies. Displayed in cents.
- */
-referenceValue?: number
-/**
- * Value including interest, in case it applies. Displayed in cents.
- */
-value?: number
-}[]
-/**
- * Indicates whather transaction is shared.
- */
-sharedTransaction?: boolean
-}[]
-}
-/**
- * Object containing promotion data such as coupon tracking information and internal or external UTMs.
- */
-marketingData?: {
-/**
- * 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.
- */
-coupon?: string
-/**
- * UTM source.
- */
-utmSource?: string
-/**
- * UTM medium.
- */
-utmMedium?: string
-/**
- * UTM campaign
- */
-utmCampaign?: string
-/**
- * utmi_page (internal utm)
- */
-utmiPage?: (null | string)
-/**
- * utmi_part (internal utm).
- */
-utmiPart?: (null | string)
-/**
- * utmi_campaign (internal utm).
- */
-utmiCampaign?: (null | string)
-}
-/**
- * Information on each seller.
- */
-sellers?: {
-/**
- * Seller ID.
- */
-id?: string
-/**
- * Seller name.
- */
-name?: string
-/**
- * Seller logo.
- */
-logo?: (null | string)
-}[]
-/**
- * Object containing preferences from the client who placed the order.
- */
-clientPreferencesData?: {
-/**
- * Client's locale. Examples: `pt-BR` and `en-US`.
- */
-locale?: string
-/**
- * `true` if the client opted to receive newsletter from the store.
- */
-optinNewsLetter?: boolean
-}
-/**
- * Object containing commercial condition information.
- */
-commercialConditionData?: (null | {
-
-})
-/**
- * Object containing data from the store's configuration (stored in VTEX's License Manager).
- */
-storePreferencesData?: {
-
-}
-/**
- * Gift registry list information.
- */
-giftRegistryData?: (null | {
-
-})
-/**
- * Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).
- */
-openTextField?: (null | string)
-/**
- * Object containing information pertinent to the order's invoice.
- */
-invoiceData?: (null | {
-
-})
-/**
- * Customer additional information.
- */
-customData?: (null | {
-
-})
-/**
- * Item metadata.
- */
-itemMetadata?: {
-/**
- * List of objects containing metadata on each item in the order.
- */
-items?: {
-/**
- * Item ID.
- */
-id?: string
-/**
- * Seller.
- */
-seller?: string
-/**
- * Product name.
- */
-name?: string
-/**
- * SKU name.
- */
-skuName?: string
-/**
- * Product ID.
- */
-productId?: string
-/**
- * Ref ID.
- */
-refId?: string
-/**
- * European Article Number.
- */
-ean?: (null | string)
-/**
- * Image URL.
- */
-imageUrl?: string
-/**
- * Detail URL.
- */
-detailUrl?: string
-}[]
-}
-/**
- * Hooks information.
- */
-hooksData?: (null | {
-
-})
-/**
- * Information on rates and benefits that apply to the order.
- */
-ratesAndBenefitsData?: {
-/**
- * List with rates and benefits identifiers.
- */
-rateAndBenefitsIdentifiers?: string[]
-/**
- * List with rates and benefits teasers.
- */
-teaser?: string[]
-}
-/**
- * Subscription information.
- */
-subscriptionData?: (null | {
-
-})
-/**
- * Object containing information about the ordering of items within the orderForm.
- */
-itemsOrdination?: {
-/**
- * Criteria adopted to order the items in the list.
- */
-criteria?: string
-/**
- * Indicates whether the ordering is ascending.
- */
-ascending?: boolean
-}
-}
-}
-/**
- * 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`.
- */
-"GET /api/checkout/pub/orderForm/:orderFormId/installments": {
-searchParams: {
-/**
- * ID of the payment method to be consulted for installments.
- */
-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"}.
- * 
- * 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": {
-body: {
-/**
- * Sending an existing coupon code in this field will return the corresponding discount in the purchase.
- */
-text?: string
-}
-response: {
-/**
- * ID of the orderForm corresponding to a specific cart.
- */
-orderFormId?: string
-/**
- * Attribute created by the seller, in their VTEX store configuration.
- */
-salesChannel?: string
-/**
- * Indicates whether the user is logged into the store.
- */
-loggedIn?: boolean
-/**
- * Indicates whether order is checked in.
- */
-isCheckedIn?: boolean
-/**
- * ID of the store.
- */
-storeId?: (null | string)
-/**
- * Permission to modify item price manually.
- */
-allowManualPrice?: boolean
-/**
- * Data can be edited.
- */
-canEditData?: boolean
-/**
- * Unique ID associated with the customer profile.
- */
-userProfileId?: string
-/**
- * Profile provider.
- */
-profileProvider?: string
-/**
- * Available accounts.
- */
-availableAccounts?: string[]
-/**
- * Information on each available address.
- */
-availableAddresses?: {
-/**
- * Address type.
- */
-addressType?: string
-/**
- * Name of the receiver.
- */
-receiverName?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Indicates whether address is disposable.
- */
-isDisposable?: boolean
-/**
- * City of the address.
- */
-city?: string
-/**
- * State of the address.
- */
-state?: string
-/**
- * Country of the address. ISO three-letter code.
- */
-country?: string
-/**
- * Street of the address.
- */
-street?: string
-/**
- * Number of the address.
- */
-number?: string
-/**
- * Neighborhood of the address.
- */
-neighborhood?: string
-/**
- * Complement to the address.
- */
-complement?: (null | string)
-/**
- * Reference that may help in the location of the address.
- */
-reference?: (null | string)
-/**
- * Array containing two floats with geocoordinates, first longitude, then latitude.
- */
-geoCoordinates?: number[]
-}[]
-/**
- * User type.
- */
-userType?: (null | string)
-/**
- * Ignore customer profile data.
- */
-ignoreProfileData?: boolean
-/**
- * Total value of the order without separating cents. For example, $24.99 is represented `2499`.
- */
-value?: number
-/**
- * Array containing an object for each message generated by our servers while processing the request.
- */
-messages?: any[]
-/**
- * Information on each item in the order.
- */
-items?: {
-/**
- * Unique ID.
- */
-uniqueId?: string
-/**
- * ID of the item.
- */
-id?: string
-/**
- * Product ID.
- */
-productId?: string
-/**
- * Product Ref ID.
- */
-productRefId?: string
-/**
- * Ref ID.
- */
-refId?: string
-/**
- * European Article Number.
- */
-ean?: (null | string)
-/**
- * Product name.
- */
-name?: string
-/**
- * SKU name.
- */
-skuName?: string
-/**
- * Modal type.
- */
-modalType?: (null | string)
-/**
- * Parent item index.
- */
-parentItemIndex?: (null | number)
-/**
- * Parent assembly binding.
- */
-parentAssemblyBinding?: (null | string)
-/**
- * Price expiration date and time.
- */
-priceValidUntil?: string
-/**
- * Tax value in cents.
- */
-tax?: number
-/**
- * Price in cents.
- */
-price?: number
-/**
- * List price in cents.
- */
-listPrice?: number
-/**
- * Manual price in cents.
- */
-manualPrice?: (null | number)
-/**
- * User that applied the manual price, if that is the case.
- */
-manualPriceAppliedBy?: (null | string)
-/**
- * Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead.
- */
-sellingPrice?: number
-/**
- * Reward value in cents.
- */
-rewardValue?: number
-/**
- * Indicates whether item is a gift.
- */
-isGift?: boolean
-/**
- * Additional information.
- */
-additionalInfo?: {
-/**
- * Dimension.
- */
-dimension?: (null | string)
-/**
- * Brand name.
- */
-brandName?: string
-/**
- * Brand ID.
- */
-brandId?: string
-/**
- * Offering information.
- */
-offeringInfo?: (null | string)
-/**
- * Offering type.
- */
-offeringType?: (null | string)
-/**
- * Offering type ID.
- */
-offeringTypeId?: (null | string)
-}
-/**
- * Presale date.
- */
-preSaleDate?: (null | string)
-/**
- * Product category IDs.
- */
-productCategoryIds?: string
-/**
- * Object, where each field is an ID from `productCategoryIds`.
- */
-productCategories?: {
-/**
- * Product category corresponding to the ID in the field key.
- */
-"{ID}"?: string
-}
-/**
- * Quantity.
- */
-quantity?: number
-/**
- * Seller.
- */
-seller?: string
-/**
- * Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
- */
-sellerChain?: string[]
-/**
- * Image URL.
- */
-imageUrl?: string
-/**
- * Detail URL.
- */
-detailUrl?: string
-/**
- * Information on services sold along with the SKU. Example: a gift package.
- */
-bundleItems?: {
-/**
- * Service type.
- */
-type?: string
-/**
- * Service identifier.
- */
-id?: number
-/**
- * Service name.
- */
-name?: string
-/**
- * Service price in cents.
- */
-price?: number
-}[]
-/**
- * Array containing information on attachments.
- */
-attachments?: string[]
-/**
- * Array of price tags, each of which, modifies the price in some way, like discounts or rates that apply to the item in the context of the order.
- */
-priceTags?: {
-/**
- * Price tag identifier.
- */
-identifier?: string
-/**
- * Indicates whether price tag value is applied through a percentage.
- */
-isPercentual?: boolean
-/**
- * Price tag name.
- */
-name?: string
-/**
- * Price tag raw value.
- */
-rawValue?: number
-/**
- * Price tag value.
- */
-value?: number
-}[]
-/**
- * Availability
- */
-availability?: string
-/**
- * Measurement unit
- */
-measurementUnit?: string
-/**
- * Unit multiplier
- */
-unitMultiplier?: number
-/**
- * Manufacturer code.
- */
-manufacturerCode?: (null | string)
-/**
- * Price information for all units of a specific item.
- */
-priceDefinition?: {
-/**
- * Item's calculated unitary selling price in cents.
- */
-calculatedSellingPrice?: number
-/**
- * Total value for all units of the item in cents.
- */
-total?: number
-/**
- * Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.
- */
-sellingPrices?: {
-/**
- * Value in cents for that specific rounding.
- */
-value?: number
-/**
- * Rounding quantity, meaning how many items are rounded to this value.
- */
-quantity?: number
-}[]
-}
-}[]
-/**
- * Array containing the data of the item selected as a gift.
- */
-selectableGifts?: any[]
-/**
- * Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value).
- */
-totalizers?: any[]
-/**
- * Shipping information pertinent to the order.
- */
-shippingData?: {
-/**
- * Address information.
- */
-address?: {
-/**
- * Type of address. For example, `Residential` or `Pickup`.
- */
-addressType?: string
-/**
- * Name of the person who is going to receive the order.
- */
-receiverName?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Indicates whether address is disposable.
- */
-isDisposable?: boolean
-/**
- * Postal code.
- */
-postalCode?: string
-/**
- * City of the shipping address.
- */
-city?: string
-/**
- * State of the shipping address.
- */
-state?: string
-/**
- * Three letter ISO code of the country of the shipping address.
- */
-country?: string
-/**
- * Street of the shipping address.
- */
-street?: string
-/**
- * Number of the building, house or apartment in the shipping address.
- */
-number?: string
-/**
- * Neighborhood of the shipping address.
- */
-neighborhood?: string
-/**
- * Complement to the shipping address, in case it applies.
- */
-complement?: (null | string)
-/**
- * Complement that might help locate the shipping address more precisely in case of delivery.
- */
-reference?: (null | string)
-/**
- * Array containing two floats with geocoordinates, first longitude, then latitude.
- */
-geoCoordinates?: number[]
-}
-/**
- * Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.
- */
-logisticsInfo?: {
-/**
- * Index corresponding to the position of the object in the `items` array.
- */
-itemIndex?: number
-/**
- * SLA selected by the customer.
- */
-selectedSla?: string
-/**
- * Delivery channel selected by the customer.
- */
-selectedDeliveryChannel?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Information on available SLAs.
- */
-slas?: {
-/**
- * SLA ID.
- */
-id?: string
-/**
- * Delivery channel.
- */
-deliveryChannel?: string
-/**
- * SLA name.
- */
-name?: string
-/**
- * Information on each delivery ID.
- */
-deliveryIds?: {
-/**
- * Courier ID.
- */
-courierId?: string
-/**
- * Warehouse ID.
- */
-warehouseId?: string
-/**
- * Warehouse ID.
- */
-dockId?: string
-/**
- * Courier name.
- */
-courierName?: string
-/**
- * Quantity.
- */
-quantity?: number
-}[]
-/**
- * Shipping estimate. For instance, Three business days will be represented `3bd`.
- */
-shippingEstimate?: string
-/**
- * Shipping estimate date.
- */
-shippingEstimateDate?: (null | string)
-/**
- * Estimate date of delivery.
- */
-lockTTL?: string
-/**
- * Price in cents.
- */
-price?: number
-/**
- * List price in cents.
- */
-listPrice?: number
-/**
- * Tax in cents.
- */
-tax?: number
-/**
- * Information on the pickup store.
- */
-pickupStoreInfo?: {
-/**
- * Indicates whether it is the pickup store.
- */
-isPickupStore?: boolean
-/**
- * Friendly name.
- */
-friendlyName?: (null | string)
-/**
- * Address information.
- */
-address?: (null | {
-/**
- * Type of address. For example, `Residential` or `Pickup`.
- */
-addressType?: string
-/**
- * Postal code.
- */
-postalCode?: string
-/**
- * City of the shipping address.
- */
-city?: string
-/**
- * State of the shipping address.
- */
-state?: string
-/**
- * Three letter ISO code of the country of the shipping address.
- */
-country?: string
-/**
- * Street of the shipping address.
- */
-street?: string
-/**
- * Number of the building, house or apartment in the shipping address.
- */
-number?: string
-/**
- * Neighborhood of the shipping address.
- */
-neighborhood?: string
-/**
- * Complement to the shipping address, in case it applies.
- */
-complement?: (null | string)
-/**
- * Complement that might help locate the shipping address more precisely in case of delivery.
- */
-reference?: (null | string)
-/**
- * Array containing two floats with geocoordinates, first longitude, then latitude.
- */
-geoCoordinates?: number[]
-})
-/**
- * Additional information.
- */
-additionalInfo?: (null | string)
-/**
- * Corresponding dock ID.
- */
-dockId?: (null | string)
-}
-/**
- * Pickup point ID.
- */
-pickupPointId?: (null | string)
-/**
- * Pickup point distance.
- */
-pickupDistance?: number
-/**
- * Polygon name.
- */
-polygonName?: (null | string)
-/**
- * Transit time. For instance, "three business days" is represented `3bd`.
- */
-transitTime?: string
-}[]
-/**
- * List of countries that the item may be shipped to.
- */
-shipsTo?: string[]
-/**
- * Item ID.
- */
-itemId?: string
-/**
- * List of available delivery channels.
- */
-deliveryChannels?: {
-/**
- * Delivery channel ID.
- */
-id?: string
-}[]
-}[]
-/**
- * Array with information on the selected addresses for the order.
- */
-selectedAddresses?: {
-/**
- * Type of address. For example, `Residential` or `Pickup`.
- */
-addressType?: string
-/**
- * Name of the person who is going to receive the order.
- */
-receiverName?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Indicates whether address is disposable.
- */
-isDisposable?: boolean
-/**
- * Postal code.
- */
-postalCode?: string
-/**
- * City of the shipping address.
- */
-city?: string
-/**
- * State of the shipping address.
- */
-state?: string
-/**
- * Three letter ISO code of the country of the shipping address.
- */
-country?: string
-/**
- * Street of the shipping address.
- */
-street?: string
-/**
- * Number of the building, house or apartment in the shipping address.
- */
-number?: string
-/**
- * Neighborhood of the shipping address.
- */
-neighborhood?: string
-/**
- * Complement to the shipping address, in case it applies.
- */
-complement?: string
-/**
- * Complement that might help locate the shipping address more precisely in case of delivery.
- */
-reference?: (null | string)
-/**
- * Array containing two floats with geocoordinates, first longitude, then latitude.
- */
-geoCoordinates?: number[]
-}[]
-/**
- * Array with information on the available addresses for the order.
- */
-availableAddresses?: {
-/**
- * Type of address. For example, `Residential` or `Pickup`.
- */
-addressType?: string
-/**
- * Name of the person who is going to receive the order.
- */
-receiverName?: string
-/**
- * Address ID.
- */
-addressId?: string
-/**
- * Indicates whether address is disposable.
- */
-isDisposable?: boolean
-/**
- * Postal code.
- */
-postalCode?: string
-/**
- * City of the shipping address.
- */
-city?: string
-/**
- * State of the shipping address.
- */
-state?: string
-/**
- * Three letter ISO code of the country of the shipping address.
- */
-country?: string
-/**
- * Street of the shipping address.
- */
-street?: string
-/**
- * Number of the building, house or apartment in the shipping address.
- */
-number?: string
-/**
- * Neighborhood of the shipping address.
- */
-neighborhood?: string
-/**
- * Complement to the shipping address, in case it applies.
- */
-complement?: string
-/**
- * Complement that might help locate the shipping address more precisely in case of delivery.
- */
-reference?: (null | string)
-/**
- * Array containing two floats with geocoordinates, first longitude, then latitude.
- */
-geoCoordinates?: number[]
-}[]
-}
-/**
- * Customer's profile information.
- */
-clientProfileData?: {
-/**
- * Email address.
- */
-email?: string
-/**
- * First name.
- */
-firstName?: string
-/**
- * Last name.
- */
-lastName?: string
-/**
- * Type of the document informed by the customer.
- */
-documentType?: string
-/**
- * Document informed by the customer.
- */
-document?: string
-/**
- * Phone number.
- */
-phone?: string
-/**
- * Company name, if the customer is a legal entity.
- */
-corporateName?: (null | string)
-/**
- * Trade name, if the customer is a legal entity.
- */
-tradeName?: (null | string)
-/**
- * Corporate document, if the customer is a legal entity.
- */
-corporateDocument?: (null | string)
-/**
- * State inscription, if the customer is a legal entity.
- */
-stateInscription?: (null | string)
-/**
- * Corporate phone number, if the customer is a legal entity.
- */
-corporatePhone?: (null | string)
-/**
- * Indicates whether the customer is a legal entity.
- */
-isCorporate?: boolean
-/**
- * Indicates whether profile is complete on loading.
- */
-profileCompleteOnLoading?: boolean
-/**
- * Indicates whether profile presents error on loading.
- */
-profileErrorOnLoading?: (null | boolean)
-/**
- * Customer class.
- */
-customerClass?: (null | string)
-}
-/**
- * Information on the order's payment.
- */
-paymentData?: {
-/**
- * Gift card information, if it applies to the order.
- */
-giftCards?: {
-/**
- * Gift card redemption code.
- */
-redemptionCode?: string
-/**
- * Gift card value in cents.
- */
-value?: number
-/**
- * Gift card balance in cents.
- */
-balance?: number
-/**
- * Gift card name.
- */
-name?: string
-/**
- * Gift card ID.
- */
-id?: string
-/**
- * Indicates whether gift card is in use.
- */
-inUse?: boolean
-/**
- * Indicates whether gift card is special.
- */
-isSpecialCard?: boolean
-}[]
-/**
- * Information on each transaction pertinent to the order.
- */
-transactions?: {
-/**
- * Indicates whether transaction is active.
- */
-isActive?: boolean
-/**
- * Transaction ID.
- */
-transactionId?: string
-/**
- * Merchant name.
- */
-merchantName?: string
-/**
- * Information on each payment.
- */
-payments?: {
-/**
- * Account ID.
- */
-accountId?: string
-/**
- * Bin.
- */
-bin?: string
-/**
- * Number of installments.
- */
-installments?: number
-/**
- * Payment system.
- */
-paymentSystem?: string
-/**
- * Reference value for calculating interest rates, in case it applies. Displayed in cents.
- */
-referenceValue?: number
-/**
- * Value including interest, in case it applies. Displayed in cents.
- */
-value?: number
-}[]
-/**
- * Indicates whather transaction is shared.
- */
-sharedTransaction?: boolean
-}[]
-}
-/**
- * Object containIng promotion data such as coupon tracking information and internal or external UTMs.
- */
-marketingData?: {
-/**
- * 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.
- */
-coupon?: string
-/**
- * UTM source.
- */
-utmSource?: (null | string)
-/**
- * UTM medium.
- */
-utmMedium?: (null | string)
-/**
- * UTM campaign.
- */
-utmCampaign?: (null | string)
-/**
- * utmi_page (internal utm).
- */
-utmiPage?: (null | string)
-/**
- * utmi_part (internal utm).
- */
-utmiPart?: (null | string)
-/**
- * utmi_campaign (internal utm).
- */
-utmiCampaign?: (null | string)
-}
-/**
- * Information on each seller.
- */
-sellers?: {
-/**
- * Seller ID.
- */
-id?: string
-/**
- * Seller name.
- */
-name?: string
-/**
- * Seller logo.
- */
-logo?: (null | string)
-}[]
-/**
- * Object containing preferences from the client who placed the order.
- */
-clientPreferencesData?: {
-/**
- * Client's locale. Examples: `pt-BR` and `en-US`.
- */
-locale?: string
-/**
- * `true` if the client opted to receive newsletter from the store.
+ * Minimum cart existence period (in seconds) before allowing the use of a new credit card.
  */
-optinNewsLetter?: boolean
+cartAgeToUseNewCardSeconds?: number
 }
-/**
- * Object containing commercial condition information.
- */
-commercialConditionData?: (null | {
-
-})
-/**
- * Object containing data from the store's configuration (stored in VTEX's License Manager).
- */
-storePreferencesData?: {
-
 }
 /**
- * Gift registry list information.
- */
-giftRegistryData?: (null | {
-
-})
-/**
- * Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1)
- */
-openTextField?: (null | string)
-/**
- * Object containing information pertinent to the order's invoice.
- */
-invoiceData?: (null | {
-
-})
-/**
- * Customer additional information.
- */
-customData?: (null | {
-
-})
-/**
- * Item metadata.
- */
-itemMetadata?: {
-/**
- * List of objects containing metadata on each item in the order.
- */
-items?: {
-/**
- * Item ID.
- */
-id?: string
-/**
- * Seller.
- */
-seller?: string
-/**
- * Product name.
- */
-name?: string
-/**
- * SKU name.
- */
-skuName?: string
-/**
- * Product ID.
- */
-productId?: string
-/**
- * Ref ID.
- */
-refId?: string
-/**
- * European Article Number.
- */
-ean?: (null | string)
-/**
- * Image URL.
- */
-imageUrl?: string
-/**
- * Detail URL.
+ * 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).
  */
-detailUrl?: string
-}[]
+"POST /api/checkout/pvt/configuration/orderForm": {
+body: UpdateorderFormconfigurationRequest
 }
 /**
- * Hooks information.
+ * 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.
  */
-hooksData?: (null | {
+"GET /api/checkout/pvt/configuration/window-to-change-seller": {
 
-})
-/**
- * Information on rates and benefits that apply to the order.
- */
-ratesAndBenefitsData?: {
-/**
- * List with rates and benefits identifiers.
- */
-rateAndBenefitsIdentifiers?: string[]
-/**
- * List with rates and benefits teasers.
- */
-teaser?: string[]
 }
 /**
- * Subscription information.
- */
-subscriptionData?: (null | {
-
-})
-/**
- * Object containing information about the ordering of items within the orderForm.
- */
-itemsOrdination?: {
-/**
- * Criteria adopted to order the items in the list.
- */
-criteria?: string
-/**
- * Indicates whether the ordering is ascending.
+ * 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.
  */
-ascending?: boolean
-}
-}
+"POST /api/checkout/pvt/configuration/window-to-change-seller": {
+body: WaitingTime
 }
 /**
  * Cancels an order using its identification code (`orderId`). A common scenario is when the seller has a problem fulfilling the order and requests the marketplace to cancel it. 
@@ -17984,33 +10890,6 @@ reference?: string
  * Geo coordinates.
  */
 geoCoordinates?: number[]
-}
-}
-/**
- * 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.
- */
-"POST /api/checkout/pub/orderForm/:orderFormId/transaction": {
-body: {
-referenceId: ReferenceId
-savePersonalData?: SavePersonalData
-optinNewsLetter?: OptinNewsLetter
-/**
- * Total value of the order without separating cents. For example, $24.99 is represented `2499`.
- */
-value: number
-/**
- * Reference value of the order for calculating interest if that is the case. Can be equal to the total value and does not separate cents. For example, $24.99 is represented `2499`.
- */
-referenceValue: number
-/**
- * Interest rate to be used in case it applies.
- */
-interestValue: number
-}
-response: {
-
 }
 }
 /**
@@ -21837,18 +14716,6 @@ Email?: string
  */
 IsActive?: boolean
 }
-export interface PriceChangeRequest {
-/**
- * The new price of the item.
- */
-price: number
-}
-export interface SetsinglecustomfieldvalueRequest {
-/**
- * The value you want to set to the specified field.
- */
-value: string
-}
 export interface UpdateorderFormconfigurationRequest {
 paymentConfiguration: PaymentConfiguration
 /**
diff --git a/vtex/utils/openapi/vcs.openapi.json b/vtex/utils/openapi/vcs.openapi.json
index cc5e7d91c..a6e4c62c0 100644
--- a/vtex/utils/openapi/vcs.openapi.json
+++ b/vtex/utils/openapi/vcs.openapi.json
@@ -20614,14 +20614,14 @@
         "deprecated": false
       }
     },
-    "/api/checkout/pub/orderForm": {
+    "/checkout/changeToAnonymousUser/{orderFormId}": {
       "get": {
         "tags": [
           "Shopping cart"
         ],
-        "summary": "Get current or create a new cart",
-        "description": "You can use this request to get your current shopping cart information (`orderFormId`) or to create a new cart.\r\n\r\n**Important**: To create a new empty shopping cart you need to send this request with the query param `forceNewCart=true`.\r\n\r\nThe [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.\n\r\n\r> This request has a time out of 45 seconds.",
-        "operationId": "CreateANewCart",
+        "summary": "Remove all personal data",
+        "description": "This call removes all user information, making a cart anonymous while leaving the items.\r\n\r\nThe [orderForm](https://developers.vtex.com/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.\r\n\r\nThis call works by creating a new orderForm, setting a new cookie, and returning a redirect 302 to the cart URL (`/checkout/#/orderform`).",
+        "operationId": "Removeallpersonaldata",
         "security": [],
         "parameters": [
           {
@@ -20647,14 +20647,14 @@
             }
           },
           {
-            "name": "forceNewCart",
-            "in": "query",
-            "description": "Use this query parameter to create a new empty shopping cart.",
-            "required": false,
-            "style": "form",
+            "name": "orderFormId",
+            "in": "path",
+            "description": "ID of the orderForm corresponding to the cart whose user's personal data you want to remove.",
+            "required": true,
+            "style": "simple",
             "schema": {
-              "type": "boolean",
-              "example": true
+              "type": "string",
+              "default": "ede846222cd44046ba6c638442c3505a"
             }
           }
         ],
@@ -20662,83 +20662,11 @@
           "200": {
             "description": "OK",
             "content": {
-              "application/json": {
-                "example": {
-                  "orderFormId": "9ceee0fde6db489fbc682a0e2ab13a86",
-                  "salesChannel": "1",
-                  "loggedIn": false,
-                  "isCheckedIn": false,
-                  "storeId": null,
-                  "checkedInPickupPointId": null,
-                  "allowManualPrice": false,
-                  "canEditData": true,
-                  "userProfileId": null,
-                  "userType": null,
-                  "ignoreProfileData": false,
-                  "value": 0,
-                  "messages": [],
-                  "items": [],
-                  "selectableGifts": [],
-                  "totalizers": [],
-                  "shippingData": null,
-                  "clientProfileData": {
-                    "email": null,
-                    "firstName": null,
-                    "lastName": null,
-                    "document": null,
-                    "documentType": null,
-                    "phone": null,
-                    "corporateName": null,
-                    "tradeName": null,
-                    "corporateDocument": null,
-                    "stateInscription": null,
-                    "corporatePhone": null,
-                    "isCorporate": false,
-                    "profileCompleteOnLoading": null,
-                    "profileErrorOnLoading": null,
-                    "customerClass": null
-                  },
-                  "paymentData": {
-                    "installmentOptions": [],
-                    "paymentSystems": [],
-                    "payments": [],
-                    "giftCards": [],
-                    "giftCardMessages": [],
-                    "availableAccounts": [],
-                    "availableTokens": []
-                  },
-                  "marketingData": null,
-                  "sellers": [],
-                  "clientPreferencesData": {
-                    "locale": "pt-BR",
-                    "optinNewsLetter": null
-                  },
-                  "commercialConditionData": null,
-                  "storePreferencesData": {
-                    "countryCode": "BRA",
-                    "saveUserData": true,
-                    "timeZone": "E. South America Standard Time",
-                    "currencyCode": "BRL",
-                    "currencyLocale": 1046,
-                    "currencySymbol": "R$",
-                    "currencyFormatInfo": {
-                      "currencyDecimalDigits": 2,
-                      "currencyDecimalSeparator": ",",
-                      "currencyGroupSeparator": ".",
-                      "currencyGroupSize": 3,
-                      "startsWithCurrencySymbol": true
-                    }
-                  },
-                  "giftRegistryData": null,
-                  "openTextField": null,
-                  "invoiceData": null,
-                  "customData": null,
-                  "itemMetadata": null,
-                  "hooksData": null,
-                  "ratesAndBenefitsData": null,
-                  "subscriptionData": null,
-                  "itemsOrdination": null
-                }
+              "text/plain": {
+                "schema": {
+                  "type": "object"
+                },
+                "example": {}
               }
             }
           }
@@ -20746,27 +20674,16 @@
         "deprecated": false
       }
     },
-    "/api/checkout/pub/orderForm/{orderFormId}": {
+    "/api/checkout/pub/profiles": {
       "get": {
         "tags": [
-          "Shopping cart"
+          "Cart attachments"
         ],
-        "summary": "Get cart information by ID",
-        "description": "Use this request to get all information associated to a given shopping  cart.\r\n\r\nThe [orderForm](https://developers.vtex.com/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.\n\r\n\r> This request has a time out of 45 seconds.",
-        "operationId": "GetCartInformationById",
+        "summary": "Get client profile by email",
+        "description": "Retrieve a client's profile information by providing an email address.\n\r\n\rIf the response body fields are empty, the following situations may have occurred:\n\r\n\r1. There is no client registered with the email address provided in your store, or;\n\r2. 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).\r\n\r\n>⚠️ 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.",
+        "operationId": "GetClientProfileByEmail",
         "security": [],
         "parameters": [
-          {
-            "name": "orderFormId",
-            "in": "path",
-            "description": "ID of the orderForm corresponding to the cart whose information you want to retrieve.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "ede846222cd44046ba6c638442c3505a"
-            }
-          },
           {
             "name": "Content-Type",
             "in": "header",
@@ -20790,284 +20707,242 @@
             }
           },
           {
-            "name": "refreshOutdatedData",
+            "name": "email",
+            "in": "query",
+            "description": "Client's email address to be searched.",
+            "required": true,
+            "style": "form",
+            "schema": {
+              "type": "string",
+              "example": "clark.kent@examplemail.com"
+            }
+          },
+          {
+            "name": "ensureComplete",
             "in": "query",
-            "description": "It is possible to use the [Update cart items request](https://developers.vtex.com/vtex-rest-api/reference/cart-update#itemsupdate) so as to allow outdated information in the `orderForm`, which may improve performance in some cases. To guarantee that all cart information is updated, send this request with this parameter as `true`. We recommend doing this in the final stages of the shopping experience, starting from the checkout page.",
+            "description": "Indicates whether the returned profiles must be complete or not.",
             "required": false,
             "style": "form",
             "schema": {
               "type": "boolean",
+              "example": false,
               "default": true
             }
           }
         ],
         "responses": {
           "200": {
-            "description": "",
-            "headers": {},
+            "description": "OK",
             "content": {
               "application/json": {
-                "example": {
-                  "orderFormId": "ede846222cd44046ba6c638442c3505a",
-                  "salesChannel": "1",
-                  "loggedIn": false,
-                  "isCheckedIn": false,
-                  "storeId": null,
-                  "checkedInPickupPointId": null,
-                  "allowManualPrice": false,
-                  "canEditData": true,
-                  "userProfileId": null,
-                  "userType": null,
-                  "ignoreProfileData": false,
-                  "value": 15000,
-                  "messages": [],
-                  "items": [
-                    {
-                      "uniqueId": "E0F2B7AF5CD74D668F1E27537206912C",
-                      "id": "1",
-                      "productId": "1",
-                      "productRefId": "",
-                      "refId": "0001",
-                      "ean": "123456789",
-                      "name": "Ração Royal Canin Feline Urinary 500g",
-                      "skuName": "Ração Royal Canin Feline Urinary 500g",
-                      "modalType": null,
-                      "parentItemIndex": null,
-                      "parentAssemblyBinding": null,
-                      "assemblies": [],
-                      "priceValidUntil": "2021-02-27T14:59:00.8288784Z",
-                      "tax": 0,
-                      "taxCode": "54WC8ZN6K8",
-                      "price": 15000,
-                      "listPrice": 30000,
-                      "manualPrice": null,
-                      "sellingPrice": 15000,
-                      "rewardValue": 0,
-                      "isGift": false,
-                      "additionalInfo": {
-                        "brandName": "Royal Canin",
-                        "brandId": "2000000",
-                        "offeringInfo": null,
-                        "offeringType": null,
-                        "offeringTypeId": null
-                      },
-                      "preSaleDate": null,
-                      "productCategoryIds": "/1/10/",
-                      "productCategories": {
-                        "10": "Ração Seca",
-                        "1": "Alimentação"
-                      },
-                      "quantity": 1,
-                      "seller": "1",
-                      "sellerChain": [
-                        "1"
-                      ],
-                      "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
-                      "detailUrl": "/racao-royal-canin-feline-urinary/p",
-                      "components": [],
-                      "bundleItems": [],
-                      "attachments": [],
-                      "attachmentOfferings": [],
-                      "offerings": [],
-                      "priceTags": [],
-                      "availability": "available",
-                      "measurementUnit": "un",
-                      "unitMultiplier": 1.0,
-                      "manufacturerCode": null
-                    }
-                  ],
-                  "selectableGifts": [],
-                  "totalizers": [
-                    {
-                      "id": "Items",
-                      "name": "Total dos Itens",
-                      "value": 15000
-                    }
-                  ],
-                  "shippingData": {
-                    "address": null,
-                    "logisticsInfo": [
-                      {
-                        "itemIndex": 0,
-                        "selectedSla": null,
-                        "selectedDeliveryChannel": null,
-                        "addressId": null,
-                        "slas": [],
-                        "shipsTo": [
-                          "BRA"
-                        ],
-                        "itemId": "1",
-                        "deliveryChannels": [
-                          {
-                            "id": "pickup-in-point"
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "userProfileId": {
+                      "type": "string",
+                      "description": "Unique ID associated with the customer profile."
+                    },
+                    "profileProvider": {
+                      "type": "string",
+                      "description": "Profile provider."
+                    },
+                    "availableAccounts": {
+                      "type": "array",
+                      "description": "Available accounts.",
+                      "items": {
+                        "type": "string"
+                      }
+                    },
+                    "availableAddresses": {
+                      "type": "array",
+                      "description": "Information on each available address.",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "addressType": {
+                            "type": "string",
+                            "description": "Address type."
                           },
-                          {
-                            "id": "delivery"
+                          "receiverName": {
+                            "type": "string",
+                            "description": "Name of the receiver."
+                          },
+                          "addressId": {
+                            "type": "string",
+                            "description": "Address ID."
+                          },
+                          "isDisposable": {
+                            "type": "boolean",
+                            "description": "Indicates whether address is disposable."
+                          },
+                          "city": {
+                            "type": "string",
+                            "description": "City of the address."
+                          },
+                          "state": {
+                            "type": "string",
+                            "description": "State of the address."
+                          },
+                          "country": {
+                            "type": "string",
+                            "description": "Country of the address. ISO three-letter code."
+                          },
+                          "street": {
+                            "type": "string",
+                            "description": "Street of the address."
+                          },
+                          "number": {
+                            "type": "string",
+                            "description": "Number of the address."
+                          },
+                          "neighborhood": {
+                            "type": "string",
+                            "description": "Neighborhood of the address."
+                          },
+                          "complement": {
+                            "type": "string",
+                            "description": "Complement to the address.",
+                            "nullable": true
+                          },
+                          "reference": {
+                            "type": "string",
+                            "description": "Reference that may help in the location of the address.",
+                            "nullable": true
+                          },
+                          "geoCoordinates": {
+                            "type": "array",
+                            "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
+                            "items": {
+                              "type": "number"
+                            }
                           }
-                        ]
+                        }
                       }
-                    ],
-                    "selectedAddresses": [],
-                    "availableAddresses": [],
-                    "pickupPoints": []
-                  },
-                  "clientProfileData": {
-                    "email": "clark.kent@examplemail.com",
-                    "firstName": "Clark",
-                    "lastName": "Kent",
-                    "document": "12345678900",
-                    "documentType": "cpf",
-                    "phone": "+5500123456789",
-                    "corporateName": null,
-                    "tradeName": null,
-                    "corporateDocument": null,
-                    "stateInscription": null,
-                    "corporatePhone": null,
-                    "isCorporate": false,
-                    "profileCompleteOnLoading": false,
-                    "profileErrorOnLoading": false,
-                    "customerClass": null
-                  },
-                  "paymentData": {
-                    "installmentOptions": [
-                      {
-                        "paymentSystem": "2",
-                        "bin": null,
-                        "paymentName": null,
-                        "paymentGroupName": null,
-                        "value": 15000,
-                        "installments": [
-                          {
-                            "count": 1,
-                            "hasInterestRate": false,
-                            "interestRate": 0,
-                            "value": 15000,
-                            "total": 15000,
-                            "sellerMerchantInstallments": [
-                              {
-                                "id": "LOJADOBRENO",
-                                "count": 1,
-                                "hasInterestRate": false,
-                                "interestRate": 0,
-                                "value": 15000,
-                                "total": 15000
-                              }
-                            ]
-                          },
-                          {
-                            "count": 2,
-                            "hasInterestRate": false,
-                            "interestRate": 0,
-                            "value": 7500,
-                            "total": 15000,
-                            "sellerMerchantInstallments": [
-                              {
-                                "id": "LOJADOBRENO",
-                                "count": 2,
-                                "hasInterestRate": false,
-                                "interestRate": 0,
-                                "value": 7500,
-                                "total": 15000
-                              }
-                            ]
-                          }
-                        ]
-                      }
-                    ],
-                    "paymentSystems": [
-                      {
-                        "id": 2,
-                        "name": "Visa",
-                        "groupName": "creditCardPaymentGroup",
-                        "validator": {
-                          "regex": "^2[1-8]{17}$",
-                          "mask": "9999 9999 9999 9999",
-                          "cardCodeRegex": "^[0-3]{8}$",
-                          "cardCodeMask": "999",
-                          "weights": [
-                            2,
-                            1,
-                            2,
-                            1,
-                            2,
-                            1
-                          ],
-                          "useCvv": true,
-                          "useExpirationDate": true,
-                          "useCardHolderName": true,
-                          "useBillingAddress": true
+                    },
+                    "userProfile": {
+                      "type": "object",
+                      "description": "Customer profile information.",
+                      "properties": {
+                        "email": {
+                          "type": "string",
+                          "description": "Email address."
                         },
-                        "stringId": "2",
-                        "template": "creditCardPaymentGroup-template",
-                        "requiresDocument": false,
-                        "isCustom": false,
-                        "description": null,
-                        "requiresAuthentication": false,
-                        "dueDate": "2020-03-05T14:59:00.7879306Z",
-                        "availablePayments": null
+                        "firstName": {
+                          "type": "string",
+                          "description": "First name."
+                        },
+                        "lastName": {
+                          "type": "string",
+                          "description": "Last name."
+                        },
+                        "document": {
+                          "type": "string",
+                          "description": "Document."
+                        },
+                        "documentType": {
+                          "type": "string",
+                          "description": "Document type."
+                        },
+                        "phone": {
+                          "type": "string",
+                          "description": "Telephone number."
+                        },
+                        "corporateName": {
+                          "type": "string",
+                          "description": "Name of the company. Used for corporate clients.",
+                          "nullable": true
+                        },
+                        "tradeName": {
+                          "type": "string",
+                          "description": "Trade name. Used for corporate clients.",
+                          "nullable": true
+                        },
+                        "corporateDocument": {
+                          "type": "string",
+                          "description": "Document. Used for corporate clients.",
+                          "nullable": true
+                        },
+                        "stateInscription": {
+                          "type": "string",
+                          "description": "State inscription. Used for corporate clients.",
+                          "nullable": true
+                        },
+                        "corporatePhone": {
+                          "type": "string",
+                          "description": "Telephone number. Used for corporate clients.",
+                          "nullable": true
+                        },
+                        "isCorporate": {
+                          "type": "boolean",
+                          "description": "Indicates whether client is corporate.",
+                          "default": false
+                        },
+                        "profileCompleteOnLoading": {
+                          "type": "string",
+                          "description": "Profile complete when loading.",
+                          "nullable": true
+                        },
+                        "profileErrorOnLoading": {
+                          "type": "string",
+                          "description": "Profile error when loading.",
+                          "nullable": true
+                        },
+                        "customerClass": {
+                          "type": "string",
+                          "description": "Customer class.",
+                          "nullable": true
+                        }
                       }
-                    ],
-                    "payments": [],
-                    "giftCards": [],
-                    "giftCardMessages": [],
-                    "availableAccounts": [],
-                    "availableTokens": []
-                  },
-                  "marketingData": null,
-                  "sellers": [
+                    },
+                    "isComplete": {
+                      "type": "boolean",
+                      "description": "Indicates whether customer profile is complete."
+                    }
+                  }
+                },
+                "example": {
+                  "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
+                  "profileProvider": "VTEX",
+                  "availableAccounts": [],
+                  "availableAddresses": [
                     {
-                      "id": "1",
-                      "name": "lojadobreno",
-                      "logo": ""
+                      "addressType": "residential",
+                      "receiverName": "Clark Kent",
+                      "addressId": "666c2e830bd9474ab6f6cc53fb6dd2d2",
+                      "isDisposable": false,
+                      "postalCode": "12345-000",
+                      "city": "Metropolis",
+                      "state": "NY",
+                      "country": "USA",
+                      "street": "My street",
+                      "number": "123",
+                      "neighborhood": "My neighborhood",
+                      "complement": null,
+                      "reference": null,
+                      "geoCoordinates": [
+                        -47.924747467041016,
+                        -15.832582473754883
+                      ]
                     }
                   ],
-                  "clientPreferencesData": {
-                    "locale": "pt-BR",
-                    "optinNewsLetter": null
-                  },
-                  "commercialConditionData": null,
-                  "storePreferencesData": {
-                    "countryCode": "BRA",
-                    "saveUserData": true,
-                    "timeZone": "E. South America Standard Time",
-                    "currencyCode": "BRL",
-                    "currencyLocale": 1046,
-                    "currencySymbol": "R$",
-                    "currencyFormatInfo": {
-                      "currencyDecimalDigits": 2,
-                      "currencyDecimalSeparator": ",",
-                      "currencyGroupSeparator": ".",
-                      "currencyGroupSize": 3,
-                      "startsWithCurrencySymbol": true
-                    }
-                  },
-                  "giftRegistryData": null,
-                  "openTextField": null,
-                  "invoiceData": null,
-                  "customData": null,
-                  "itemMetadata": {
-                    "items": [
-                      {
-                        "id": "1",
-                        "seller": "1",
-                        "name": "Ração Royal Canin Feline Urinary 500g",
-                        "skuName": "Ração Royal Canin Feline Urinary 500g",
-                        "productId": "1",
-                        "refId": "0001",
-                        "ean": "123456789",
-                        "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
-                        "detailUrl": "/racao-royal-canin-feline-urinary/p",
-                        "assemblyOptions": []
-                      }
-                    ]
-                  },
-                  "hooksData": null,
-                  "ratesAndBenefitsData": {
-                    "rateAndBenefitsIdentifiers": [],
-                    "teaser": []
+                  "userProfile": {
+                    "email": "clark.kent@example.com",
+                    "firstName": "Clark",
+                    "lastName": "Kent",
+                    "document": "12345678900",
+                    "documentType": "cpf",
+                    "phone": "+556199999999",
+                    "corporateName": null,
+                    "tradeName": null,
+                    "corporateDocument": null,
+                    "stateInscription": null,
+                    "corporatePhone": null,
+                    "isCorporate": false,
+                    "profileCompleteOnLoading": null,
+                    "profileErrorOnLoading": null,
+                    "customerClass": null
                   },
-                  "subscriptionData": null,
-                  "itemsOrdination": null
+                  "isComplete": true
                 }
               }
             }
@@ -21076,27 +20951,15 @@
         "deprecated": false
       }
     },
-    "/api/checkout/pub/orderForm/{orderFormId}/items/removeAll": {
-      "post": {
+    "/api/checkout/pvt/configuration/orderForm": {
+      "get": {
         "tags": [
-          "Shopping cart"
+          "Configuration"
         ],
-        "summary": "Remove all items",
-        "description": "This request removes all items from a given cart, leaving it empty.\r\n\r\nYou must send an empty JSON in the body of the request.\r\n\r\nThe [orderForm](https://developers.vtex.com/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.\r\n\r\n**Important**: **Request Body** must always be sent with empty value \"{ }\" in this endpoint.",
-        "operationId": "RemoveAllItems",
-        "security": [],
+        "summary": "Get orderForm configuration",
+        "description": "Retrieves the settings that are currently applied to every orderForm in the account.\n\r\n\rThese settings are defined by the request [Update orderForm configuration](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pvt/configuration/orderForm).\n\r\n\rAlways use this request to retrieve the current configuration before performing an update. By doing so you ensure that you are modifying only the properties you want.",
+        "operationId": "GetorderFormconfiguration",
         "parameters": [
-          {
-            "name": "orderFormId",
-            "in": "path",
-            "description": "ID of the orderForm corresponding to the cart whose items you want to remove.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "ede846222cd44046ba6c638442c3505a"
-            }
-          },
           {
             "name": "Content-Type",
             "in": "header",
@@ -21120,20 +20983,6 @@
             }
           }
         ],
-        "requestBody": {
-          "description": "",
-          "content": {
-            "application/json": {
-              "schema": {
-                "type": "object",
-                "description": "This object must be empty.",
-                "title": "",
-                "properties": {},
-                "default": {}
-              }
-            }
-          }
-        },
         "responses": {
           "200": {
             "description": "",
@@ -21141,170 +20990,171 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "type": "object"
-                },
-                "examples": {
-                  "response": {
-                    "value": {
-                      "orderFormId": "ede846222cd44046ba6c638442c3505a",
-                      "salesChannel": "1",
-                      "loggedIn": false,
-                      "isCheckedIn": false,
-                      "storeId": null,
-                      "checkedInPickupPointId": null,
-                      "allowManualPrice": false,
-                      "canEditData": true,
-                      "userProfileId": null,
-                      "userType": null,
-                      "ignoreProfileData": false,
-                      "value": 0,
-                      "messages": [],
-                      "items": [],
-                      "selectableGifts": [],
-                      "totalizers": [],
-                      "shippingData": {
-                        "address": null,
-                        "logisticsInfo": [],
-                        "selectedAddresses": [],
-                        "availableAddresses": [],
-                        "pickupPoints": []
-                      },
-                      "clientProfileData": {
-                        "email": "john.doe@google.com",
-                        "firstName": "John",
-                        "lastName": "Doe",
-                        "document": "769387308",
-                        "documentType": "dni",
-                        "phone": "+5491111223344",
-                        "corporateName": null,
-                        "tradeName": null,
-                        "corporateDocument": null,
-                        "stateInscription": null,
-                        "corporatePhone": null,
-                        "isCorporate": false,
-                        "profileCompleteOnLoading": false,
-                        "profileErrorOnLoading": false,
-                        "customerClass": null
-                      },
-                      "paymentData": {
-                        "installmentOptions": [
-                          {
-                            "paymentSystem": "2",
-                            "bin": null,
-                            "paymentName": null,
-                            "paymentGroupName": null,
-                            "value": 15000,
-                            "installments": [
-                              {
-                                "count": 1,
-                                "hasInterestRate": false,
-                                "interestRate": 0,
-                                "value": 15000,
-                                "total": 15000,
-                                "sellerMerchantInstallments": [
-                                  {
-                                    "id": "LOJADOBRENO",
-                                    "count": 1,
-                                    "hasInterestRate": false,
-                                    "interestRate": 0,
-                                    "value": 15000,
-                                    "total": 15000
-                                  }
-                                ]
-                              }
-                            ]
-                          }
-                        ],
-                        "paymentSystems": [
-                          {
-                            "id": 4,
-                            "name": "Mastercard",
-                            "groupName": "creditCardPaymentGroup",
-                            "validator": {
-                              "regex": "^((5(([1-2]|[5-5])[0-3]{8}|0((2|9)([0-2]{5}))|1(0(5((0|[4-8])[1-7]{6})|([2-3]|[1-9])[0-9]{6})|[1-9][0-9]{7})))|((508116)\\d{4,10})|((502121)\\d{4,10})|((589916)\\d{4,10})|(2[0-9]{15})|(67[0-9]{14})|(506387)\\d{4,10})",
-                              "mask": "9999 9999 9999 9999",
-                              "cardCodeRegex": "^[1-3]{9}$",
-                              "cardCodeMask": "999",
-                              "weights": [
-                                2,
-                                1,
-                                2,
-                                1,
-                                2
-                              ],
-                              "useCvv": true,
-                              "useExpirationDate": true,
-                              "useCardHolderName": true,
-                              "useBillingAddress": true
-                            },
-                            "stringId": "4",
-                            "template": "creditCardPaymentGroup-template",
-                            "requiresDocument": false,
-                            "isCustom": false,
-                            "description": null,
-                            "requiresAuthentication": false,
-                            "dueDate": "2020-03-05T14:23:23.8196668Z",
-                            "availablePayments": null
-                          }
-                        ],
-                        "payments": [],
-                        "giftCards": [],
-                        "giftCardMessages": [],
-                        "availableAccounts": [],
-                        "availableTokens": []
-                      },
-                      "marketingData": null,
-                      "sellers": [],
-                      "clientPreferencesData": {
-                        "locale": "pt-BR",
-                        "optinNewsLetter": null
-                      },
-                      "commercialConditionData": null,
-                      "storePreferencesData": {
-                        "countryCode": "BRA",
-                        "saveUserData": true,
-                        "timeZone": "E. South America Standard Time",
-                        "currencyCode": "BRL",
-                        "currencyLocale": 1046,
-                        "currencySymbol": "R$",
-                        "currencyFormatInfo": {
-                          "currencyDecimalDigits": 2,
-                          "currencyDecimalSeparator": ",",
-                          "currencyGroupSeparator": ".",
-                          "currencyGroupSize": 3,
-                          "startsWithCurrencySymbol": true
+                  "type": "object",
+                  "properties": {
+                    "paymentConfiguration": {
+                      "type": "object",
+                      "description": "Payment configuration information.",
+                      "properties": {
+                        "requiresAuthenticationForPreAuthorizedPaymentOption": {
+                          "type": "boolean",
+                          "description": "Determines whether pre-authorized payments require authentication."
+                        },
+                        "allowInstallmentsMerge": {
+                          "type": "boolean",
+                          "description": "By default (when `false`), on a multi-seller purchase is on the run, a simple intersection with installment options configured by every seller will be available. When indicated as `true`, this option allows a more complex but flexible installment option, since it considers max installments of every seller configuration, even if those do not match. Installment values may not be equal in this case."
                         }
-                      },
-                      "giftRegistryData": null,
-                      "openTextField": null,
-                      "invoiceData": null,
-                      "customData": null,
-                      "itemMetadata": {
-                        "items": []
-                      },
-                      "hooksData": null,
-                      "ratesAndBenefitsData": null,
-                      "subscriptionData": null,
-                      "itemsOrdination": null
+                      }
+                    },
+                    "taxConfiguration": {
+                      "type": "object",
+                      "description": "External tax service configuration information.",
+                      "nullable": true,
+                      "properties": {
+                        "url": {
+                          "type": "string",
+                          "description": "Endpoint URL.",
+                          "nullable": true
+                        },
+                        "authorizationHeader": {
+                          "type": "string",
+                          "description": "Authorization header.",
+                          "nullable": true
+                        },
+                        "appId": {
+                          "type": "string",
+                          "description": "Custom data ID sent to the tax system."
+                        }
+                      }
+                    },
+                    "minimumQuantityAccumulatedForItems": {
+                      "type": "integer",
+                      "description": "Minimum SKU quantity by cart."
+                    },
+                    "decimalDigitsPrecision": {
+                      "type": "integer",
+                      "description": "Number of price digits."
+                    },
+                    "minimumValueAccumulated": {
+                      "type": "integer",
+                      "description": "Minimum cart value.",
+                      "nullable": true
+                    },
+                    "apps": {
+                      "type": "array",
+                      "nullable": true,
+                      "description": "Array of objects containing Apps configuration information.",
+                      "items": {
+                        "type": "object",
+                        "properties": {
+                          "id": {
+                            "type": "string",
+                            "description": "App ID."
+                          },
+                          "fields": {
+                            "type": "array",
+                            "description": "Array of fields available to the app.",
+                            "items": {
+                              "type": "string"
+                            }
+                          },
+                          "major": {
+                            "type": "integer",
+                            "description": "App major version."
+                          }
+                        }
+                      }
+                    },
+                    "allowMultipleDeliveries": {
+                      "type": "boolean",
+                      "description": "On the same purchase, allows the selection of items from multiple delivery channels.",
+                      "nullable": true
+                    },
+                    "allowManualPrice": {
+                      "type": "boolean",
+                      "description": "Allows the editing of SKU prices right in the cart.",
+                      "nullable": true
+                    },
+                    "savePersonalDataAsOptIn": {
+                      "type": "boolean",
+                      "description": "Allows users to select whether they want the store to keep their personal and payment data saved.",
+                      "nullable": true
+                    },
+                    "maxNumberOfWhiteLabelSellers": {
+                      "type": "integer",
+                      "description": "Allows the input of a limit of white label sellers involved on the cart.",
+                      "nullable": true
+                    },
+                    "maskFirstPurchaseData": {
+                      "type": "boolean",
+                      "description": "Allows, on a first purchase, masking client's data. It could be useful when a shared cart is used and the client does not want to share its data.",
+                      "nullable": true
+                    },
+                    "recaptchaValidation": {
+                      "type": "string",
+                      "description": "Configures reCAPTCHA validation for the account, defining in which situations the shopper will be prompted to validate a purchase with reCAPTCHA. Learn more about [reCAPTCHA validation for VTEX stores](https://help.vtex.com/en/tutorial/using-recaptcha-at-checkout--18Te3oDd7f4qcjKu9jhNzP)\n\r\n\rPossible values are:\n\r- `\"never\"`: no purchases are validated with reCAPTCHA.\n\r- `\"always\"`: every purchase is validated with reCAPTCHA.\n\r- `\"vtexCriteria\"`: only some purchases are validated with reCAPTCHA in order to minimize friction and improve shopping experience. VTEX's algorithm determines which sessions are trustworthy and which should be validated with reCAPTCHA. This is the recommended option.",
+                      "default": "vtexCriteria"
+                    },
+                    "requiresLoginToPlaceOrder": {
+                      "type": "boolean",
+                      "description": "Indicates whether authentication is required for completing purchases.",
+                      "example": true
+                    },
+                    "minimumPurchaseDowntimeSeconds": {
+                      "type": "integer",
+                      "description": "Minimum interval (in seconds) between successive purchases.",
+                      "example": 90
+                    },
+                    "cartAgeToUseNewCardSeconds": {
+                      "type": "integer",
+                      "description": "Minimum cart existence period (in seconds) before allowing the use of a new credit card.",
+                      "example": 30
                     }
                   }
+                },
+                "example": {
+                  "paymentConfiguration": {
+                    "requiresAuthenticationForPreAuthorizedPaymentOption": false,
+                    "allowInstallmentsMerge": false,
+                    "blockPaymentSession": null
+                  },
+                  "taxConfiguration": null,
+                  "minimumQuantityAccumulatedForItems": 1,
+                  "decimalDigitsPrecision": 2,
+                  "minimumValueAccumulated": null,
+                  "apps": [
+                    {
+                      "fields": [
+                        "name",
+                        "age"
+                      ],
+                      "id": "abcd",
+                      "major": 1
+                    }
+                  ],
+                  "allowMultipleDeliveries": false,
+                  "allowManualPrice": true,
+                  "savePersonalDataAsOptIn": false,
+                  "maxNumberOfWhiteLabelSellers": null,
+                  "maskFirstPurchaseData": null,
+                  "recaptchaValidation": "vtexCriteria",
+                  "requiresLoginToPlaceOrder": true,
+                  "minimumPurchaseDowntimeSeconds": 90,
+                  "cartAgeToUseNewCardSeconds": 30
                 }
               }
             }
           }
         },
         "deprecated": false
-      }
-    },
-    "/checkout/changeToAnonymousUser/{orderFormId}": {
-      "get": {
+      },
+      "post": {
         "tags": [
-          "Shopping cart"
+          "Configuration"
         ],
-        "summary": "Remove all personal data",
-        "description": "This call removes all user information, making a cart anonymous while leaving the items.\r\n\r\nThe [orderForm](https://developers.vtex.com/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.\r\n\r\nThis call works by creating a new orderForm, setting a new cookie, and returning a redirect 302 to the cart URL (`/checkout/#/orderform`).",
-        "operationId": "Removeallpersonaldata",
-        "security": [],
+        "summary": "Update orderForm configuration",
+        "description": "Determines settings that will apply to every orderForm in the account.\n\r\n\rFor example, if you create an app using this request, every orderForm of this account will have the custom fields created though it.\n\r\n\r>ℹ️ 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).",
+        "operationId": "UpdateorderFormconfiguration",
         "parameters": [
           {
             "name": "Content-Type",
@@ -21327,44 +21177,51 @@
               "type": "string",
               "default": "application/json"
             }
-          },
-          {
-            "name": "orderFormId",
-            "in": "path",
-            "description": "ID of the orderForm corresponding to the cart whose user's personal data you want to remove.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "ede846222cd44046ba6c638442c3505a"
-            }
           }
         ],
-        "responses": {
-          "200": {
-            "description": "OK",
-            "content": {
-              "text/plain": {
-                "schema": {
-                  "type": "object"
+        "requestBody": {
+          "description": "",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/UpdateorderFormconfigurationRequest"
+              },
+              "example": {
+                "paymentConfiguration": {
+                  "requiresAuthenticationForPreAuthorizedPaymentOption": false
                 },
-                "example": {}
+                "taxConfiguration": null,
+                "minimumQuantityAccumulatedForItems": 1,
+                "decimalDigitsPrecision": 2,
+                "minimumValueAccumulated": null,
+                "apps": null,
+                "allowMultipleDeliveries": null,
+                "allowManualPrice": null,
+                "requiresLoginToPlaceOrder": true,
+                "minimumPurchaseDowntimeSeconds": 90,
+                "cartAgeToUseNewCardSeconds": 30
               }
             }
+          },
+          "required": true
+        },
+        "responses": {
+          "204": {
+            "description": "",
+            "headers": {}
           }
         },
         "deprecated": false
       }
     },
-    "/api/checkout/pub/orderForm/{orderFormId}/items/update": {
-      "post": {
+    "/api/checkout/pvt/configuration/window-to-change-seller": {
+      "get": {
         "tags": [
-          "Shopping cart"
+          "Configuration"
         ],
-        "summary": "Update cart items",
-        "description": "You can use this request to:\n\r\n\r1. Change the quantity of one or more items in a specific cart.\n\r2. Remove an item from the cart (by sending the `quantity` value = `0` in the request body).\r\n\r\n**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.\r\n\r\nThe [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.\n\r\n\r> This request has a time out of 45 seconds.",
-        "operationId": "ItemsUpdate",
-        "security": [],
+        "summary": "Get window to change seller",
+        "description": "Retrieves a marketplace’s window to change seller, that is, the period when it is possible to choose another seller to fulfill a given order after the original seller has canceled it.\n\r\n\rThe default period for this window is of 2 days, but it can be configured by the request Update window to change seller.",
+        "operationId": "GetWindowToChangeSeller",
         "parameters": [
           {
             "name": "Content-Type",
@@ -21387,73 +21244,138 @@
               "type": "string",
               "default": "application/json"
             }
-          },
-          {
-            "name": "orderFormId",
-            "in": "path",
-            "description": "ID of the `orderForm` corresponding to the cart whose items you want to update.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "ede846222cd44046ba6c638442c3505a"
-            }
-          },
-          {
-            "name": "allowedOutdatedData",
-            "in": "query",
-            "description": "In order to optimize performance, this parameter allows some information to not be updated when there are changes in the minicart. For instance, if a shopper adds another unit of a given SKU to the cart, it may not be necessary to recalculate payment information, which could impact performance.\n\r\n\rThis array accepts strings and currently the only possible value is `”paymentData”`.",
-            "required": false,
-            "style": "form",
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "text/plain": {
+                "example": "2"
+              }
+            }
+          }
+        },
+        "deprecated": false
+      },
+      "post": {
+        "tags": [
+          "Configuration"
+        ],
+        "summary": "Update window to change seller",
+        "description": "Updates a marketplace’s window to change seller, that is, the period when it is possible to choose another seller to fulfill a given order after the original seller has canceled it.\n\r\n\rIt is possible to check the current window using the request Get window to change seller.",
+        "operationId": "UpdateWindowToChangeSeller",
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
             "schema": {
-              "type": "array",
-              "default": [
-                "paymentData"
-              ],
-              "items": {}
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
             }
           }
         ],
         "requestBody": {
           "description": "",
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/WaitingTime"
+              },
+              "example": {
+                "waitingTime": 4
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "201": {
+            "description": "Created",
+            "headers": {}
+          }
+        },
+        "deprecated": false
+      }
+    },
+    "/api/oms/pvt/orders/{orderId}/cancel": {
+      "post": {
+        "tags": [
+          "Orders"
+        ],
+        "summary": "Cancel order",
+        "description": "Cancels an order using its identification code (`orderId`). A common scenario is when the seller has a problem fulfilling the order and requests the marketplace to cancel it. \r\n\r\n## Orders that cannot be canceled \r\n\r\nThe following situations do not allow order cancellation: \r\n\r\n- **Partial invoices:** [Partially invoiced](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe) orders cannot be canceled. However, the customer can [change the order](https://developers.vtex.com/docs/guides/change-order) to replace or remove items from it. \r\n\r\n- **Invoiced status:** Orders with `invoiced` [status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196) cannot be canceled. If the order has already been invoiced, you can use the [Order invoice notification](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/invoice) endpoint to generate a return invoice. \r\n\r\n- **Incomplete orders:** [Incomplete orders](https://help.vtex.com/en/tutorial/how-incomplete-orders-work--tutorials_294) cannot be canceled. \r\n\r\n## Declining order cancelation \r\n\r\nThe order flow has a cancellation window (grace period) in which the customer can automatically cancel the order. Except for that period, the seller can [decline an order cancellation request](https://help.vtex.com/en/tutorial/declining-order-cancelation--F2n0h1TeQ5td540Gjyff4), regardless of whether the customer or the marketplace initiated it. \r\n\r\nFor more information, see [Order canceling improvements](https://developers.vtex.com/docs/guides/order-canceling-improvements). \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **Cancel order** | \r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| OMS - Full access | Cancel order |\r\n| IntegrationProfile - Fulfillment Oms | Cancel order |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). \r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
+        "operationId": "CancelOrder",
+        "parameters": [
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Describes the type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "orderId",
+            "in": "path",
+            "description": "ID that identifies the order in the seller.",
+            "example": "1172452900788-01",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "example": "1172452900788-01"
+            }
+          }
+        ],
+        "requestBody": {
           "content": {
             "application/json": {
               "schema": {
                 "type": "object",
                 "properties": {
-                  "noSplitItem": {
-                    "type": "boolean",
-                    "description": "Avoid split items on cart"
+                  "reason": {
+                    "type": "string",
+                    "description": "Reason for cancelling the order.",
+                    "example": "Unexpected stock shortage"
                   },
-                  "orderItems": {
-                    "type": "array",
-                    "description": "Array containing the cart items. Each object inside this array corresponds to a different item.",
-                    "items": {
-                      "required": [
-                        "quantity",
-                        "index"
-                      ],
-                      "type": "object",
-                      "properties": {
-                        "quantity": {
-                          "type": "integer",
-                          "format": "int32",
-                          "description": "The quantity of the item in the cart.",
-                          "example": 3
-                        },
-                        "index": {
-                          "type": "integer",
-                          "description": "The position of the item in the array.",
-                          "example": 0
-                        }
-                      }
-                    }
+                  "requestedByUser": {
+                    "type": "boolean",
+                    "description": "If requested by the user",
+                    "example": "User canceled the order "
                   }
                 }
               }
             }
-          },
-          "required": true
+          }
         },
         "responses": {
           "200": {
@@ -21463,13992 +21385,48 @@
                 "schema": {
                   "type": "object",
                   "properties": {
-                    "orderFormId": {
-                      "type": "string",
-                      "description": "ID of the orderForm corresponding to a specific cart."
-                    },
-                    "salesChannel": {
-                      "type": "string",
-                      "description": "Attribute created by the seller, in their VTEX store configuration."
-                    },
-                    "loggedIn": {
-                      "type": "boolean",
-                      "description": "Indicates whether the user is logged into the store."
-                    },
-                    "isCheckedIn": {
-                      "type": "boolean",
-                      "description": "Indicates whether order is checked in."
-                    },
-                    "storeId": {
-                      "type": "string",
-                      "description": "ID of the store.",
-                      "nullable": true
-                    },
-                    "allowManualPrice": {
-                      "type": "boolean",
-                      "description": "Permission to modify item price manually."
-                    },
-                    "canEditData": {
-                      "type": "boolean",
-                      "description": "Data can be edited."
-                    },
-                    "userProfileId": {
+                    "date": {
                       "type": "string",
-                      "description": "Unique ID associated with the customer profile."
+                      "description": "Date and time when the notification was received."
                     },
-                    "profileProvider": {
+                    "orderId": {
                       "type": "string",
-                      "description": "Profile provider."
-                    },
-                    "availableAccounts": {
-                      "type": "array",
-                      "description": "Available accounts.",
-                      "items": {
-                        "type": "string"
-                      }
-                    },
-                    "availableAddresses": {
-                      "type": "array",
-                      "description": "Information on each available address.",
-                      "items": {
-                        "type": "object",
-                        "properties": {
-                          "addressType": {
-                            "type": "string",
-                            "description": "Address type."
-                          },
-                          "receiverName": {
-                            "type": "string",
-                            "description": "Name of the receiver."
-                          },
-                          "addressId": {
-                            "type": "string",
-                            "description": "Address ID."
-                          },
-                          "isDisposable": {
-                            "type": "boolean",
-                            "description": "Indicates whether address is disposable."
-                          },
-                          "city": {
-                            "type": "string",
-                            "description": "City of the address."
-                          },
-                          "state": {
-                            "type": "string",
-                            "description": "State of the address."
-                          },
-                          "country": {
-                            "type": "string",
-                            "description": "Country of the address. ISO three-letter code."
-                          },
-                          "street": {
-                            "type": "string",
-                            "description": "Street of the address."
-                          },
-                          "number": {
-                            "type": "string",
-                            "description": "Number of the address."
-                          },
-                          "neighborhood": {
-                            "type": "string",
-                            "description": "Neighborhood of the address."
-                          },
-                          "complement": {
-                            "type": "string",
-                            "description": "Complement to the address.",
-                            "nullable": true
-                          },
-                          "reference": {
-                            "type": "string",
-                            "description": "Reference that may help in the location of the address.",
-                            "nullable": true
-                          },
-                          "geoCoordinates": {
-                            "type": "array",
-                            "description": "List with the two geocoordinates.",
-                            "items": {
-                              "type": "string"
-                            }
-                          }
-                        }
-                      }
+                      "description": "Identification of the order in the seller."
                     },
-                    "userType": {
+                    "receipt": {
                       "type": "string",
-                      "description": "User type.",
-                      "nullable": true
-                    },
-                    "ignoreProfileData": {
-                      "type": "boolean",
-                      "description": "Ignore customer profile data."
-                    },
-                    "value": {
-                      "type": "integer",
-                      "description": "Total value of the order without separating cents. For example, $24.99 is represented as `2499`."
-                    },
-                    "messages": {
-                      "type": "array",
-                      "description": "Array containing an object for each message generated by our servers while processing the request."
-                    },
-                    "items": {
-                      "type": "array",
-                      "description": "Information on each item in the order.",
-                      "items": {
-                        "type": "object",
-                        "properties": {
-                          "uniqueId": {
-                            "type": "string",
-                            "description": "Unique ID."
-                          },
-                          "id": {
-                            "type": "string",
-                            "description": "ID of the item."
-                          },
-                          "productId": {
-                            "type": "string",
-                            "description": "Product ID."
-                          },
-                          "productRefId": {
-                            "type": "string",
-                            "description": "Product Ref ID."
-                          },
-                          "refId": {
-                            "type": "string",
-                            "description": "Ref ID."
-                          },
-                          "ean": {
-                            "type": "string",
-                            "description": "European Article Number.",
-                            "nullable": true
-                          },
-                          "name": {
-                            "type": "string",
-                            "description": "Product name."
-                          },
-                          "skuName": {
-                            "type": "string",
-                            "description": "SKU name."
-                          },
-                          "modalType": {
-                            "type": "string",
-                            "description": "Modal type.",
-                            "nullable": true
-                          },
-                          "parentItemIndex": {
-                            "type": "integer",
-                            "description": "Parent item index.",
-                            "nullable": true
-                          },
-                          "parentAssemblyBinding": {
-                            "type": "string",
-                            "description": "Parent assembly binding.",
-                            "nullable": true
-                          },
-                          "priceValidUntil": {
-                            "type": "string",
-                            "description": "Price expiration date and time."
-                          },
-                          "tax": {
-                            "type": "integer",
-                            "description": "Tax value in cents."
-                          },
-                          "taxCode": {
-                            "type": "string",
-                            "description": "A unique identifier code assigned to a tax within the VTEX Admin."
-                          },
-                          "price": {
-                            "type": "integer",
-                            "description": "Price in cents."
-                          },
-                          "listPrice": {
-                            "type": "integer",
-                            "description": "List price in cents."
-                          },
-                          "manualPrice": {
-                            "type": "integer",
-                            "description": "Manual price in cents.",
-                            "nullable": true
-                          },
-                          "manualPriceAppliedBy": {
-                            "type": "string",
-                            "description": "User that applied the manual price, if that is the case.",
-                            "nullable": true
-                          },
-                          "sellingPrice": {
-                            "type": "integer",
-                            "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
-                          },
-                          "rewardValue": {
-                            "type": "integer",
-                            "description": "Reward value in cents."
-                          },
-                          "isGift": {
-                            "type": "boolean",
-                            "description": "Indicates whether item is a gift."
-                          },
-                          "additionalInfo": {
-                            "type": "object",
-                            "description": "Additional information.",
-                            "properties": {
-                              "dimension": {
-                                "type": "string",
-                                "description": "Dimension.",
-                                "nullable": true
-                              },
-                              "brandName": {
-                                "type": "string",
-                                "description": "Brand name."
-                              },
-                              "brandId": {
-                                "type": "string",
-                                "description": "Brand ID."
-                              },
-                              "offeringInfo": {
-                                "type": "string",
-                                "description": "Offering information.",
-                                "nullable": true
-                              },
-                              "offeringType": {
-                                "type": "string",
-                                "description": "Offering type.",
-                                "nullable": true
-                              },
-                              "offeringTypeId": {
-                                "type": "string",
-                                "description": "Offering type ID.",
-                                "nullable": true
-                              }
-                            }
-                          },
-                          "preSaleDate": {
-                            "type": "string",
-                            "description": "Presale date.",
-                            "nullable": true
-                          },
-                          "productCategoryIds": {
-                            "type": "string",
-                            "description": "Product category IDs."
-                          },
-                          "productCategories": {
-                            "type": "object",
-                            "description": "Object, where each field is an ID from `productCategoryIds`.",
-                            "properties": {
-                              "{ID}": {
-                                "type": "string",
-                                "description": "Product category corresponding to the ID in the field key."
-                              }
-                            }
-                          },
-                          "quantity": {
-                            "type": "integer",
-                            "description": "Quantity."
-                          },
-                          "seller": {
-                            "type": "string",
-                            "description": "Seller."
-                          },
-                          "sellerChain": {
-                            "type": "array",
-                            "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
-                            "items": {
-                              "type": "string",
-                              "description": "Seller."
-                            }
-                          },
-                          "imageUrl": {
-                            "type": "string",
-                            "description": "Image URL."
-                          },
-                          "detailUrl": {
-                            "type": "string",
-                            "description": "Detail URL."
-                          },
-                          "bundleItems": {
-                            "type": "array",
-                            "description": "Information on services sold along with the SKU. Example: a gift package.",
-                            "items": {
-                              "type": "object",
-                              "properties": {
-                                "type": {
-                                  "type": "string",
-                                  "description": "Service type."
-                                },
-                                "id": {
-                                  "type": "integer",
-                                  "description": "Service identifier."
-                                },
-                                "name": {
-                                  "type": "string",
-                                  "description": "Service name."
-                                },
-                                "price": {
-                                  "type": "integer",
-                                  "description": "Service price in cents."
-                                }
-                              }
-                            }
-                          },
-                          "attachments": {
-                            "type": "array",
-                            "description": "Array containing information on attachments.",
-                            "items": {
-                              "type": "string"
-                            }
-                          },
-                          "priceTags": {
-                            "type": "array",
-                            "description": "Array of price tags, each of which, modifies the price in some way, like discounts or rates that apply to the item in the context of the order.",
-                            "items": {
-                              "type": "object",
-                              "properties": {
-                                "identifier": {
-                                  "type": "string",
-                                  "description": "Price tag identifier."
-                                },
-                                "isPercentual": {
-                                  "type": "boolean",
-                                  "description": "Indicates whether price tag value is applied through a percentage."
-                                },
-                                "name": {
-                                  "type": "string",
-                                  "description": "Price tag name."
-                                },
-                                "rawValue": {
-                                  "type": "integer",
-                                  "description": "Price tag raw value."
-                                },
-                                "value": {
-                                  "type": "integer",
-                                  "description": "Price tag value."
-                                }
-                              }
-                            }
-                          },
-                          "availability": {
-                            "type": "string",
-                            "description": "Availability."
-                          },
-                          "measurementUnit": {
-                            "type": "string",
-                            "description": "Measurement unit."
-                          },
-                          "unitMultiplier": {
-                            "type": "integer",
-                            "description": "Unit multiplier."
-                          },
-                          "manufacturerCode": {
-                            "type": "string",
-                            "description": "Manufacturer code.",
-                            "nullable": true
-                          },
-                          "priceDefinition": {
-                            "type": "object",
-                            "description": "Price information for all units of a specific item.",
-                            "properties": {
-                              "calculatedSellingPrice": {
-                                "type": "integer",
-                                "description": "Item's calculated unitary selling price in cents."
-                              },
-                              "total": {
-                                "type": "integer",
-                                "description": "Total value for all units of the item in cents."
-                              },
-                              "sellingPrices": {
-                                "type": "array",
-                                "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
-                                "items": {
-                                  "type": "object",
-                                  "properties": {
-                                    "value": {
-                                      "type": "integer",
-                                      "description": "Value in cents for that specific rounding."
-                                    },
-                                    "quantity": {
-                                      "type": "integer",
-                                      "description": "Rounding quantity, meaning how many items are rounded to this value."
-                                    }
-                                  }
-                                }
-                              }
-                            }
-                          }
-                        }
-                      }
-                    },
-                    "selectableGifts": {
-                      "type": "array",
-                      "description": "Array containing the data of the item selected as a gift."
-                    },
-                    "totalizers": {
-                      "type": "array",
-                      "description": "Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value)."
-                    },
-                    "shippingData": {
-                      "type": "object",
-                      "description": "Shipping information pertinent to the order.",
-                      "properties": {
-                        "address": {
-                          "type": "object",
-                          "description": "Address information.",
-                          "properties": {
-                            "addressType": {
-                              "type": "string",
-                              "description": "Type of address. For example, `Residential` or `Pickup`."
-                            },
-                            "receiverName": {
-                              "type": "string",
-                              "description": "Name of the person who is going to receive the order."
-                            },
-                            "addressId": {
-                              "type": "string",
-                              "description": "Address ID."
-                            },
-                            "isDisposable": {
-                              "type": "boolean",
-                              "description": "Indicates whether address is disposable."
-                            },
-                            "postalCode": {
-                              "type": "string",
-                              "description": "Postal code."
-                            },
-                            "city": {
-                              "type": "string",
-                              "description": "City of the shipping address."
-                            },
-                            "state": {
-                              "type": "string",
-                              "description": "State of the shipping address."
-                            },
-                            "country": {
-                              "type": "string",
-                              "description": "Three letter ISO code of the country of the shipping address."
-                            },
-                            "street": {
-                              "type": "string",
-                              "description": "Street of the shipping address."
-                            },
-                            "number": {
-                              "type": "string",
-                              "description": "Number of the building, house or apartment in the shipping address."
-                            },
-                            "neighborhood": {
-                              "type": "string",
-                              "description": "Neighborhood of the shipping address."
-                            },
-                            "complement": {
-                              "type": "string",
-                              "description": "Complement to the shipping address, in case it applies.",
-                              "nullable": true
-                            },
-                            "reference": {
-                              "type": "string",
-                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
-                              "nullable": true
-                            },
-                            "geoCoordinates": {
-                              "type": "array",
-                              "description": "Array with two strings with geocoordinates, first latitude, then longitude.",
-                              "items": {
-                                "type": "string"
-                              }
-                            }
-                          }
-                        },
-                        "logisticsInfo": {
-                          "type": "array",
-                          "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "itemIndex": {
-                                "type": "integer",
-                                "description": "Index corresponding to the position of the object in the `items` array."
-                              },
-                              "selectedSla": {
-                                "type": "string",
-                                "description": "SLA selected by the customer."
-                              },
-                              "selectedDeliveryChannel": {
-                                "type": "string",
-                                "description": "Delivery channel selected by the customer."
-                              },
-                              "addressId": {
-                                "type": "string",
-                                "description": "Address ID."
-                              },
-                              "slas": {
-                                "type": "array",
-                                "description": "Information on available SLAs.",
-                                "items": {
-                                  "type": "object",
-                                  "properties": {
-                                    "id": {
-                                      "type": "string",
-                                      "description": "SLA ID."
-                                    },
-                                    "deliveryChannel": {
-                                      "type": "string",
-                                      "description": "Delivery channel."
-                                    },
-                                    "name": {
-                                      "type": "string",
-                                      "description": "SLA name."
-                                    },
-                                    "deliveryIds": {
-                                      "type": "array",
-                                      "description": "Information on each delivery ID.",
-                                      "items": {
-                                        "type": "object",
-                                        "properties": {
-                                          "courierId": {
-                                            "type": "string",
-                                            "description": "Courier ID."
-                                          },
-                                          "warehouseId": {
-                                            "type": "string",
-                                            "description": "Warehouse ID."
-                                          },
-                                          "dockId": {
-                                            "type": "string",
-                                            "description": "Warehouse ID."
-                                          },
-                                          "courierName": {
-                                            "type": "string",
-                                            "description": "Courier name."
-                                          },
-                                          "quantity": {
-                                            "type": "integer",
-                                            "description": "Quantity."
-                                          }
-                                        }
-                                      }
-                                    },
-                                    "shippingEstimate": {
-                                      "type": "string",
-                                      "description": "Shipping estimate. For instance, \"three business days\" will be represented as `3bd`."
-                                    },
-                                    "shippingEstimateDate": {
-                                      "type": "string",
-                                      "description": "Shipping estimate date.",
-                                      "nullable": true
-                                    },
-                                    "lockTTL": {
-                                      "type": "string",
-                                      "description": "Estimate date of delivery."
-                                    },
-                                    "price": {
-                                      "type": "integer",
-                                      "description": "Price in cents."
-                                    },
-                                    "listPrice": {
-                                      "type": "integer",
-                                      "description": "List price in cents."
-                                    },
-                                    "tax": {
-                                      "type": "integer",
-                                      "description": "Tax in cents."
-                                    },
-                                    "pickupStoreInfo": {
-                                      "type": "object",
-                                      "description": "Information on the pickup store.",
-                                      "properties": {
-                                        "isPickupStore": {
-                                          "type": "boolean",
-                                          "description": "Indicates whether it is the pickup store."
-                                        },
-                                        "friendlyName": {
-                                          "type": "string",
-                                          "description": "Friendly name.",
-                                          "nullable": true
-                                        },
-                                        "address": {
-                                          "type": "object",
-                                          "description": "Address information.",
-                                          "nullable": true,
-                                          "properties": {
-                                            "addressType": {
-                                              "type": "string",
-                                              "description": "Type of address. For example, `Residential` or `Pickup`."
-                                            },
-                                            "postalCode": {
-                                              "type": "string",
-                                              "description": "Postal code."
-                                            },
-                                            "city": {
-                                              "type": "string",
-                                              "description": "City of the shipping address."
-                                            },
-                                            "state": {
-                                              "type": "string",
-                                              "description": "State of the shipping address."
-                                            },
-                                            "country": {
-                                              "type": "string",
-                                              "description": "Three letter ISO code of the country of the shipping address."
-                                            },
-                                            "street": {
-                                              "type": "string",
-                                              "description": "Street of the shipping address."
-                                            },
-                                            "number": {
-                                              "type": "string",
-                                              "description": "Number of the building, house or apartment in the shipping address."
-                                            },
-                                            "neighborhood": {
-                                              "type": "string",
-                                              "description": "Neighborhood of the shipping address."
-                                            },
-                                            "complement": {
-                                              "type": "string",
-                                              "description": "Complement to the shipping address, in case it applies.",
-                                              "nullable": true
-                                            },
-                                            "reference": {
-                                              "type": "string",
-                                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
-                                              "nullable": true
-                                            },
-                                            "geoCoordinates": {
-                                              "type": "array",
-                                              "description": "Array with two strings with geocoordinates, first latitude, then longitude.",
-                                              "items": {
-                                                "type": "string"
-                                              }
-                                            }
-                                          }
-                                        },
-                                        "additionalInfo": {
-                                          "type": "string",
-                                          "description": "Additional information.",
-                                          "nullable": true
-                                        },
-                                        "dockId": {
-                                          "type": "string",
-                                          "description": "Corresponding dock ID.",
-                                          "nullable": true
-                                        }
-                                      }
-                                    },
-                                    "pickupPointId": {
-                                      "type": "string",
-                                      "description": "Pickup point ID.",
-                                      "nullable": true
-                                    },
-                                    "pickupDistance": {
-                                      "type": "integer",
-                                      "description": "Pickup point distance."
-                                    },
-                                    "polygonName": {
-                                      "type": "string",
-                                      "description": "Polygon name.",
-                                      "nullable": true
-                                    },
-                                    "transitTime": {
-                                      "type": "string",
-                                      "description": "Transit time. For instance, \"three business days\" is represented as `3bd`."
-                                    }
-                                  }
-                                }
-                              },
-                              "shipsTo": {
-                                "type": "array",
-                                "description": "List of countries that the item may be shipped to.",
-                                "items": {
-                                  "type": "string",
-                                  "description": "Three letter country code."
-                                }
-                              },
-                              "itemId": {
-                                "type": "string",
-                                "description": "Item ID."
-                              },
-                              "deliveryChannels": {
-                                "type": "array",
-                                "description": "List of available delivery channels.",
-                                "items": {
-                                  "type": "object",
-                                  "properties": {
-                                    "id": {
-                                      "type": "string",
-                                      "description": "Delivery channel ID."
-                                    }
-                                  }
-                                }
-                              }
-                            }
-                          }
-                        },
-                        "selectedAddresses": {
-                          "type": "array",
-                          "description": "Array with information on the selected addresses for the order.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "addressType": {
-                                "type": "string",
-                                "description": "Type of address. For example, `Residential` or `Pickup`."
-                              },
-                              "receiverName": {
-                                "type": "string",
-                                "description": "Name of the person who is going to receive the order."
-                              },
-                              "addressId": {
-                                "type": "string",
-                                "description": "Address ID."
-                              },
-                              "isDisposable": {
-                                "type": "boolean",
-                                "description": "Indicates whether address is disposable."
-                              },
-                              "postalCode": {
-                                "type": "string",
-                                "description": "Postal code."
-                              },
-                              "city": {
-                                "type": "string",
-                                "description": "City of the shipping address."
-                              },
-                              "state": {
-                                "type": "string",
-                                "description": "State of the shipping address."
-                              },
-                              "country": {
-                                "type": "string",
-                                "description": "Three letter ISO code of the country of the shipping address."
-                              },
-                              "street": {
-                                "type": "string",
-                                "description": "Street of the shipping address."
-                              },
-                              "number": {
-                                "type": "string",
-                                "description": "Number of the building, house or apartment in the shipping address."
-                              },
-                              "neighborhood": {
-                                "type": "string",
-                                "description": "Neighborhood of the shipping address."
-                              },
-                              "complement": {
-                                "type": "string",
-                                "description": "Complement to the shipping address, in case it applies."
-                              },
-                              "reference": {
-                                "type": "string",
-                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
-                                "nullable": true
-                              },
-                              "geoCoordinates": {
-                                "type": "array",
-                                "description": "Array with two strings with geocoordinates, first latitude, then longitude.",
-                                "items": {
-                                  "type": "string"
-                                }
-                              }
-                            }
-                          }
-                        },
-                        "availableAddresses": {
-                          "type": "array",
-                          "description": "Array with information on the available addresses for the order.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "addressType": {
-                                "type": "string",
-                                "description": "Type of address. For example, `Residential` or `Pickup`."
-                              },
-                              "receiverName": {
-                                "type": "string",
-                                "description": "Name of the person who is going to receive the order."
-                              },
-                              "addressId": {
-                                "type": "string",
-                                "description": "Address ID."
-                              },
-                              "isDisposable": {
-                                "type": "boolean",
-                                "description": "Indicates whether address is disposable."
-                              },
-                              "postalCode": {
-                                "type": "string",
-                                "description": "Postal code."
-                              },
-                              "city": {
-                                "type": "string",
-                                "description": "City of the shipping address."
-                              },
-                              "state": {
-                                "type": "string",
-                                "description": "State of the shipping address."
-                              },
-                              "country": {
-                                "type": "string",
-                                "description": "Three letter ISO code of the country of the shipping address."
-                              },
-                              "street": {
-                                "type": "string",
-                                "description": "Street of the shipping address."
-                              },
-                              "number": {
-                                "type": "string",
-                                "description": "Number of the building, house or apartment in the shipping address."
-                              },
-                              "neighborhood": {
-                                "type": "string",
-                                "description": "Neighborhood of the shipping address."
-                              },
-                              "complement": {
-                                "type": "string",
-                                "description": "Complement to the shipping address, in case it applies."
-                              },
-                              "reference": {
-                                "type": "string",
-                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
-                                "nullable": true
-                              },
-                              "geoCoordinates": {
-                                "type": "array",
-                                "description": "Array with two strings with geocoordinates, first latitude, then longitude.",
-                                "items": {
-                                  "type": "string"
-                                }
-                              }
-                            }
-                          }
-                        }
-                      }
-                    },
-                    "clientProfileData": {
-                      "type": "object",
-                      "description": "Customer's profile information.",
-                      "properties": {
-                        "email": {
-                          "type": "string",
-                          "description": "Email address."
-                        },
-                        "firstName": {
-                          "type": "string",
-                          "description": "First name."
-                        },
-                        "lastName": {
-                          "type": "string",
-                          "description": "Last name."
-                        },
-                        "documentType": {
-                          "type": "string",
-                          "description": "Type of the document informed by the customer."
-                        },
-                        "document": {
-                          "type": "string",
-                          "description": "Document informed by the customer."
-                        },
-                        "phone": {
-                          "type": "string",
-                          "description": "Phone number."
-                        },
-                        "corporateName": {
-                          "type": "string",
-                          "description": "Company name, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "tradeName": {
-                          "type": "string",
-                          "description": "Trade name, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "corporateDocument": {
-                          "type": "string",
-                          "description": "Corporate document, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "stateInscription": {
-                          "type": "string",
-                          "description": "State inscription, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "corporatePhone": {
-                          "type": "string",
-                          "description": "Corporate phone number, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "isCorporate": {
-                          "type": "boolean",
-                          "description": "Indicates whether the customer is a legal entity."
-                        },
-                        "profileCompleteOnLoading": {
-                          "type": "boolean",
-                          "description": "Indicates whether profile is complete on loading."
-                        },
-                        "profileErrorOnLoading": {
-                          "type": "boolean",
-                          "description": "Indicates whether profile presents error on loading.",
-                          "nullable": true
-                        },
-                        "customerClass": {
-                          "type": "string",
-                          "description": "Customer class.",
-                          "nullable": true
-                        }
-                      }
-                    },
-                    "paymentData": {
-                      "type": "object",
-                      "description": "Information on the order's payment.",
-                      "properties": {
-                        "giftCards": {
-                          "type": "array",
-                          "description": "Gift card information, if it applies to the order.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "redemptionCode": {
-                                "type": "string",
-                                "description": "Gift card redemption code."
-                              },
-                              "value": {
-                                "type": "integer",
-                                "description": "Gift card value in cents."
-                              },
-                              "balance": {
-                                "type": "integer",
-                                "description": "Gift card balance in cents."
-                              },
-                              "name": {
-                                "type": "string",
-                                "description": "Gift card name."
-                              },
-                              "id": {
-                                "type": "string",
-                                "description": "Gift card ID."
-                              },
-                              "inUse": {
-                                "type": "boolean",
-                                "description": "Indicates whether gift card is in use."
-                              },
-                              "isSpecialCard": {
-                                "type": "boolean",
-                                "description": "Indicates whether gift card is special."
-                              }
-                            }
-                          }
-                        },
-                        "transactions": {
-                          "type": "array",
-                          "description": "Information on each transaction pertinent to the order.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "isActive": {
-                                "type": "boolean",
-                                "description": "Indicates whether transaction is active."
-                              },
-                              "transactionId": {
-                                "type": "string",
-                                "description": "Transaction ID."
-                              },
-                              "merchantName": {
-                                "type": "string",
-                                "description": "Merchant name."
-                              },
-                              "payments": {
-                                "type": "array",
-                                "description": "Information on each payment.",
-                                "items": {
-                                  "type": "object",
-                                  "properties": {
-                                    "accountId": {
-                                      "type": "string",
-                                      "description": "Account ID."
-                                    },
-                                    "bin": {
-                                      "type": "string",
-                                      "description": "Bin."
-                                    },
-                                    "installments": {
-                                      "type": "integer",
-                                      "description": "Number of installments."
-                                    },
-                                    "paymentSystem": {
-                                      "type": "string",
-                                      "description": "Payment system."
-                                    },
-                                    "referenceValue": {
-                                      "type": "integer",
-                                      "description": "Reference value for calculating interest rates, in case it applies. Displayed in cents."
-                                    },
-                                    "value": {
-                                      "type": "integer",
-                                      "description": "Value including interest, in case it applies. Displayed in cents."
-                                    }
-                                  }
-                                }
-                              },
-                              "sharedTransaction": {
-                                "type": "boolean",
-                                "description": "Indicates whather transaction is shared."
-                              }
-                            }
-                          }
-                        }
-                      }
-                    },
-                    "marketingData": {
-                      "type": "object",
-                      "description": "Object containing promotion data such as coupon tracking information and internal or external UTMs.",
-                      "properties": {
-                        "coupon": {
-                          "type": "string",
-                          "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.",
-                          "default": "free-shipping"
-                        },
-                        "utmSource": {
-                          "type": "string",
-                          "description": "UTM source.",
-                          "default": "Facebook"
-                        },
-                        "utmMedium": {
-                          "type": "string",
-                          "description": "UTM medium.",
-                          "default": "CPC"
-                        },
-                        "utmCampaign": {
-                          "type": "string",
-                          "description": "UTM campaign",
-                          "default": "Black friday"
-                        },
-                        "utmiPage": {
-                          "type": "string",
-                          "description": "utmi_page (internal utm).",
-                          "default": "utmi_page-example",
-                          "nullable": true
-                        },
-                        "utmiPart": {
-                          "type": "string",
-                          "description": "utmi_part (internal utm).",
-                          "default": "utmi_part-example",
-                          "nullable": true
-                        },
-                        "utmiCampaign": {
-                          "type": "string",
-                          "description": "utmi_campaign (internal utm).",
-                          "default": "utmi_campaign-example",
-                          "nullable": true
-                        }
-                      }
-                    },
-                    "sellers": {
-                      "type": "array",
-                      "description": "Information on each seller.",
-                      "items": {
-                        "type": "object",
-                        "properties": {
-                          "id": {
-                            "type": "string",
-                            "description": "Seller ID."
-                          },
-                          "name": {
-                            "type": "string",
-                            "description": "Seller name."
-                          },
-                          "logo": {
-                            "type": "string",
-                            "description": "Seller logo.",
-                            "nullable": true
-                          }
-                        }
-                      }
-                    },
-                    "clientPreferencesData": {
-                      "type": "object",
-                      "description": "Object containing preferences from the client who placed the order.",
-                      "properties": {
-                        "locale": {
-                          "type": "string",
-                          "description": "Client's locale. Examples: `pt-BR` and `en-US`."
-                        },
-                        "optinNewsLetter": {
-                          "type": "boolean",
-                          "description": "`true` if the client opted to receive newsletter from the store.",
-                          "default": false
-                        }
-                      }
-                    },
-                    "commercialConditionData": {
-                      "type": "object",
-                      "description": "Object containing commercial condition information.",
-                      "nullable": true
-                    },
-                    "storePreferencesData": {
-                      "type": "object",
-                      "description": "Object containing data from the store's configuration (stored in VTEX's License Manager)."
-                    },
-                    "giftRegistryData": {
-                      "type": "object",
-                      "description": "Gift registry list information.",
-                      "nullable": true
-                    },
-                    "openTextField": {
-                      "type": "string",
-                      "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).",
-                      "default": "open-text-example",
-                      "nullable": true
-                    },
-                    "invoiceData": {
-                      "type": "object",
-                      "description": "Object containing information pertinent to the order's invoice.",
-                      "nullable": true
-                    },
-                    "customData": {
-                      "type": "object",
-                      "description": "Customer additional information.",
-                      "nullable": true
-                    },
-                    "itemMetadata": {
-                      "type": "object",
-                      "description": "Item metadata.",
-                      "properties": {
-                        "items": {
-                          "type": "array",
-                          "description": "List of objects containing metadata on each item in the order.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "id": {
-                                "type": "string",
-                                "description": "Item ID."
-                              },
-                              "seller": {
-                                "type": "string",
-                                "description": "Seller."
-                              },
-                              "name": {
-                                "type": "string",
-                                "description": "Product name."
-                              },
-                              "skuName": {
-                                "type": "string",
-                                "description": "SKU name."
-                              },
-                              "productId": {
-                                "type": "string",
-                                "description": "Product ID."
-                              },
-                              "refId": {
-                                "type": "string",
-                                "description": "Ref ID."
-                              },
-                              "ean": {
-                                "type": "string",
-                                "description": "European Article Number.",
-                                "nullable": true
-                              },
-                              "imageUrl": {
-                                "type": "string",
-                                "description": "Image URL."
-                              },
-                              "detailUrl": {
-                                "type": "string",
-                                "description": "Detail URL."
-                              }
-                            }
-                          }
-                        }
-                      }
-                    },
-                    "hooksData": {
-                      "type": "object",
-                      "description": "Hooks information.",
-                      "nullable": true
-                    },
-                    "ratesAndBenefitsData": {
-                      "type": "object",
-                      "description": "Information on rates and benefits that apply to the order.",
-                      "properties": {
-                        "rateAndBenefitsIdentifiers": {
-                          "type": "array",
-                          "description": "List with rates and benefits identifiers.",
-                          "items": {
-                            "type": "string"
-                          }
-                        },
-                        "teaser": {
-                          "type": "array",
-                          "description": "List with rates and benefits teasers.",
-                          "items": {
-                            "type": "string"
-                          }
-                        }
-                      }
-                    },
-                    "subscriptionData": {
-                      "type": "object",
-                      "description": "Subscription information.",
-                      "nullable": true
-                    },
-                    "itemsOrdination": {
-                      "type": "object",
-                      "description": "Object containing information about the ordering of items within the `orderForm`.",
-                      "properties": {
-                        "criteria": {
-                          "type": "string",
-                          "description": "Criteria adopted to order the items in the list."
-                        },
-                        "ascending": {
-                          "type": "boolean",
-                          "description": "Indicates whether the ordering is ascending."
-                        }
-                      }
-                    }
-                  }
-                },
-                "example": {
-                  "orderFormId": "ede846222cd44046ba6c638442c3505a",
-                  "salesChannel": "1",
-                  "loggedIn": false,
-                  "isCheckedIn": false,
-                  "storeId": null,
-                  "allowManualPrice": false,
-                  "canEditData": true,
-                  "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
-                  "profileProvider": "VTEX",
-                  "availableAccounts": [],
-                  "availableAddresses": [
-                    {
-                      "addressType": "residential",
-                      "receiverName": "Clark Kent",
-                      "addressId": "666c2e830bd9474ab6f6cc53fb6dd2d2",
-                      "isDisposable": true,
-                      "postalCode": "70386000",
-                      "city": "Brasília",
-                      "state": "DF",
-                      "country": "BRA",
-                      "street": "Rua da minha casa",
-                      "number": "123",
-                      "neighborhood": "Copacabana",
-                      "complement": "15º andar",
-                      "reference": null,
-                      "geoCoordinates": [
-                        "-47.924747467041016",
-                        "-15.832582473754883"
-                      ]
-                    }
-                  ],
-                  "userType": null,
-                  "ignoreProfileData": false,
-                  "value": 34390,
-                  "messages": [],
-                  "items": [
-                    {
-                      "uniqueId": "9D6E447B3FF64CEDA33B17C01379C119",
-                      "id": "2",
-                      "productId": "2",
-                      "productRefId": "",
-                      "refId": "CBC30L",
-                      "ean": null,
-                      "name": "Chopp Brahma Claro 30L",
-                      "skuName": "Chopp Brahma Claro 30L",
-                      "modalType": null,
-                      "parentItemIndex": null,
-                      "parentAssemblyBinding": null,
-                      "assemblies": [],
-                      "priceValidUntil": "2022-07-13T18:30:46Z",
-                      "tax": 0,
-                      "taxCode": "54WC8ZN6K8",
-                      "price": 32890,
-                      "listPrice": 49900,
-                      "manualPrice": null,
-                      "manualPriceAppliedBy": null,
-                      "sellingPrice": 32890,
-                      "rewardValue": 0,
-                      "isGift": false,
-                      "additionalInfo": {
-                        "dimension": null,
-                        "brandName": "Brahma",
-                        "brandId": "2000000",
-                        "offeringInfo": null,
-                        "offeringType": null,
-                        "offeringTypeId": null
-                      },
-                      "preSaleDate": null,
-                      "productCategoryIds": "/1/",
-                      "productCategories": {
-                        "1": "Bebidas"
-                      },
-                      "quantity": 1,
-                      "seller": "1",
-                      "sellerChain": [
-                        "1"
-                      ],
-                      "imageUrl": "http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000",
-                      "detailUrl": "/chopp-brahma-claro-30l/p",
-                      "components": [],
-                      "bundleItems": [],
-                      "attachments": [],
-                      "attachmentOfferings": [],
-                      "offerings": [],
-                      "priceTags": [],
-                      "availability": "available",
-                      "measurementUnit": "un",
-                      "unitMultiplier": 1,
-                      "manufacturerCode": null,
-                      "priceDefinition": {
-                        "calculatedSellingPrice": 32890,
-                        "total": 32890,
-                        "sellingPrices": [
-                          {
-                            "value": 32890,
-                            "quantity": 1
-                          }
-                        ]
-                      }
-                    }
-                  ],
-                  "selectableGifts": [],
-                  "totalizers": [
-                    {
-                      "id": "Items",
-                      "name": "Total dos Itens",
-                      "value": 15000
-                    }
-                  ],
-                  "shippingData": {
-                    "address": {
-                      "addressType": "residential",
-                      "receiverName": "Clark Kent",
-                      "addressId": "teste",
-                      "isDisposable": true,
-                      "postalCode": "70386000",
-                      "city": "Brasília",
-                      "state": "DF",
-                      "country": "BRA",
-                      "street": "Rua da minha casa",
-                      "number": "123",
-                      "neighborhood": "Copacabana",
-                      "complement": "15º andar",
-                      "reference": null,
-                      "geoCoordinates": [
-                        "-47.924747467041016",
-                        "-15.832582473754883"
-                      ]
-                    },
-                    "logisticsInfo": [
-                      {
-                        "itemIndex": 0,
-                        "selectedSla": "Normal",
-                        "selectedDeliveryChannel": "delivery",
-                        "addressId": "teste",
-                        "slas": [
-                          {
-                            "id": "Normal",
-                            "deliveryChannel": "delivery",
-                            "name": "Normal",
-                            "deliveryIds": [
-                              {
-                                "courierId": "1",
-                                "warehouseId": "1_1",
-                                "dockId": "1",
-                                "courierName": "Transportadora",
-                                "quantity": 1,
-                                "kitItemDetails": []
-                              }
-                            ],
-                            "shippingEstimate": "3bd",
-                            "shippingEstimateDate": null,
-                            "lockTTL": "10d",
-                            "availableDeliveryWindows": [],
-                            "deliveryWindow": null,
-                            "price": 1500,
-                            "listPrice": 1500,
-                            "tax": 0,
-                            "pickupStoreInfo": {
-                              "isPickupStore": false,
-                              "friendlyName": null,
-                              "address": null,
-                              "additionalInfo": null,
-                              "dockId": null
-                            },
-                            "pickupPointId": null,
-                            "pickupDistance": 0,
-                            "polygonName": null,
-                            "transitTime": "3bd"
-                          }
-                        ],
-                        "shipsTo": [
-                          "BRA",
-                          "COL",
-                          "USA"
-                        ],
-                        "itemId": "2",
-                        "deliveryChannels": [
-                          {
-                            "id": "delivery"
-                          },
-                          {
-                            "id": "pickup-in-point"
-                          }
-                        ]
-                      }
-                    ],
-                    "selectedAddresses": [
-                      {
-                        "addressType": "residential",
-                        "receiverName": "Clark Kent",
-                        "addressId": "teste",
-                        "isDisposable": true,
-                        "postalCode": "12345000",
-                        "city": "Rio de Janeiro",
-                        "state": "RJ",
-                        "country": "BRA",
-                        "street": "Rua da minha casa",
-                        "number": "123",
-                        "neighborhood": "Copacabana",
-                        "complement": "15º andar",
-                        "reference": null,
-                        "geoCoordinates": [
-                          "-47.924747467041016",
-                          "-15.832582473754883"
-                        ]
-                      }
-                    ],
-                    "availableAddresses": [
-                      {
-                        "addressType": "residential",
-                        "receiverName": "Clark Kent",
-                        "addressId": "teste",
-                        "isDisposable": true,
-                        "postalCode": "12345000",
-                        "city": "Rio de Janeiro",
-                        "state": "RJ",
-                        "country": "BRA",
-                        "street": "Rua da minha casa",
-                        "number": "123",
-                        "neighborhood": "Copacabana",
-                        "complement": "15º andar",
-                        "reference": null,
-                        "geoCoordinates": [
-                          "-47.924747467041016",
-                          "-15.832582473754883"
-                        ]
-                      }
-                    ],
-                    "pickupPoints": []
-                  },
-                  "clientProfileData": {
-                    "email": "clark.kent@example.com",
-                    "firstName": "Clark",
-                    "lastName": "Kent",
-                    "document": "12345678900",
-                    "documentType": "cpf",
-                    "phone": "+5521998765432",
-                    "corporateName": null,
-                    "tradeName": null,
-                    "corporateDocument": null,
-                    "stateInscription": null,
-                    "corporatePhone": null,
-                    "isCorporate": false,
-                    "profileCompleteOnLoading": false,
-                    "profileErrorOnLoading": null,
-                    "customerClass": null
-                  },
-                  "paymentData": {
-                    "installmentOptions": [
-                      {
-                        "paymentSystem": "2",
-                        "bin": null,
-                        "paymentName": null,
-                        "paymentGroupName": null,
-                        "value": 15000,
-                        "installments": [
-                          {
-                            "count": 1,
-                            "hasInterestRate": false,
-                            "interestRate": 0,
-                            "value": 15000,
-                            "total": 15000,
-                            "sellerMerchantInstallments": [
-                              {
-                                "id": "LOJADOBRENO",
-                                "count": 1,
-                                "hasInterestRate": false,
-                                "interestRate": 0,
-                                "value": 15000,
-                                "total": 15000
-                              }
-                            ]
-                          },
-                          {
-                            "count": 2,
-                            "hasInterestRate": false,
-                            "interestRate": 0,
-                            "value": 7500,
-                            "total": 15000,
-                            "sellerMerchantInstallments": [
-                              {
-                                "id": "LOJADOBRENO",
-                                "count": 2,
-                                "hasInterestRate": false,
-                                "interestRate": 0,
-                                "value": 7500,
-                                "total": 15000
-                              }
-                            ]
-                          }
-                        ]
-                      }
-                    ],
-                    "paymentSystems": [
-                      {
-                        "id": 2,
-                        "name": "Visa",
-                        "groupName": "creditCardPaymentGroup",
-                        "validator": {
-                          "regex": "^2[1-8]{17}$",
-                          "mask": "9999 9999 9999 9999",
-                          "cardCodeRegex": "^[0-3]{8}$",
-                          "cardCodeMask": "999",
-                          "weights": [
-                            2,
-                            1,
-                            2,
-                            1,
-                            2,
-                            1
-                          ],
-                          "useCvv": true,
-                          "useExpirationDate": true,
-                          "useCardHolderName": true,
-                          "useBillingAddress": true
-                        },
-                        "stringId": "2",
-                        "template": "creditCardPaymentGroup-template",
-                        "requiresDocument": false,
-                        "isCustom": false,
-                        "description": null,
-                        "requiresAuthentication": false,
-                        "dueDate": "2020-03-05T14:59:00.7879306Z",
-                        "availablePayments": null
-                      }
-                    ],
-                    "payments": [],
-                    "giftCards": [],
-                    "giftCardMessages": [],
-                    "availableAccounts": [],
-                    "availableTokens": []
-                  },
-                  "marketingData": {
-                    "coupon": "free-shipping",
-                    "utmSource": "app",
-                    "utmMedium": "CPC",
-                    "utmCampaign": "Black friday",
-                    "utmipage": null,
-                    "utmiPart": null,
-                    "utmiCampaign": null
-                  },
-                  "sellers": [
-                    {
-                      "id": "1",
-                      "name": "lojadobreno",
-                      "logo": ""
-                    }
-                  ],
-                  "clientPreferencesData": {
-                    "locale": "pt-BR",
-                    "optinNewsLetter": false
-                  },
-                  "commercialConditionData": null,
-                  "storePreferencesData": {
-                    "countryCode": "BRA",
-                    "saveUserData": true,
-                    "timeZone": "E. South America Standard Time",
-                    "currencyCode": "BRL",
-                    "currencyLocale": 1046,
-                    "currencySymboupdate cartl": "R$",
-                    "currencyFormatInfo": {
-                      "currencyDecimalDigits": 2,
-                      "currencyDecimalSeparator": ",",
-                      "currencyGroupSeparator": ".",
-                      "currencyGroupSize": 3,
-                      "startsWithCurrencySymbol": true
-                    }
-                  },
-                  "giftRegistryData": null,
-                  "openTextField": null,
-                  "invoiceData": null,
-                  "customData": null,
-                  "itemMetadata": {
-                    "items": [
-                      {
-                        "id": "1",
-                        "seller": "1",
-                        "name": "Ração Royal Canin Feline Urinary 500g",
-                        "skuName": "Ração Royal Canin Feline Urinary 500g",
-                        "productId": "1",
-                        "refId": "0001",
-                        "ean": "123456789",
-                        "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
-                        "detailUrl": "/racao-royal-canin-feline-urinary/p",
-                        "assemblyOptions": []
-                      }
-                    ]
-                  },
-                  "hooksData": null,
-                  "ratesAndBenefitsData": {
-                    "rateAndBenefitsIdentifiers": [],
-                    "teaser": []
-                  },
-                  "subscriptionData": null,
-                  "itemsOrdination": {
-                    "criteria": "NAME",
-                    "ascending": true
-                  }
-                }
-              }
-            }
-          }
-        },
-        "deprecated": false
-      }
-    },
-    "/api/checkout/pub/orderForm/{orderFormId}/items": {
-      "post": {
-        "tags": [
-          "Shopping cart"
-        ],
-        "summary": "Add cart items",
-        "description": "Use this request to add a new item to the shopping cart.\r\n\r\nThe [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.\n\r\n\r> This request has a time out of 45 seconds.",
-        "operationId": "Items",
-        "security": [],
-        "parameters": [
-          {
-            "name": "Content-Type",
-            "in": "header",
-            "description": "Type of the content being sent.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "Accept",
-            "in": "header",
-            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "orderFormId",
-            "in": "path",
-            "description": "ID of the orderForm corresponding to the cart in which the new item will be added.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "ede846222cd44046ba6c638442c3505a"
-            }
-          },
-          {
-            "name": "allowedOutdatedData",
-            "in": "query",
-            "description": "In order to optimize performance, this parameter allows some information to not be updated when there are changes in the minicart. For instance, if a shopper adds another unit of a given SKU to the cart, it may not be necessary to recalculate payment information, which could impact performance.\n\r\n\rThis array accepts strings and currently the only possible value is `”paymentData”`.",
-            "required": false,
-            "style": "form",
-            "schema": {
-              "type": "array",
-              "default": [
-                "paymentData"
-              ],
-              "items": {}
-            }
-          }
-        ],
-        "requestBody": {
-          "description": "",
-          "content": {
-            "application/json": {
-              "schema": {
-                "type": "object",
-                "properties": {
-                  "orderItems": {
-                    "type": "array",
-                    "description": "Array containing the cart items. Each object inside this array corresponds to a different item.",
-                    "items": {
-                      "required": [
-                        "quantity",
-                        "seller",
-                        "id",
-                        "index"
-                      ],
-                      "type": "object",
-                      "properties": {
-                        "quantity": {
-                          "type": "integer",
-                          "format": "int32",
-                          "description": "The quantity of the item (SKU) in the cart.",
-                          "example": 3
-                        },
-                        "seller": {
-                          "type": "string",
-                          "description": "The seller responsible for the SKU.",
-                          "example": "1"
-                        },
-                        "id": {
-                          "type": "string",
-                          "description": "The ID of the SKU in VTEX platform.",
-                          "example": "2005"
-                        },
-                        "index": {
-                          "type": "integer",
-                          "description": "The position of the item in the array.",
-                          "example": 0
-                        },
-                        "price": {
-                          "type": "integer",
-                          "description": "Price of the item in cents. Send this value in case you want to make a bulk price change.",
-                          "example": 1099
-                        }
-                      }
-                    }
-                  }
-                }
-              }
-            }
-          },
-          "required": true
-        },
-        "responses": {
-          "200": {
-            "description": "OK",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "object",
-                  "properties": {
-                    "orderFormId": {
-                      "type": "string",
-                      "description": "ID of the orderForm corresponding to a specific cart."
-                    },
-                    "salesChannel": {
-                      "type": "string",
-                      "description": "Attribute created by the seller, in their VTEX store configuration."
-                    },
-                    "loggedIn": {
-                      "type": "boolean",
-                      "description": "Indicates whether the user is logged into the store."
-                    },
-                    "isCheckedIn": {
-                      "type": "boolean",
-                      "description": "Indicates whether order is checked in."
-                    },
-                    "storeId": {
-                      "type": "string",
-                      "description": "ID of the store.",
-                      "nullable": true
-                    },
-                    "allowManualPrice": {
-                      "type": "boolean",
-                      "description": "Permission to modify item price manually."
-                    },
-                    "canEditData": {
-                      "type": "boolean",
-                      "description": "Data can be edited."
-                    },
-                    "userProfileId": {
-                      "type": "string",
-                      "description": "Unique ID associated with the customer profile."
-                    },
-                    "profileProvider": {
-                      "type": "string",
-                      "description": "Profile provider."
-                    },
-                    "availableAccounts": {
-                      "type": "array",
-                      "description": "Available accounts.",
-                      "items": {
-                        "type": "string"
-                      }
-                    },
-                    "availableAddresses": {
-                      "type": "array",
-                      "description": "Information on each available address.",
-                      "items": {
-                        "type": "object",
-                        "properties": {
-                          "addressType": {
-                            "type": "string",
-                            "description": "Address type."
-                          },
-                          "receiverName": {
-                            "type": "string",
-                            "description": "Name of the receiver."
-                          },
-                          "addressId": {
-                            "type": "string",
-                            "description": "Address ID."
-                          },
-                          "isDisposable": {
-                            "type": "boolean",
-                            "description": "Indicates whether address is disposable."
-                          },
-                          "city": {
-                            "type": "string",
-                            "description": "City of the address."
-                          },
-                          "state": {
-                            "type": "string",
-                            "description": "State of the address."
-                          },
-                          "country": {
-                            "type": "string",
-                            "description": "Country of the address. ISO three-letter code."
-                          },
-                          "street": {
-                            "type": "string",
-                            "description": "Street of the address."
-                          },
-                          "number": {
-                            "type": "string",
-                            "description": "Number of the address."
-                          },
-                          "neighborhood": {
-                            "type": "string",
-                            "description": "Neighborhood of the address."
-                          },
-                          "complement": {
-                            "type": "string",
-                            "description": "Complement to the address.",
-                            "nullable": true
-                          },
-                          "reference": {
-                            "type": "string",
-                            "description": "Reference that may help in the location of the address.",
-                            "nullable": true
-                          },
-                          "geoCoordinates": {
-                            "type": "array",
-                            "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
-                            "items": {
-                              "type": "number"
-                            }
-                          }
-                        }
-                      }
-                    },
-                    "userType": {
-                      "type": "string",
-                      "description": "User type.",
-                      "nullable": true
-                    },
-                    "ignoreProfileData": {
-                      "type": "boolean",
-                      "description": "Ignore customer profile data."
-                    },
-                    "value": {
-                      "type": "integer",
-                      "description": "Total value of the order without separating cents. For example, $24.99 is represented `2499`."
-                    },
-                    "messages": {
-                      "type": "array",
-                      "description": "Array containing an object for each message generated by our servers while processing the request."
-                    },
-                    "items": {
-                      "type": "array",
-                      "description": "Information on each item in the order.",
-                      "items": {
-                        "type": "object",
-                        "properties": {
-                          "uniqueId": {
-                            "type": "string",
-                            "description": "Unique ID."
-                          },
-                          "id": {
-                            "type": "string",
-                            "description": "ID of the item."
-                          },
-                          "productId": {
-                            "type": "string",
-                            "description": "Product ID."
-                          },
-                          "productRefId": {
-                            "type": "string",
-                            "description": "Product Ref ID."
-                          },
-                          "refId": {
-                            "type": "string",
-                            "description": "Ref ID."
-                          },
-                          "ean": {
-                            "type": "string",
-                            "description": "European Article Number.",
-                            "nullable": true
-                          },
-                          "name": {
-                            "type": "string",
-                            "description": "Product name."
-                          },
-                          "skuName": {
-                            "type": "string",
-                            "description": "SKU name."
-                          },
-                          "modalType": {
-                            "type": "string",
-                            "description": "Modal type.",
-                            "nullable": true
-                          },
-                          "parentItemIndex": {
-                            "type": "integer",
-                            "description": "Parent item index.",
-                            "nullable": true
-                          },
-                          "parentAssemblyBinding": {
-                            "type": "string",
-                            "description": "Parent assembly binding.",
-                            "nullable": true
-                          },
-                          "priceValidUntil": {
-                            "type": "string",
-                            "description": "Price expiration date and time."
-                          },
-                          "tax": {
-                            "type": "integer",
-                            "description": "Tax value in cents."
-                          },
-                          "taxCode": {
-                            "type": "string",
-                            "description": "A unique identifier code assigned to a tax within the VTEX Admin."
-                          },
-                          "price": {
-                            "type": "integer",
-                            "description": "Price in cents."
-                          },
-                          "listPrice": {
-                            "type": "integer",
-                            "description": "List price in cents."
-                          },
-                          "manualPrice": {
-                            "type": "integer",
-                            "description": "Manual price in cents.",
-                            "nullable": true
-                          },
-                          "manualPriceAppliedBy": {
-                            "type": "string",
-                            "description": "User that applied the manual price, if that is the case.",
-                            "nullable": true
-                          },
-                          "sellingPrice": {
-                            "type": "integer",
-                            "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
-                          },
-                          "rewardValue": {
-                            "type": "integer",
-                            "description": "Reward value in cents."
-                          },
-                          "isGift": {
-                            "type": "boolean",
-                            "description": "Indicates whether item is a gift."
-                          },
-                          "additionalInfo": {
-                            "type": "object",
-                            "description": "Additional information.",
-                            "properties": {
-                              "dimension": {
-                                "type": "string",
-                                "description": "Dimension.",
-                                "nullable": true
-                              },
-                              "brandName": {
-                                "type": "string",
-                                "description": "Brand name."
-                              },
-                              "brandId": {
-                                "type": "string",
-                                "description": "Brand ID."
-                              },
-                              "offeringInfo": {
-                                "type": "string",
-                                "description": "Offering information.",
-                                "nullable": true
-                              },
-                              "offeringType": {
-                                "type": "string",
-                                "description": "Offering type.",
-                                "nullable": true
-                              },
-                              "offeringTypeId": {
-                                "type": "string",
-                                "description": "Offering type ID.",
-                                "nullable": true
-                              }
-                            }
-                          },
-                          "preSaleDate": {
-                            "type": "string",
-                            "description": "Presale date.",
-                            "nullable": true
-                          },
-                          "productCategoryIds": {
-                            "type": "string",
-                            "description": "Product category IDs."
-                          },
-                          "productCategories": {
-                            "type": "object",
-                            "description": "Object, where each field is an ID from `productCategoryIds`.",
-                            "properties": {
-                              "{ID}": {
-                                "type": "string",
-                                "description": "Product category corresponding to the ID in the field key."
-                              }
-                            }
-                          },
-                          "quantity": {
-                            "type": "integer",
-                            "description": "Quantity."
-                          },
-                          "seller": {
-                            "type": "string",
-                            "description": "Seller."
-                          },
-                          "sellerChain": {
-                            "type": "array",
-                            "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
-                            "items": {
-                              "type": "string",
-                              "description": "Seller."
-                            }
-                          },
-                          "imageUrl": {
-                            "type": "string",
-                            "description": "Image URL."
-                          },
-                          "detailUrl": {
-                            "type": "string",
-                            "description": "Detail URL."
-                          },
-                          "bundleItems": {
-                            "type": "array",
-                            "description": "Information on services sold along with the SKU. Example: a gift package.",
-                            "items": {
-                              "type": "object",
-                              "properties": {
-                                "type": {
-                                  "type": "string",
-                                  "description": "Service type."
-                                },
-                                "id": {
-                                  "type": "integer",
-                                  "description": "Service identifier."
-                                },
-                                "name": {
-                                  "type": "string",
-                                  "description": "Service name."
-                                },
-                                "price": {
-                                  "type": "integer",
-                                  "description": "Service price in cents."
-                                }
-                              }
-                            }
-                          },
-                          "attachments": {
-                            "type": "array",
-                            "description": "Array containing information on attachments.",
-                            "items": {
-                              "type": "string"
-                            }
-                          },
-                          "priceTags": {
-                            "type": "array",
-                            "description": "Array of price tags, each of which, modifies the price in some way, like discounts or rates that apply to the item in the context of the order.",
-                            "items": {
-                              "type": "object",
-                              "properties": {
-                                "identifier": {
-                                  "type": "string",
-                                  "description": "Price tag identifier."
-                                },
-                                "isPercentual": {
-                                  "type": "boolean",
-                                  "description": "Indicates whether price tag value is applied through a percentage."
-                                },
-                                "name": {
-                                  "type": "string",
-                                  "description": "Price tag name."
-                                },
-                                "rawValue": {
-                                  "type": "integer",
-                                  "description": "Price tag raw value."
-                                },
-                                "value": {
-                                  "type": "integer",
-                                  "description": "Price tag value."
-                                }
-                              }
-                            }
-                          },
-                          "availability": {
-                            "type": "string",
-                            "description": "Availability."
-                          },
-                          "measurementUnit": {
-                            "type": "string",
-                            "description": "Measurement unit."
-                          },
-                          "unitMultiplier": {
-                            "type": "integer",
-                            "description": "Unit multiplier."
-                          },
-                          "manufacturerCode": {
-                            "type": "string",
-                            "description": "Manufacturer code.",
-                            "nullable": true
-                          },
-                          "priceDefinition": {
-                            "type": "object",
-                            "description": "Price information for all units of a specific item.",
-                            "properties": {
-                              "calculatedSellingPrice": {
-                                "type": "integer",
-                                "description": "Item's calculated unitary selling price in cents."
-                              },
-                              "total": {
-                                "type": "integer",
-                                "description": "Total value for all units of the item in cents."
-                              },
-                              "sellingPrices": {
-                                "type": "array",
-                                "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
-                                "items": {
-                                  "type": "object",
-                                  "properties": {
-                                    "value": {
-                                      "type": "integer",
-                                      "description": "Value in cents for that specific rounding."
-                                    },
-                                    "quantity": {
-                                      "type": "integer",
-                                      "description": "Rounding quantity, meaning how many items are rounded to this value."
-                                    }
-                                  }
-                                }
-                              }
-                            }
-                          }
-                        }
-                      }
-                    },
-                    "selectableGifts": {
-                      "type": "array",
-                      "description": "Array containing the data of the item selected as a gift."
-                    },
-                    "totalizers": {
-                      "type": "array",
-                      "description": "Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value)."
-                    },
-                    "shippingData": {
-                      "type": "object",
-                      "description": "Shipping information pertinent to the order.",
-                      "properties": {
-                        "address": {
-                          "type": "object",
-                          "description": "Address information.",
-                          "properties": {
-                            "addressType": {
-                              "type": "string",
-                              "description": "Type of address. For example, `Residential` or `Pickup`."
-                            },
-                            "receiverName": {
-                              "type": "string",
-                              "description": "Name of the person who is going to receive the order."
-                            },
-                            "addressId": {
-                              "type": "string",
-                              "description": "Address ID."
-                            },
-                            "isDisposable": {
-                              "type": "boolean",
-                              "description": "Indicates whether address is disposable."
-                            },
-                            "postalCode": {
-                              "type": "string",
-                              "description": "Postal code."
-                            },
-                            "city": {
-                              "type": "string",
-                              "description": "City of the shipping address."
-                            },
-                            "state": {
-                              "type": "string",
-                              "description": "State of the shipping address."
-                            },
-                            "country": {
-                              "type": "string",
-                              "description": "Three letter ISO code of the country of the shipping address."
-                            },
-                            "street": {
-                              "type": "string",
-                              "description": "Street of the shipping address."
-                            },
-                            "number": {
-                              "type": "string",
-                              "description": "Number of the building, house or apartment in the shipping address."
-                            },
-                            "neighborhood": {
-                              "type": "string",
-                              "description": "Neighborhood of the shipping address."
-                            },
-                            "complement": {
-                              "type": "string",
-                              "description": "Complement to the shipping address, in case it applies.",
-                              "nullable": true
-                            },
-                            "reference": {
-                              "type": "string",
-                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
-                              "nullable": true
-                            },
-                            "geoCoordinates": {
-                              "type": "array",
-                              "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
-                              "items": {
-                                "type": "number"
-                              }
-                            }
-                          }
-                        },
-                        "logisticsInfo": {
-                          "type": "array",
-                          "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "itemIndex": {
-                                "type": "integer",
-                                "description": "Index corresponding to the position of the object in the `items` array."
-                              },
-                              "selectedSla": {
-                                "type": "string",
-                                "description": "SLA selected by the customer."
-                              },
-                              "selectedDeliveryChannel": {
-                                "type": "string",
-                                "description": "Delivery channel selected by the customer."
-                              },
-                              "addressId": {
-                                "type": "string",
-                                "description": "Address ID."
-                              },
-                              "slas": {
-                                "type": "array",
-                                "description": "Information on available SLAs.",
-                                "items": {
-                                  "type": "object",
-                                  "properties": {
-                                    "id": {
-                                      "type": "string",
-                                      "description": "SLA ID."
-                                    },
-                                    "deliveryChannel": {
-                                      "type": "string",
-                                      "description": "Delivery channel."
-                                    },
-                                    "name": {
-                                      "type": "string",
-                                      "description": "SLA name."
-                                    },
-                                    "deliveryIds": {
-                                      "type": "array",
-                                      "description": "Information on each delivery ID.",
-                                      "items": {
-                                        "type": "object",
-                                        "properties": {
-                                          "courierId": {
-                                            "type": "string",
-                                            "description": "Courier ID."
-                                          },
-                                          "warehouseId": {
-                                            "type": "string",
-                                            "description": "Warehouse ID."
-                                          },
-                                          "dockId": {
-                                            "type": "string",
-                                            "description": "Warehouse ID."
-                                          },
-                                          "courierName": {
-                                            "type": "string",
-                                            "description": "Courier name."
-                                          },
-                                          "quantity": {
-                                            "type": "integer",
-                                            "description": "Quantity."
-                                          }
-                                        }
-                                      }
-                                    },
-                                    "shippingEstimate": {
-                                      "type": "string",
-                                      "description": "Shipping estimate. For instance, Three business days will be represented `3bd`."
-                                    },
-                                    "shippingEstimateDate": {
-                                      "type": "string",
-                                      "description": "Shipping estimate date.",
-                                      "nullable": true
-                                    },
-                                    "lockTTL": {
-                                      "type": "string",
-                                      "description": "Estimate date of delivery."
-                                    },
-                                    "price": {
-                                      "type": "integer",
-                                      "description": "Price in cents."
-                                    },
-                                    "listPrice": {
-                                      "type": "integer",
-                                      "description": "List price in cents."
-                                    },
-                                    "tax": {
-                                      "type": "integer",
-                                      "description": "Tax in cents."
-                                    },
-                                    "pickupStoreInfo": {
-                                      "type": "object",
-                                      "description": "Information on the pickup store.",
-                                      "properties": {
-                                        "isPickupStore": {
-                                          "type": "boolean",
-                                          "description": "Indicates whether it is the pickup store."
-                                        },
-                                        "friendlyName": {
-                                          "type": "string",
-                                          "description": "Friendly name.",
-                                          "nullable": true
-                                        },
-                                        "address": {
-                                          "type": "object",
-                                          "description": "Address information.",
-                                          "nullable": true,
-                                          "properties": {
-                                            "addressType": {
-                                              "type": "string",
-                                              "description": "Type of address. For example, `Residential` or `Pickup`."
-                                            },
-                                            "postalCode": {
-                                              "type": "string",
-                                              "description": "Postal code."
-                                            },
-                                            "city": {
-                                              "type": "string",
-                                              "description": "City of the shipping address."
-                                            },
-                                            "state": {
-                                              "type": "string",
-                                              "description": "State of the shipping address."
-                                            },
-                                            "country": {
-                                              "type": "string",
-                                              "description": "Three letter ISO code of the country of the shipping address."
-                                            },
-                                            "street": {
-                                              "type": "string",
-                                              "description": "Street of the shipping address."
-                                            },
-                                            "number": {
-                                              "type": "string",
-                                              "description": "Number of the building, house or apartment in the shipping address."
-                                            },
-                                            "neighborhood": {
-                                              "type": "string",
-                                              "description": "Neighborhood of the shipping address."
-                                            },
-                                            "complement": {
-                                              "type": "string",
-                                              "description": "Complement to the shipping address, in case it applies.",
-                                              "nullable": true
-                                            },
-                                            "reference": {
-                                              "type": "string",
-                                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
-                                              "nullable": true
-                                            },
-                                            "geoCoordinates": {
-                                              "type": "array",
-                                              "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
-                                              "items": {
-                                                "type": "number"
-                                              }
-                                            }
-                                          }
-                                        },
-                                        "additionalInfo": {
-                                          "type": "string",
-                                          "description": "Additional information.",
-                                          "nullable": true
-                                        },
-                                        "dockId": {
-                                          "type": "string",
-                                          "description": "Corresponding dock ID.",
-                                          "nullable": true
-                                        }
-                                      }
-                                    },
-                                    "pickupPointId": {
-                                      "type": "string",
-                                      "description": "Pickup point ID.",
-                                      "nullable": true
-                                    },
-                                    "pickupDistance": {
-                                      "type": "integer",
-                                      "description": "Pickup point distance."
-                                    },
-                                    "polygonName": {
-                                      "type": "string",
-                                      "description": "Polygon name.",
-                                      "nullable": true
-                                    },
-                                    "transitTime": {
-                                      "type": "string",
-                                      "description": "Transit time. For instance, \"three business days\" is represented `3bd`."
-                                    }
-                                  }
-                                }
-                              },
-                              "shipsTo": {
-                                "type": "array",
-                                "description": "List of countries that the item may be shipped to.",
-                                "items": {
-                                  "type": "string",
-                                  "description": "Three letter country code."
-                                }
-                              },
-                              "itemId": {
-                                "type": "string",
-                                "description": "Item ID."
-                              },
-                              "deliveryChannels": {
-                                "type": "array",
-                                "description": "List of available delivery channels.",
-                                "items": {
-                                  "type": "object",
-                                  "properties": {
-                                    "id": {
-                                      "type": "string",
-                                      "description": "Delivery channel ID."
-                                    }
-                                  }
-                                }
-                              }
-                            }
-                          }
-                        },
-                        "selectedAddresses": {
-                          "type": "array",
-                          "description": "Array with information on the selected addresses for the order.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "addressType": {
-                                "type": "string",
-                                "description": "Type of address. For example, `Residential` or `Pickup`."
-                              },
-                              "receiverName": {
-                                "type": "string",
-                                "description": "Name of the person who is going to receive the order."
-                              },
-                              "addressId": {
-                                "type": "string",
-                                "description": "Address ID."
-                              },
-                              "isDisposable": {
-                                "type": "boolean",
-                                "description": "Indicates whether address is disposable."
-                              },
-                              "postalCode": {
-                                "type": "string",
-                                "description": "Postal code."
-                              },
-                              "city": {
-                                "type": "string",
-                                "description": "City of the shipping address."
-                              },
-                              "state": {
-                                "type": "string",
-                                "description": "State of the shipping address."
-                              },
-                              "country": {
-                                "type": "string",
-                                "description": "Three letter ISO code of the country of the shipping address."
-                              },
-                              "street": {
-                                "type": "string",
-                                "description": "Street of the shipping address."
-                              },
-                              "number": {
-                                "type": "string",
-                                "description": "Number of the building, house or apartment in the shipping address."
-                              },
-                              "neighborhood": {
-                                "type": "string",
-                                "description": "Neighborhood of the shipping address."
-                              },
-                              "complement": {
-                                "type": "string",
-                                "description": "Complement to the shipping address, in case it applies."
-                              },
-                              "reference": {
-                                "type": "string",
-                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
-                                "nullable": true
-                              },
-                              "geoCoordinates": {
-                                "type": "array",
-                                "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
-                                "items": {
-                                  "type": "number"
-                                }
-                              }
-                            }
-                          }
-                        },
-                        "availableAddresses": {
-                          "type": "array",
-                          "description": "Array with information on the available addresses for the order.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "addressType": {
-                                "type": "string",
-                                "description": "Type of address. For example, `Residential` or `Pickup`."
-                              },
-                              "receiverName": {
-                                "type": "string",
-                                "description": "Name of the person who is going to receive the order."
-                              },
-                              "addressId": {
-                                "type": "string",
-                                "description": "Address ID."
-                              },
-                              "isDisposable": {
-                                "type": "boolean",
-                                "description": "Indicates whether address is disposable."
-                              },
-                              "postalCode": {
-                                "type": "string",
-                                "description": "Postal code."
-                              },
-                              "city": {
-                                "type": "string",
-                                "description": "City of the shipping address."
-                              },
-                              "state": {
-                                "type": "string",
-                                "description": "State of the shipping address."
-                              },
-                              "country": {
-                                "type": "string",
-                                "description": "Three letter ISO code of the country of the shipping address."
-                              },
-                              "street": {
-                                "type": "string",
-                                "description": "Street of the shipping address."
-                              },
-                              "number": {
-                                "type": "string",
-                                "description": "Number of the building, house or apartment in the shipping address."
-                              },
-                              "neighborhood": {
-                                "type": "string",
-                                "description": "Neighborhood of the shipping address."
-                              },
-                              "complement": {
-                                "type": "string",
-                                "description": "Complement to the shipping address, in case it applies."
-                              },
-                              "reference": {
-                                "type": "string",
-                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
-                                "nullable": true
-                              },
-                              "geoCoordinates": {
-                                "type": "array",
-                                "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
-                                "items": {
-                                  "type": "number"
-                                }
-                              }
-                            }
-                          }
-                        }
-                      }
-                    },
-                    "clientProfileData": {
-                      "type": "object",
-                      "description": "Customer's profile information.",
-                      "properties": {
-                        "email": {
-                          "type": "string",
-                          "description": "Email address."
-                        },
-                        "firstName": {
-                          "type": "string",
-                          "description": "First name."
-                        },
-                        "lastName": {
-                          "type": "string",
-                          "description": "Last name."
-                        },
-                        "documentType": {
-                          "type": "string",
-                          "description": "Type of the document informed by the customer."
-                        },
-                        "document": {
-                          "type": "string",
-                          "description": "Document informed by the customer."
-                        },
-                        "phone": {
-                          "type": "string",
-                          "description": "Phone number."
-                        },
-                        "corporateName": {
-                          "type": "string",
-                          "description": "Company name, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "tradeName": {
-                          "type": "string",
-                          "description": "Trade name, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "corporateDocument": {
-                          "type": "string",
-                          "description": "Corporate document, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "stateInscription": {
-                          "type": "string",
-                          "description": "State inscription, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "corporatePhone": {
-                          "type": "string",
-                          "description": "Corporate phone number, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "isCorporate": {
-                          "type": "boolean",
-                          "description": "Indicates whether the customer is a legal entity."
-                        },
-                        "profileCompleteOnLoading": {
-                          "type": "boolean",
-                          "description": "Indicates whether profile is complete on loading."
-                        },
-                        "profileErrorOnLoading": {
-                          "type": "boolean",
-                          "description": "Indicates whether profile presents error on loading.",
-                          "nullable": true
-                        },
-                        "customerClass": {
-                          "type": "string",
-                          "description": "Customer class.",
-                          "nullable": true
-                        }
-                      }
-                    },
-                    "paymentData": {
-                      "type": "object",
-                      "description": "Information on the order's payment.",
-                      "properties": {
-                        "giftCards": {
-                          "type": "array",
-                          "description": "Gift card information, if it applies to the order.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "redemptionCode": {
-                                "type": "string",
-                                "description": "Gift card redemption code."
-                              },
-                              "value": {
-                                "type": "integer",
-                                "description": "Gift card value in cents."
-                              },
-                              "balance": {
-                                "type": "integer",
-                                "description": "Gift card balance in cents."
-                              },
-                              "name": {
-                                "type": "string",
-                                "description": "Gift card name."
-                              },
-                              "id": {
-                                "type": "string",
-                                "description": "Gift card ID."
-                              },
-                              "inUse": {
-                                "type": "boolean",
-                                "description": "Indicates whether gift card is in use."
-                              },
-                              "isSpecialCard": {
-                                "type": "boolean",
-                                "description": "Indicates whether gift card is special."
-                              }
-                            }
-                          }
-                        },
-                        "transactions": {
-                          "type": "array",
-                          "description": "Information on each transaction pertinent to the order.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "isActive": {
-                                "type": "boolean",
-                                "description": "Indicates whether transaction is active."
-                              },
-                              "transactionId": {
-                                "type": "string",
-                                "description": "Transaction ID."
-                              },
-                              "merchantName": {
-                                "type": "string",
-                                "description": "Merchant name."
-                              },
-                              "payments": {
-                                "type": "array",
-                                "description": "Information on each payment.",
-                                "items": {
-                                  "type": "object",
-                                  "properties": {
-                                    "accountId": {
-                                      "type": "string",
-                                      "description": "Account ID."
-                                    },
-                                    "bin": {
-                                      "type": "string",
-                                      "description": "Bin."
-                                    },
-                                    "installments": {
-                                      "type": "integer",
-                                      "description": "Number of installments."
-                                    },
-                                    "paymentSystem": {
-                                      "type": "string",
-                                      "description": "Payment system."
-                                    },
-                                    "referenceValue": {
-                                      "type": "integer",
-                                      "description": "Reference value for calculating interest rates, in case it applies. Displayed in cents."
-                                    },
-                                    "value": {
-                                      "type": "integer",
-                                      "description": "Value including interest, in case it applies. Displayed in cents."
-                                    }
-                                  }
-                                }
-                              },
-                              "sharedTransaction": {
-                                "type": "boolean",
-                                "description": "Indicates whather transaction is shared."
-                              }
-                            }
-                          }
-                        }
-                      }
-                    },
-                    "marketingData": {
-                      "type": "object",
-                      "description": "Object containing promotion data such as coupon tracking information and internal or external UTMs.",
-                      "properties": {
-                        "coupon": {
-                          "type": "string",
-                          "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.",
-                          "default": "free-shipping"
-                        },
-                        "utmSource": {
-                          "type": "string",
-                          "description": "UTM source.",
-                          "default": "Facebook"
-                        },
-                        "utmMedium": {
-                          "type": "string",
-                          "description": "UTM medium.",
-                          "default": "CPC"
-                        },
-                        "utmCampaign": {
-                          "type": "string",
-                          "description": "UTM campaign",
-                          "default": "Black friday"
-                        },
-                        "utmiPage": {
-                          "type": "string",
-                          "description": "utmi_page (internal utm).",
-                          "default": "utmi_page-example",
-                          "nullable": true
-                        },
-                        "utmiPart": {
-                          "type": "string",
-                          "description": "utmi_part (internal utm).",
-                          "default": "utmi_part-example",
-                          "nullable": true
-                        },
-                        "utmiCampaign": {
-                          "type": "string",
-                          "description": "utmi_campaign (internal utm).",
-                          "default": "utmi_campaign-example",
-                          "nullable": true
-                        }
-                      }
-                    },
-                    "sellers": {
-                      "type": "array",
-                      "description": "Information on each seller.",
-                      "items": {
-                        "type": "object",
-                        "properties": {
-                          "id": {
-                            "type": "string",
-                            "description": "Seller ID."
-                          },
-                          "name": {
-                            "type": "string",
-                            "description": "Seller name."
-                          },
-                          "logo": {
-                            "type": "string",
-                            "description": "Seller logo.",
-                            "nullable": true
-                          }
-                        }
-                      }
-                    },
-                    "clientPreferencesData": {
-                      "type": "object",
-                      "description": "Object containing preferences from the client who placed the order.",
-                      "properties": {
-                        "locale": {
-                          "type": "string",
-                          "description": "Client's locale. Examples: `pt-BR` and `en-US`."
-                        },
-                        "optinNewsLetter": {
-                          "type": "boolean",
-                          "description": "`true` if the client opted to receive newsletter from the store.",
-                          "default": false
-                        }
-                      }
-                    },
-                    "commercialConditionData": {
-                      "type": "object",
-                      "description": "Object containing commercial condition information.",
-                      "nullable": true
-                    },
-                    "storePreferencesData": {
-                      "type": "object",
-                      "description": "Object containing data from the store's configuration (stored in VTEX's License Manager)."
-                    },
-                    "giftRegistryData": {
-                      "type": "object",
-                      "description": "Gift registry list information.",
-                      "nullable": true
-                    },
-                    "openTextField": {
-                      "type": "string",
-                      "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).",
-                      "default": "open-text-example",
-                      "nullable": true
-                    },
-                    "invoiceData": {
-                      "type": "object",
-                      "description": "Object containing information pertinent to the order's invoice.",
-                      "nullable": true
-                    },
-                    "customData": {
-                      "type": "object",
-                      "description": "Customer additional information.",
-                      "nullable": true
-                    },
-                    "itemMetadata": {
-                      "type": "object",
-                      "description": "Item metadata.",
-                      "properties": {
-                        "items": {
-                          "type": "array",
-                          "description": "List of objects containing metadata on each item in the order.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "id": {
-                                "type": "string",
-                                "description": "Item ID."
-                              },
-                              "seller": {
-                                "type": "string",
-                                "description": "Seller."
-                              },
-                              "name": {
-                                "type": "string",
-                                "description": "Product name."
-                              },
-                              "skuName": {
-                                "type": "string",
-                                "description": "SKU name."
-                              },
-                              "productId": {
-                                "type": "string",
-                                "description": "Product ID."
-                              },
-                              "refId": {
-                                "type": "string",
-                                "description": "Ref ID."
-                              },
-                              "ean": {
-                                "type": "string",
-                                "description": "European Article Number.",
-                                "nullable": true
-                              },
-                              "imageUrl": {
-                                "type": "string",
-                                "description": "Image URL."
-                              },
-                              "detailUrl": {
-                                "type": "string",
-                                "description": "Detail URL."
-                              }
-                            }
-                          }
-                        }
-                      }
-                    },
-                    "hooksData": {
-                      "type": "object",
-                      "description": "Hooks information.",
-                      "nullable": true
-                    },
-                    "ratesAndBenefitsData": {
-                      "type": "object",
-                      "description": "Information on rates and benefits that apply to the order.",
-                      "properties": {
-                        "rateAndBenefitsIdentifiers": {
-                          "type": "array",
-                          "description": "List with rates and benefits identifiers.",
-                          "items": {
-                            "type": "string"
-                          }
-                        },
-                        "teaser": {
-                          "type": "array",
-                          "description": "List with rates and benefits teasers.",
-                          "items": {
-                            "type": "string"
-                          }
-                        }
-                      }
-                    },
-                    "subscriptionData": {
-                      "type": "object",
-                      "description": "Subscription information.",
-                      "nullable": true
-                    },
-                    "itemsOrdination": {
-                      "type": "object",
-                      "description": "Object containing information about the ordering of items within the orderForm.",
-                      "properties": {
-                        "criteria": {
-                          "type": "string",
-                          "description": "Criteria adopted to order the items in the list."
-                        },
-                        "ascending": {
-                          "type": "boolean",
-                          "description": "Indicates whether the ordering is ascending."
-                        }
-                      }
-                    }
-                  }
-                },
-                "example": {
-                  "orderFormId": "ede846222cd44046ba6c638442c3505a",
-                  "salesChannel": "1",
-                  "loggedIn": false,
-                  "isCheckedIn": false,
-                  "storeId": null,
-                  "allowManualPrice": false,
-                  "canEditData": true,
-                  "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
-                  "profileProvider": "VTEX",
-                  "availableAccounts": [],
-                  "availableAddresses": [
-                    {
-                      "addressType": "residential",
-                      "receiverName": "Clark Kent",
-                      "addressId": "666c2e830bd9474ab6f6cc53fb6dd2d2",
-                      "isDisposable": true,
-                      "postalCode": "70386000",
-                      "city": "Brasília",
-                      "state": "DF",
-                      "country": "BRA",
-                      "street": "Rua da minha casa",
-                      "number": "123",
-                      "neighborhood": "Copacabana",
-                      "complement": "15º andar",
-                      "reference": null,
-                      "geoCoordinates": [
-                        -47.924747467041016,
-                        -15.832582473754883
-                      ]
-                    }
-                  ],
-                  "userType": null,
-                  "ignoreProfileData": false,
-                  "value": 34390,
-                  "messages": [],
-                  "items": [
-                    {
-                      "uniqueId": "9D6E447B3FF64CEDA33B17C01379C119",
-                      "id": "2",
-                      "productId": "2005",
-                      "productRefId": "",
-                      "refId": "CBC30L",
-                      "ean": null,
-                      "name": "Chopp Brahma Claro 30L",
-                      "skuName": "Chopp Brahma Claro 30L",
-                      "modalType": null,
-                      "parentItemIndex": null,
-                      "parentAssemblyBinding": null,
-                      "assemblies": [],
-                      "priceValidUntil": "2022-07-13T18:30:46Z",
-                      "tax": 0,
-                      "taxCode": "54WC8ZN6K8",
-                      "price": 32890,
-                      "listPrice": 49900,
-                      "manualPrice": null,
-                      "manualPriceAppliedBy": null,
-                      "sellingPrice": 32890,
-                      "rewardValue": 0,
-                      "isGift": false,
-                      "additionalInfo": {
-                        "dimension": null,
-                        "brandName": "Brahma",
-                        "brandId": "2000000",
-                        "offeringInfo": null,
-                        "offeringType": null,
-                        "offeringTypeId": null
-                      },
-                      "preSaleDate": null,
-                      "productCategoryIds": "/1/",
-                      "productCategories": {
-                        "1": "Bebidas"
-                      },
-                      "quantity": 3,
-                      "seller": "1",
-                      "sellerChain": [
-                        "1"
-                      ],
-                      "imageUrl": "http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000",
-                      "detailUrl": "/chopp-brahma-claro-30l/p",
-                      "components": [],
-                      "bundleItems": [],
-                      "attachments": [],
-                      "attachmentOfferings": [],
-                      "offerings": [],
-                      "priceTags": [],
-                      "availability": "available",
-                      "measurementUnit": "un",
-                      "unitMultiplier": 1,
-                      "manufacturerCode": null,
-                      "priceDefinition": {
-                        "calculatedSellingPrice": 32890,
-                        "total": 32890,
-                        "sellingPrices": [
-                          {
-                            "value": 32890,
-                            "quantity": 1
-                          }
-                        ]
-                      }
-                    }
-                  ],
-                  "selectableGifts": [],
-                  "totalizers": [
-                    {
-                      "id": "Items",
-                      "name": "Total dos Itens",
-                      "value": 15000
-                    }
-                  ],
-                  "shippingData": {
-                    "address": {
-                      "addressType": "residential",
-                      "receiverName": "Clark Kent",
-                      "addressId": "teste",
-                      "isDisposable": true,
-                      "postalCode": "70386000",
-                      "city": "Brasília",
-                      "state": "DF",
-                      "country": "BRA",
-                      "street": "Rua da minha casa",
-                      "number": "123",
-                      "neighborhood": "Copacabana",
-                      "complement": "15º andar",
-                      "reference": null,
-                      "geoCoordinates": [
-                        -47.924747467041016,
-                        -15.832582473754883
-                      ]
-                    },
-                    "logisticsInfo": [
-                      {
-                        "itemIndex": 0,
-                        "selectedSla": "Normal",
-                        "selectedDeliveryChannel": "delivery",
-                        "addressId": "teste",
-                        "slas": [
-                          {
-                            "id": "Normal",
-                            "deliveryChannel": "delivery",
-                            "name": "Normal",
-                            "deliveryIds": [
-                              {
-                                "courierId": "1",
-                                "warehouseId": "1_1",
-                                "dockId": "1",
-                                "courierName": "Transportadora",
-                                "quantity": 1,
-                                "kitItemDetails": []
-                              }
-                            ],
-                            "shippingEstimate": "3bd",
-                            "shippingEstimateDate": null,
-                            "lockTTL": "10d",
-                            "availableDeliveryWindows": [],
-                            "deliveryWindow": null,
-                            "price": 1500,
-                            "listPrice": 1500,
-                            "tax": 0,
-                            "pickupStoreInfo": {
-                              "isPickupStore": false,
-                              "friendlyName": null,
-                              "address": null,
-                              "additionalInfo": null,
-                              "dockId": null
-                            },
-                            "pickupPointId": null,
-                            "pickupDistance": 0,
-                            "polygonName": null,
-                            "transitTime": "3bd"
-                          }
-                        ],
-                        "shipsTo": [
-                          "BRA",
-                          "COL",
-                          "USA"
-                        ],
-                        "itemId": "2",
-                        "deliveryChannels": [
-                          {
-                            "id": "delivery"
-                          },
-                          {
-                            "id": "pickup-in-point"
-                          }
-                        ]
-                      }
-                    ],
-                    "selectedAddresses": [
-                      {
-                        "addressType": "residential",
-                        "receiverName": "Clark Kent",
-                        "addressId": "teste",
-                        "isDisposable": true,
-                        "postalCode": "12345000",
-                        "city": "Rio de Janeiro",
-                        "state": "RJ",
-                        "country": "BRA",
-                        "street": "Rua da minha casa",
-                        "number": "123",
-                        "neighborhood": "Copacabana",
-                        "complement": "15º andar",
-                        "reference": null,
-                        "geoCoordinates": [
-                          -47.924747467041016,
-                          -15.832582473754883
-                        ]
-                      }
-                    ],
-                    "availableAddresses": [
-                      {
-                        "addressType": "residential",
-                        "receiverName": "Clark Kent",
-                        "addressId": "teste",
-                        "isDisposable": true,
-                        "postalCode": "12345000",
-                        "city": "Rio de Janeiro",
-                        "state": "RJ",
-                        "country": "BRA",
-                        "street": "Rua da minha casa",
-                        "number": "123",
-                        "neighborhood": "Copacabana",
-                        "complement": "15º andar",
-                        "reference": null,
-                        "geoCoordinates": [
-                          -47.924747467041016,
-                          -15.832582473754883
-                        ]
-                      }
-                    ],
-                    "pickupPoints": []
-                  },
-                  "clientProfileData": {
-                    "email": "clark.kent@example.com",
-                    "firstName": "Clark",
-                    "lastName": "Kent",
-                    "document": "12345678900",
-                    "documentType": "cpf",
-                    "phone": "+5521998765432",
-                    "corporateName": null,
-                    "tradeName": null,
-                    "corporateDocument": null,
-                    "stateInscription": null,
-                    "corporatePhone": null,
-                    "isCorporate": false,
-                    "profileCompleteOnLoading": false,
-                    "profileErrorOnLoading": null,
-                    "customerClass": null
-                  },
-                  "paymentData": {
-                    "installmentOptions": [
-                      {
-                        "paymentSystem": "2",
-                        "bin": null,
-                        "paymentName": null,
-                        "paymentGroupName": null,
-                        "value": 15000,
-                        "installments": [
-                          {
-                            "count": 1,
-                            "hasInterestRate": false,
-                            "interestRate": 0,
-                            "value": 15000,
-                            "total": 15000,
-                            "sellerMerchantInstallments": [
-                              {
-                                "id": "LOJADOBRENO",
-                                "count": 1,
-                                "hasInterestRate": false,
-                                "interestRate": 0,
-                                "value": 15000,
-                                "total": 15000
-                              }
-                            ]
-                          },
-                          {
-                            "count": 2,
-                            "hasInterestRate": false,
-                            "interestRate": 0,
-                            "value": 7500,
-                            "total": 15000,
-                            "sellerMerchantInstallments": [
-                              {
-                                "id": "LOJADOBRENO",
-                                "count": 2,
-                                "hasInterestRate": false,
-                                "interestRate": 0,
-                                "value": 7500,
-                                "total": 15000
-                              }
-                            ]
-                          }
-                        ]
-                      }
-                    ],
-                    "paymentSystems": [
-                      {
-                        "id": 2,
-                        "name": "Visa",
-                        "groupName": "creditCardPaymentGroup",
-                        "validator": {
-                          "regex": "^2[1-8]{17}$",
-                          "mask": "9999 9999 9999 9999",
-                          "cardCodeRegex": "^[0-3]{8}$",
-                          "cardCodeMask": "999",
-                          "weights": [
-                            2,
-                            1,
-                            2,
-                            1,
-                            2,
-                            1
-                          ],
-                          "useCvv": true,
-                          "useExpirationDate": true,
-                          "useCardHolderName": true,
-                          "useBillingAddress": true
-                        },
-                        "stringId": "2",
-                        "template": "creditCardPaymentGroup-template",
-                        "requiresDocument": false,
-                        "isCustom": false,
-                        "description": null,
-                        "requiresAuthentication": false,
-                        "dueDate": "2020-03-05T14:59:00.7879306Z",
-                        "availablePayments": null
-                      }
-                    ],
-                    "payments": [],
-                    "giftCards": [],
-                    "giftCardMessages": [],
-                    "availableAccounts": [],
-                    "availableTokens": []
-                  },
-                  "marketingData": {
-                    "coupon": "free-shipping",
-                    "utmSource": "app",
-                    "utmMedium": "CPC",
-                    "utmCampaign": "Black friday",
-                    "utmipage": null,
-                    "utmiPart": null,
-                    "utmiCampaign": null
-                  },
-                  "sellers": [
-                    {
-                      "id": "1",
-                      "name": "lojadobreno",
-                      "logo": ""
-                    }
-                  ],
-                  "clientPreferencesData": {
-                    "locale": "pt-BR",
-                    "optinNewsLetter": false
-                  },
-                  "commercialConditionData": null,
-                  "storePreferencesData": {
-                    "countryCode": "BRA",
-                    "saveUserData": true,
-                    "timeZone": "E. South America Standard Time",
-                    "currencyCode": "BRL",
-                    "currencyLocale": 1046,
-                    "currencySymboupdate cartl": "R$",
-                    "currencyFormatInfo": {
-                      "currencyDecimalDigits": 2,
-                      "currencyDecimalSeparator": ",",
-                      "currencyGroupSeparator": ".",
-                      "currencyGroupSize": 3,
-                      "startsWithCurrencySymbol": true
-                    }
-                  },
-                  "giftRegistryData": null,
-                  "openTextField": null,
-                  "invoiceData": null,
-                  "customData": null,
-                  "itemMetadata": {
-                    "items": [
-                      {
-                        "id": "1",
-                        "seller": "1",
-                        "name": "Ração Royal Canin Feline Urinary 500g",
-                        "skuName": "Ração Royal Canin Feline Urinary 500g",
-                        "productId": "1",
-                        "refId": "0001",
-                        "ean": "123456789",
-                        "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
-                        "detailUrl": "/racao-royal-canin-feline-urinary/p",
-                        "assemblyOptions": []
-                      }
-                    ]
-                  },
-                  "hooksData": null,
-                  "ratesAndBenefitsData": {
-                    "rateAndBenefitsIdentifiers": [],
-                    "teaser": []
-                  },
-                  "subscriptionData": null,
-                  "itemsOrdination": {
-                    "criteria": "NAME",
-                    "ascending": true
-                  }
-                }
-              }
-            }
-          }
-        },
-        "deprecated": false
-      },
-      "patch": {
-        "tags": [
-          "Shopping cart"
-        ],
-        "summary": "Handle cart items",
-        "description": "You can use this request to:\n\r\n\r1. Change the quantity or price of one or more items to the shopping cart.\n\r2. Add a new item to the shopping cart.\r\n\r\n**Important**: To add a new item to the shopping cart, do not send the string `index` in the request body.\r\n\r\nThe [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.\n\r\n\r> This request has a time out of 45 seconds.",
-        "operationId": "ItemsHandle",
-        "security": [],
-        "parameters": [
-          {
-            "name": "Content-Type",
-            "in": "header",
-            "description": "Type of the content being sent.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "Accept",
-            "in": "header",
-            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "orderFormId",
-            "in": "path",
-            "description": "ID of the orderForm corresponding to the cart in which items will be handled.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "ede846222cd44046ba6c638442c3505a"
-            }
-          }
-        ],
-        "requestBody": {
-          "description": "",
-          "content": {
-            "application/json": {
-              "schema": {
-                "type": "object",
-                "properties": {
-                  "orderItems": {
-                    "type": "array",
-                    "description": "Array containing the cart items. Each object inside this array corresponds to a different item.",
-                    "items": {
-                      "required": [
-                        "id",
-                        "quantity",
-                        "seller"
-                      ],
-                      "type": "object",
-                      "properties": {
-                        "id": {
-                          "type": "string",
-                          "description": "The ID of the SKU in VTEX platform.",
-                          "example": "2005"
-                        },
-                        "quantity": {
-                          "type": "integer",
-                          "format": "int32",
-                          "description": "The quantity of the item (SKU) in the cart.",
-                          "example": 3
-                        },
-                        "seller": {
-                          "type": "string",
-                          "description": "The seller responsible for the SKU.",
-                          "example": "1"
-                        },
-                        "index": {
-                          "type": "integer",
-                          "description": "The position of the item in the array. This string should be sent only to modify price or quantity of an item. NOTE: This string should not be sent when you are adding a new item to the cart.",
-                          "example": 0
-                        },
-                        "price": {
-                          "type": "integer",
-                          "description": "Price of the item in cents. Send this value in case you want to make a bulk price change.",
-                          "example": 1099
-                        },
-                        "attachments": {
-                          "type": "array",
-                          "description": "Array containing information on attachments.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "name": {
-                                "type": "string",
-                                "description": "Attachment identification.",
-                                "example": "Packages"
-                              },
-                              "content": {
-                                "type": "object",
-                                "description": "Attachment content data. E.g. `\"Do you want to receive packages?\": \"Yes\"`.",
-                                "nullable": true
-                              }
-                            }
-                          }
-                        },
-                        "noSplitItem": {
-                          "type": "boolean",
-                          "description": "Indicates whether the item can be splitted.",
-                          "default": false
-                        },
-                        "allowedOutdatedData": {
-                          "type": "array",
-                          "description": "In order to optimize performance, this parameter allows some information to not be updated when there are changes in the minicart. For instance, if a shopper adds another unit of a given SKU to the cart, it may not be necessary to recalculate payment information, which could impact performance. This array accepts strings and currently the only possible value is `\"paymentData\"`.",
-                          "items": {
-                            "type": "string",
-                            "default": "paymentData"
-                          }
-                        }
-                      }
-                    }
-                  }
-                }
-              }
-            }
-          },
-          "required": true
-        },
-        "responses": {
-          "200": {
-            "description": "OK",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "object",
-                  "properties": {
-                    "orderFormId": {
-                      "type": "string",
-                      "description": "ID of the orderForm corresponding to a specific cart."
-                    },
-                    "salesChannel": {
-                      "type": "string",
-                      "description": "Attribute created by the seller, in their VTEX store configuration."
-                    },
-                    "loggedIn": {
-                      "type": "boolean",
-                      "description": "Indicates whether the user is logged into the store."
-                    },
-                    "isCheckedIn": {
-                      "type": "boolean",
-                      "description": "Indicates whether order is checked in."
-                    },
-                    "storeId": {
-                      "type": "string",
-                      "description": "ID of the store.",
-                      "nullable": true
-                    },
-                    "allowManualPrice": {
-                      "type": "boolean",
-                      "description": "Permission to modify item price manually."
-                    },
-                    "canEditData": {
-                      "type": "boolean",
-                      "description": "Data can be edited."
-                    },
-                    "userProfileId": {
-                      "type": "string",
-                      "description": "Unique ID associated with the customer profile."
-                    },
-                    "profileProvider": {
-                      "type": "string",
-                      "description": "Profile provider."
-                    },
-                    "availableAccounts": {
-                      "type": "array",
-                      "description": "Available accounts.",
-                      "items": {
-                        "type": "string"
-                      }
-                    },
-                    "availableAddresses": {
-                      "type": "array",
-                      "description": "Information on each available address.",
-                      "items": {
-                        "type": "object",
-                        "properties": {
-                          "addressType": {
-                            "type": "string",
-                            "description": "Address type."
-                          },
-                          "receiverName": {
-                            "type": "string",
-                            "description": "Name of the receiver."
-                          },
-                          "addressId": {
-                            "type": "string",
-                            "description": "Address ID."
-                          },
-                          "isDisposable": {
-                            "type": "boolean",
-                            "description": "Indicates whether address is disposable."
-                          },
-                          "city": {
-                            "type": "string",
-                            "description": "City of the address."
-                          },
-                          "state": {
-                            "type": "string",
-                            "description": "State of the address."
-                          },
-                          "country": {
-                            "type": "string",
-                            "description": "Country of the address. ISO three-letter code."
-                          },
-                          "street": {
-                            "type": "string",
-                            "description": "Street of the address."
-                          },
-                          "number": {
-                            "type": "string",
-                            "description": "Number of the address."
-                          },
-                          "neighborhood": {
-                            "type": "string",
-                            "description": "Neighborhood of the address."
-                          },
-                          "complement": {
-                            "type": "string",
-                            "description": "Complement to the address.",
-                            "nullable": true
-                          },
-                          "reference": {
-                            "type": "string",
-                            "description": "Reference that may help in the location of the address.",
-                            "nullable": true
-                          },
-                          "geoCoordinates": {
-                            "type": "array",
-                            "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
-                            "items": {
-                              "type": "number"
-                            }
-                          }
-                        }
-                      }
-                    },
-                    "userType": {
-                      "type": "string",
-                      "description": "User type.",
-                      "nullable": true
-                    },
-                    "ignoreProfileData": {
-                      "type": "boolean",
-                      "description": "Ignore customer profile data."
-                    },
-                    "value": {
-                      "type": "integer",
-                      "description": "Total value of the order without separating cents. For example, $24.99 is represented `2499`."
-                    },
-                    "messages": {
-                      "type": "array",
-                      "description": "Array containing an object for each message generated by our servers while processing the request."
-                    },
-                    "items": {
-                      "type": "array",
-                      "description": "Information on each item in the order.",
-                      "items": {
-                        "type": "object",
-                        "properties": {
-                          "uniqueId": {
-                            "type": "string",
-                            "description": "Unique ID."
-                          },
-                          "id": {
-                            "type": "string",
-                            "description": "ID of the item."
-                          },
-                          "productId": {
-                            "type": "string",
-                            "description": "Product ID."
-                          },
-                          "productRefId": {
-                            "type": "string",
-                            "description": "Product Ref ID."
-                          },
-                          "refId": {
-                            "type": "string",
-                            "description": "Ref ID."
-                          },
-                          "ean": {
-                            "type": "string",
-                            "description": "European Article Number.",
-                            "nullable": true
-                          },
-                          "name": {
-                            "type": "string",
-                            "description": "Product name."
-                          },
-                          "skuName": {
-                            "type": "string",
-                            "description": "SKU name."
-                          },
-                          "modalType": {
-                            "type": "string",
-                            "description": "Modal type.",
-                            "nullable": true
-                          },
-                          "parentItemIndex": {
-                            "type": "integer",
-                            "description": "Parent item index.",
-                            "nullable": true
-                          },
-                          "parentAssemblyBinding": {
-                            "type": "string",
-                            "description": "Parent assembly binding.",
-                            "nullable": true
-                          },
-                          "priceValidUntil": {
-                            "type": "string",
-                            "description": "Price expiration date and time."
-                          },
-                          "tax": {
-                            "type": "integer",
-                            "description": "Tax value in cents."
-                          },
-                          "taxCode": {
-                            "type": "string",
-                            "description": "A unique identifier code assigned to a tax within the VTEX Admin."
-                          },
-                          "price": {
-                            "type": "integer",
-                            "description": "Price in cents."
-                          },
-                          "listPrice": {
-                            "type": "integer",
-                            "description": "List price in cents."
-                          },
-                          "manualPrice": {
-                            "type": "integer",
-                            "description": "Manual price in cents.",
-                            "nullable": true
-                          },
-                          "manualPriceAppliedBy": {
-                            "type": "string",
-                            "description": "User that applied the manual price, if that is the case.",
-                            "nullable": true
-                          },
-                          "sellingPrice": {
-                            "type": "integer",
-                            "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
-                          },
-                          "rewardValue": {
-                            "type": "integer",
-                            "description": "Reward value in cents."
-                          },
-                          "isGift": {
-                            "type": "boolean",
-                            "description": "Indicates whether item is a gift."
-                          },
-                          "additionalInfo": {
-                            "type": "object",
-                            "description": "Additional information.",
-                            "properties": {
-                              "dimension": {
-                                "type": "string",
-                                "description": "Dimension.",
-                                "nullable": true
-                              },
-                              "brandName": {
-                                "type": "string",
-                                "description": "Brand name."
-                              },
-                              "brandId": {
-                                "type": "string",
-                                "description": "Brand ID."
-                              },
-                              "offeringInfo": {
-                                "type": "string",
-                                "description": "Offering information.",
-                                "nullable": true
-                              },
-                              "offeringType": {
-                                "type": "string",
-                                "description": "Offering type.",
-                                "nullable": true
-                              },
-                              "offeringTypeId": {
-                                "type": "string",
-                                "description": "Offering type ID.",
-                                "nullable": true
-                              }
-                            }
-                          },
-                          "preSaleDate": {
-                            "type": "string",
-                            "description": "Presale date.",
-                            "nullable": true
-                          },
-                          "productCategoryIds": {
-                            "type": "string",
-                            "description": "Product category IDs."
-                          },
-                          "productCategories": {
-                            "type": "object",
-                            "description": "Object, where each field is an ID from `productCategoryIds`.",
-                            "properties": {
-                              "{ID}": {
-                                "type": "string",
-                                "description": "Product category corresponding to the ID in the field key."
-                              }
-                            }
-                          },
-                          "quantity": {
-                            "type": "integer",
-                            "description": "Quantity."
-                          },
-                          "seller": {
-                            "type": "string",
-                            "description": "Seller."
-                          },
-                          "sellerChain": {
-                            "type": "array",
-                            "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
-                            "items": {
-                              "type": "string",
-                              "description": "Seller."
-                            }
-                          },
-                          "imageUrl": {
-                            "type": "string",
-                            "description": "Image URL."
-                          },
-                          "detailUrl": {
-                            "type": "string",
-                            "description": "Detail URL."
-                          },
-                          "bundleItems": {
-                            "type": "array",
-                            "description": "Information on services sold along with the SKU. Example: a gift package.",
-                            "items": {
-                              "type": "object",
-                              "properties": {
-                                "type": {
-                                  "type": "string",
-                                  "description": "Service type."
-                                },
-                                "id": {
-                                  "type": "integer",
-                                  "description": "Service identifier."
-                                },
-                                "name": {
-                                  "type": "string",
-                                  "description": "Service name."
-                                },
-                                "price": {
-                                  "type": "integer",
-                                  "description": "Service price in cents."
-                                }
-                              }
-                            }
-                          },
-                          "attachments": {
-                            "type": "array",
-                            "description": "Array containing information on attachments.",
-                            "items": {
-                              "type": "string"
-                            }
-                          },
-                          "priceTags": {
-                            "type": "array",
-                            "description": "Array of price tags, each of which, modifies the price in some way, like discounts or rates that apply to the item in the context of the order.",
-                            "items": {
-                              "type": "object",
-                              "properties": {
-                                "identifier": {
-                                  "type": "string",
-                                  "description": "Price tag identifier."
-                                },
-                                "isPercentual": {
-                                  "type": "boolean",
-                                  "description": "Indicates whether price tag value is applied through a percentage."
-                                },
-                                "name": {
-                                  "type": "string",
-                                  "description": "Price tag name."
-                                },
-                                "rawValue": {
-                                  "type": "integer",
-                                  "description": "Price tag raw value."
-                                },
-                                "value": {
-                                  "type": "integer",
-                                  "description": "Price tag value."
-                                }
-                              }
-                            }
-                          },
-                          "availability": {
-                            "type": "string",
-                            "description": "Availability."
-                          },
-                          "measurementUnit": {
-                            "type": "string",
-                            "description": "Measurement unit."
-                          },
-                          "unitMultiplier": {
-                            "type": "integer",
-                            "description": "Unit multiplier."
-                          },
-                          "manufacturerCode": {
-                            "type": "string",
-                            "description": "Manufacturer code.",
-                            "nullable": true
-                          },
-                          "priceDefinition": {
-                            "type": "object",
-                            "description": "Price information for all units of a specific item.",
-                            "properties": {
-                              "calculatedSellingPrice": {
-                                "type": "integer",
-                                "description": "Item's calculated unitary selling price in cents."
-                              },
-                              "total": {
-                                "type": "integer",
-                                "description": "Total value for all units of the item in cents."
-                              },
-                              "sellingPrices": {
-                                "type": "array",
-                                "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
-                                "items": {
-                                  "type": "object",
-                                  "properties": {
-                                    "value": {
-                                      "type": "integer",
-                                      "description": "Value in cents for that specific rounding."
-                                    },
-                                    "quantity": {
-                                      "type": "integer",
-                                      "description": "Rounding quantity, meaning how many items are rounded to this value."
-                                    }
-                                  }
-                                }
-                              }
-                            }
-                          }
-                        }
-                      }
-                    },
-                    "selectableGifts": {
-                      "type": "array",
-                      "description": "Array containing the data of the item selected as a gift."
-                    },
-                    "totalizers": {
-                      "type": "array",
-                      "description": "Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value)."
-                    },
-                    "shippingData": {
-                      "type": "object",
-                      "description": "Shipping information pertinent to the order.",
-                      "properties": {
-                        "address": {
-                          "type": "object",
-                          "description": "Address information.",
-                          "properties": {
-                            "addressType": {
-                              "type": "string",
-                              "description": "Type of address. For example, `Residential` or `Pickup`."
-                            },
-                            "receiverName": {
-                              "type": "string",
-                              "description": "Name of the person who is going to receive the order."
-                            },
-                            "addressId": {
-                              "type": "string",
-                              "description": "Address ID."
-                            },
-                            "isDisposable": {
-                              "type": "boolean",
-                              "description": "Indicates whether address is disposable."
-                            },
-                            "postalCode": {
-                              "type": "string",
-                              "description": "Postal code."
-                            },
-                            "city": {
-                              "type": "string",
-                              "description": "City of the shipping address."
-                            },
-                            "state": {
-                              "type": "string",
-                              "description": "State of the shipping address."
-                            },
-                            "country": {
-                              "type": "string",
-                              "description": "Three letter ISO code of the country of the shipping address."
-                            },
-                            "street": {
-                              "type": "string",
-                              "description": "Street of the shipping address."
-                            },
-                            "number": {
-                              "type": "string",
-                              "description": "Number of the building, house or apartment in the shipping address."
-                            },
-                            "neighborhood": {
-                              "type": "string",
-                              "description": "Neighborhood of the shipping address."
-                            },
-                            "complement": {
-                              "type": "string",
-                              "description": "Complement to the shipping address, in case it applies.",
-                              "nullable": true
-                            },
-                            "reference": {
-                              "type": "string",
-                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
-                              "nullable": true
-                            },
-                            "geoCoordinates": {
-                              "type": "array",
-                              "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
-                              "items": {
-                                "type": "number"
-                              }
-                            }
-                          }
-                        },
-                        "logisticsInfo": {
-                          "type": "array",
-                          "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "itemIndex": {
-                                "type": "integer",
-                                "description": "Index corresponding to the position of the object in the `items` array."
-                              },
-                              "selectedSla": {
-                                "type": "string",
-                                "description": "SLA selected by the customer."
-                              },
-                              "selectedDeliveryChannel": {
-                                "type": "string",
-                                "description": "Delivery channel selected by the customer."
-                              },
-                              "addressId": {
-                                "type": "string",
-                                "description": "Address ID."
-                              },
-                              "slas": {
-                                "type": "array",
-                                "description": "Information on available SLAs.",
-                                "items": {
-                                  "type": "object",
-                                  "properties": {
-                                    "id": {
-                                      "type": "string",
-                                      "description": "SLA ID."
-                                    },
-                                    "deliveryChannel": {
-                                      "type": "string",
-                                      "description": "Delivery channel."
-                                    },
-                                    "name": {
-                                      "type": "string",
-                                      "description": "SLA name."
-                                    },
-                                    "deliveryIds": {
-                                      "type": "array",
-                                      "description": "Information on each delivery ID.",
-                                      "items": {
-                                        "type": "object",
-                                        "properties": {
-                                          "courierId": {
-                                            "type": "string",
-                                            "description": "Courier ID."
-                                          },
-                                          "warehouseId": {
-                                            "type": "string",
-                                            "description": "Warehouse ID."
-                                          },
-                                          "dockId": {
-                                            "type": "string",
-                                            "description": "Warehouse ID."
-                                          },
-                                          "courierName": {
-                                            "type": "string",
-                                            "description": "Courier name."
-                                          },
-                                          "quantity": {
-                                            "type": "integer",
-                                            "description": "Quantity."
-                                          }
-                                        }
-                                      }
-                                    },
-                                    "shippingEstimate": {
-                                      "type": "string",
-                                      "description": "Shipping estimate. For instance, Three business days will be represented `3bd`."
-                                    },
-                                    "shippingEstimateDate": {
-                                      "type": "string",
-                                      "description": "Shipping estimate date.",
-                                      "nullable": true
-                                    },
-                                    "lockTTL": {
-                                      "type": "string",
-                                      "description": "Estimate date of delivery."
-                                    },
-                                    "price": {
-                                      "type": "integer",
-                                      "description": "Price in cents."
-                                    },
-                                    "listPrice": {
-                                      "type": "integer",
-                                      "description": "List price in cents."
-                                    },
-                                    "tax": {
-                                      "type": "integer",
-                                      "description": "Tax in cents."
-                                    },
-                                    "pickupStoreInfo": {
-                                      "type": "object",
-                                      "description": "Information on the pickup store.",
-                                      "properties": {
-                                        "isPickupStore": {
-                                          "type": "boolean",
-                                          "description": "Indicates whether it is the pickup store."
-                                        },
-                                        "friendlyName": {
-                                          "type": "string",
-                                          "description": "Friendly name.",
-                                          "nullable": true
-                                        },
-                                        "address": {
-                                          "type": "object",
-                                          "description": "Address information.",
-                                          "nullable": true,
-                                          "properties": {
-                                            "addressType": {
-                                              "type": "string",
-                                              "description": "Type of address. For example, `Residential` or `Pickup`."
-                                            },
-                                            "postalCode": {
-                                              "type": "string",
-                                              "description": "Postal code."
-                                            },
-                                            "city": {
-                                              "type": "string",
-                                              "description": "City of the shipping address."
-                                            },
-                                            "state": {
-                                              "type": "string",
-                                              "description": "State of the shipping address."
-                                            },
-                                            "country": {
-                                              "type": "string",
-                                              "description": "Three letter ISO code of the country of the shipping address."
-                                            },
-                                            "street": {
-                                              "type": "string",
-                                              "description": "Street of the shipping address."
-                                            },
-                                            "number": {
-                                              "type": "string",
-                                              "description": "Number of the building, house or apartment in the shipping address."
-                                            },
-                                            "neighborhood": {
-                                              "type": "string",
-                                              "description": "Neighborhood of the shipping address."
-                                            },
-                                            "complement": {
-                                              "type": "string",
-                                              "description": "Complement to the shipping address, in case it applies.",
-                                              "nullable": true
-                                            },
-                                            "reference": {
-                                              "type": "string",
-                                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
-                                              "nullable": true
-                                            },
-                                            "geoCoordinates": {
-                                              "type": "array",
-                                              "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
-                                              "items": {
-                                                "type": "number"
-                                              }
-                                            }
-                                          }
-                                        },
-                                        "additionalInfo": {
-                                          "type": "string",
-                                          "description": "Additional information.",
-                                          "nullable": true
-                                        },
-                                        "dockId": {
-                                          "type": "string",
-                                          "description": "Corresponding dock ID.",
-                                          "nullable": true
-                                        }
-                                      }
-                                    },
-                                    "pickupPointId": {
-                                      "type": "string",
-                                      "description": "Pickup point ID.",
-                                      "nullable": true
-                                    },
-                                    "pickupDistance": {
-                                      "type": "integer",
-                                      "description": "Pickup point distance."
-                                    },
-                                    "polygonName": {
-                                      "type": "string",
-                                      "description": "Polygon name.",
-                                      "nullable": true
-                                    },
-                                    "transitTime": {
-                                      "type": "string",
-                                      "description": "Transit time. For instance, \"three business days\" is represented `3bd`."
-                                    }
-                                  }
-                                }
-                              },
-                              "shipsTo": {
-                                "type": "array",
-                                "description": "List of countries that the item may be shipped to.",
-                                "items": {
-                                  "type": "string",
-                                  "description": "Three letter country code."
-                                }
-                              },
-                              "itemId": {
-                                "type": "string",
-                                "description": "Item ID."
-                              },
-                              "deliveryChannels": {
-                                "type": "array",
-                                "description": "List of available delivery channels.",
-                                "items": {
-                                  "type": "object",
-                                  "properties": {
-                                    "id": {
-                                      "type": "string",
-                                      "description": "Delivery channel ID."
-                                    }
-                                  }
-                                }
-                              }
-                            }
-                          }
-                        },
-                        "selectedAddresses": {
-                          "type": "array",
-                          "description": "Array with information on the selected addresses for the order.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "addressType": {
-                                "type": "string",
-                                "description": "Type of address. For example, `Residential` or `Pickup`."
-                              },
-                              "receiverName": {
-                                "type": "string",
-                                "description": "Name of the person who is going to receive the order."
-                              },
-                              "addressId": {
-                                "type": "string",
-                                "description": "Address ID."
-                              },
-                              "isDisposable": {
-                                "type": "boolean",
-                                "description": "Indicates whether address is disposable."
-                              },
-                              "postalCode": {
-                                "type": "string",
-                                "description": "Postal code."
-                              },
-                              "city": {
-                                "type": "string",
-                                "description": "City of the shipping address."
-                              },
-                              "state": {
-                                "type": "string",
-                                "description": "State of the shipping address."
-                              },
-                              "country": {
-                                "type": "string",
-                                "description": "Three letter ISO code of the country of the shipping address."
-                              },
-                              "street": {
-                                "type": "string",
-                                "description": "Street of the shipping address."
-                              },
-                              "number": {
-                                "type": "string",
-                                "description": "Number of the building, house or apartment in the shipping address."
-                              },
-                              "neighborhood": {
-                                "type": "string",
-                                "description": "Neighborhood of the shipping address."
-                              },
-                              "complement": {
-                                "type": "string",
-                                "description": "Complement to the shipping address, in case it applies."
-                              },
-                              "reference": {
-                                "type": "string",
-                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
-                                "nullable": true
-                              },
-                              "geoCoordinates": {
-                                "type": "array",
-                                "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
-                                "items": {
-                                  "type": "number"
-                                }
-                              }
-                            }
-                          }
-                        },
-                        "availableAddresses": {
-                          "type": "array",
-                          "description": "Array with information on the available addresses for the order.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "addressType": {
-                                "type": "string",
-                                "description": "Type of address. For example, `Residential` or `Pickup`."
-                              },
-                              "receiverName": {
-                                "type": "string",
-                                "description": "Name of the person who is going to receive the order."
-                              },
-                              "addressId": {
-                                "type": "string",
-                                "description": "Address ID."
-                              },
-                              "isDisposable": {
-                                "type": "boolean",
-                                "description": "Indicates whether address is disposable."
-                              },
-                              "postalCode": {
-                                "type": "string",
-                                "description": "Postal code."
-                              },
-                              "city": {
-                                "type": "string",
-                                "description": "City of the shipping address."
-                              },
-                              "state": {
-                                "type": "string",
-                                "description": "State of the shipping address."
-                              },
-                              "country": {
-                                "type": "string",
-                                "description": "Three letter ISO code of the country of the shipping address."
-                              },
-                              "street": {
-                                "type": "string",
-                                "description": "Street of the shipping address."
-                              },
-                              "number": {
-                                "type": "string",
-                                "description": "Number of the building, house or apartment in the shipping address."
-                              },
-                              "neighborhood": {
-                                "type": "string",
-                                "description": "Neighborhood of the shipping address."
-                              },
-                              "complement": {
-                                "type": "string",
-                                "description": "Complement to the shipping address, in case it applies."
-                              },
-                              "reference": {
-                                "type": "string",
-                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
-                                "nullable": true
-                              },
-                              "geoCoordinates": {
-                                "type": "array",
-                                "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
-                                "items": {
-                                  "type": "number"
-                                }
-                              }
-                            }
-                          }
-                        }
-                      }
-                    },
-                    "clientProfileData": {
-                      "type": "object",
-                      "description": "Customer's profile information.",
-                      "properties": {
-                        "email": {
-                          "type": "string",
-                          "description": "Email address."
-                        },
-                        "firstName": {
-                          "type": "string",
-                          "description": "First name."
-                        },
-                        "lastName": {
-                          "type": "string",
-                          "description": "Last name."
-                        },
-                        "documentType": {
-                          "type": "string",
-                          "description": "Type of the document informed by the customer."
-                        },
-                        "document": {
-                          "type": "string",
-                          "description": "Document informed by the customer."
-                        },
-                        "phone": {
-                          "type": "string",
-                          "description": "Phone number."
-                        },
-                        "corporateName": {
-                          "type": "string",
-                          "description": "Company name, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "tradeName": {
-                          "type": "string",
-                          "description": "Trade name, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "corporateDocument": {
-                          "type": "string",
-                          "description": "Corporate document, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "stateInscription": {
-                          "type": "string",
-                          "description": "State inscription, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "corporatePhone": {
-                          "type": "string",
-                          "description": "Corporate phone number, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "isCorporate": {
-                          "type": "boolean",
-                          "description": "Indicates whether the customer is a legal entity."
-                        },
-                        "profileCompleteOnLoading": {
-                          "type": "boolean",
-                          "description": "Indicates whether profile is complete on loading."
-                        },
-                        "profileErrorOnLoading": {
-                          "type": "boolean",
-                          "description": "Indicates whether profile presents error on loading.",
-                          "nullable": true
-                        },
-                        "customerClass": {
-                          "type": "string",
-                          "description": "Customer class.",
-                          "nullable": true
-                        }
-                      }
-                    },
-                    "paymentData": {
-                      "type": "object",
-                      "description": "Information on the order's payment.",
-                      "properties": {
-                        "giftCards": {
-                          "type": "array",
-                          "description": "Gift card information, if it applies to the order.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "redemptionCode": {
-                                "type": "string",
-                                "description": "Gift card redemption code."
-                              },
-                              "value": {
-                                "type": "integer",
-                                "description": "Gift card value in cents."
-                              },
-                              "balance": {
-                                "type": "integer",
-                                "description": "Gift card balance in cents."
-                              },
-                              "name": {
-                                "type": "string",
-                                "description": "Gift card name."
-                              },
-                              "id": {
-                                "type": "string",
-                                "description": "Gift card ID."
-                              },
-                              "inUse": {
-                                "type": "boolean",
-                                "description": "Indicates whether gift card is in use."
-                              },
-                              "isSpecialCard": {
-                                "type": "boolean",
-                                "description": "Indicates whether gift card is special."
-                              }
-                            }
-                          }
-                        },
-                        "transactions": {
-                          "type": "array",
-                          "description": "Information on each transaction pertinent to the order.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "isActive": {
-                                "type": "boolean",
-                                "description": "Indicates whether transaction is active."
-                              },
-                              "transactionId": {
-                                "type": "string",
-                                "description": "Transaction ID."
-                              },
-                              "merchantName": {
-                                "type": "string",
-                                "description": "Merchant name."
-                              },
-                              "payments": {
-                                "type": "array",
-                                "description": "Information on each payment.",
-                                "items": {
-                                  "type": "object",
-                                  "properties": {
-                                    "accountId": {
-                                      "type": "string",
-                                      "description": "Account ID."
-                                    },
-                                    "bin": {
-                                      "type": "string",
-                                      "description": "Bin."
-                                    },
-                                    "installments": {
-                                      "type": "integer",
-                                      "description": "Number of installments."
-                                    },
-                                    "paymentSystem": {
-                                      "type": "string",
-                                      "description": "Payment system."
-                                    },
-                                    "referenceValue": {
-                                      "type": "integer",
-                                      "description": "Reference value for calculating interest rates, in case it applies. Displayed in cents."
-                                    },
-                                    "value": {
-                                      "type": "integer",
-                                      "description": "Value including interest, in case it applies. Displayed in cents."
-                                    }
-                                  }
-                                }
-                              },
-                              "sharedTransaction": {
-                                "type": "boolean",
-                                "description": "Indicates whather transaction is shared."
-                              }
-                            }
-                          }
-                        }
-                      }
-                    },
-                    "marketingData": {
-                      "type": "object",
-                      "description": "Object containing promotion data such as coupon tracking information and internal or external UTMs.",
-                      "properties": {
-                        "coupon": {
-                          "type": "string",
-                          "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pub/orderForms/simulation) request to check which coupons might apply before placing the order.",
-                          "default": "free-shipping"
-                        },
-                        "utmSource": {
-                          "type": "string",
-                          "description": "UTM source.",
-                          "default": "Facebook"
-                        },
-                        "utmMedium": {
-                          "type": "string",
-                          "description": "UTM medium.",
-                          "default": "CPC"
-                        },
-                        "utmCampaign": {
-                          "type": "string",
-                          "description": "UTM campaign",
-                          "default": "Black friday"
-                        },
-                        "utmiPage": {
-                          "type": "string",
-                          "description": "utmi_page (internal utm).",
-                          "default": "utmi_page-example",
-                          "nullable": true
-                        },
-                        "utmiPart": {
-                          "type": "string",
-                          "description": "utmi_part (internal utm).",
-                          "default": "utmi_part-example",
-                          "nullable": true
-                        },
-                        "utmiCampaign": {
-                          "type": "string",
-                          "description": "utmi_campaign (internal utm).",
-                          "default": "utmi_campaign-example",
-                          "nullable": true
-                        }
-                      }
-                    },
-                    "sellers": {
-                      "type": "array",
-                      "description": "Information on each seller.",
-                      "items": {
-                        "type": "object",
-                        "properties": {
-                          "id": {
-                            "type": "string",
-                            "description": "Seller ID."
-                          },
-                          "name": {
-                            "type": "string",
-                            "description": "Seller name."
-                          },
-                          "logo": {
-                            "type": "string",
-                            "description": "Seller logo.",
-                            "nullable": true
-                          }
-                        }
-                      }
-                    },
-                    "clientPreferencesData": {
-                      "type": "object",
-                      "description": "Object containing preferences from the client who placed the order.",
-                      "properties": {
-                        "locale": {
-                          "type": "string",
-                          "description": "Client's locale. Examples: `pt-BR` and `en-US`."
-                        },
-                        "optinNewsLetter": {
-                          "type": "boolean",
-                          "description": "`true` if the client opted to receive newsletter from the store.",
-                          "default": false
-                        }
-                      }
-                    },
-                    "commercialConditionData": {
-                      "type": "object",
-                      "description": "Object containing commercial condition information.",
-                      "nullable": true
-                    },
-                    "storePreferencesData": {
-                      "type": "object",
-                      "description": "Object containing data from the store's configuration (stored in VTEX's License Manager)."
-                    },
-                    "giftRegistryData": {
-                      "type": "object",
-                      "description": "Gift registry list information.",
-                      "nullable": true
-                    },
-                    "openTextField": {
-                      "type": "string",
-                      "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/docs/guides/customizable-fields-with-checkout-api).",
-                      "default": "open-text-example",
-                      "nullable": true
-                    },
-                    "invoiceData": {
-                      "type": "object",
-                      "description": "Object containing information pertinent to the order's invoice.",
-                      "nullable": true
-                    },
-                    "customData": {
-                      "type": "object",
-                      "description": "Customer additional information.",
-                      "nullable": true
-                    },
-                    "itemMetadata": {
-                      "type": "object",
-                      "description": "Item metadata.",
-                      "properties": {
-                        "items": {
-                          "type": "array",
-                          "description": "List of objects containing metadata on each item in the order.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "id": {
-                                "type": "string",
-                                "description": "Item ID."
-                              },
-                              "seller": {
-                                "type": "string",
-                                "description": "Seller."
-                              },
-                              "name": {
-                                "type": "string",
-                                "description": "Product name."
-                              },
-                              "skuName": {
-                                "type": "string",
-                                "description": "SKU name."
-                              },
-                              "productId": {
-                                "type": "string",
-                                "description": "Product ID."
-                              },
-                              "refId": {
-                                "type": "string",
-                                "description": "Ref ID."
-                              },
-                              "ean": {
-                                "type": "string",
-                                "description": "European Article Number.",
-                                "nullable": true
-                              },
-                              "imageUrl": {
-                                "type": "string",
-                                "description": "Image URL."
-                              },
-                              "detailUrl": {
-                                "type": "string",
-                                "description": "Detail URL."
-                              }
-                            }
-                          }
-                        }
-                      }
-                    },
-                    "hooksData": {
-                      "type": "object",
-                      "description": "Hooks information.",
-                      "nullable": true
-                    },
-                    "ratesAndBenefitsData": {
-                      "type": "object",
-                      "description": "Information on rates and benefits that apply to the order.",
-                      "properties": {
-                        "rateAndBenefitsIdentifiers": {
-                          "type": "array",
-                          "description": "List with rates and benefits identifiers.",
-                          "items": {
-                            "type": "string"
-                          }
-                        },
-                        "teaser": {
-                          "type": "array",
-                          "description": "List with rates and benefits teasers.",
-                          "items": {
-                            "type": "string"
-                          }
-                        }
-                      }
-                    },
-                    "subscriptionData": {
-                      "type": "object",
-                      "description": "Subscription information.",
-                      "nullable": true
-                    },
-                    "itemsOrdination": {
-                      "type": "object",
-                      "description": "Object containing information about the ordering of items within the orderForm.",
-                      "properties": {
-                        "criteria": {
-                          "type": "string",
-                          "description": "Criteria adopted to order the items in the list."
-                        },
-                        "ascending": {
-                          "type": "boolean",
-                          "description": "Indicates whether the ordering is ascending."
-                        }
-                      }
-                    }
-                  }
-                },
-                "example": {
-                  "orderFormId": "ede846222cd44046ba6c638442c3505a",
-                  "salesChannel": "1",
-                  "loggedIn": false,
-                  "isCheckedIn": false,
-                  "storeId": null,
-                  "allowManualPrice": false,
-                  "canEditData": true,
-                  "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
-                  "profileProvider": "VTEX",
-                  "availableAccounts": [],
-                  "availableAddresses": [
-                    {
-                      "addressType": "residential",
-                      "receiverName": "Clark Kent",
-                      "addressId": "666c2e830bd9474ab6f6cc53fb6dd2d2",
-                      "isDisposable": true,
-                      "postalCode": "70386000",
-                      "city": "Brasília",
-                      "state": "DF",
-                      "country": "BRA",
-                      "street": "Rua da minha casa",
-                      "number": "123",
-                      "neighborhood": "Copacabana",
-                      "complement": "15º andar",
-                      "reference": null,
-                      "geoCoordinates": [
-                        -47.924747467041016,
-                        -15.832582473754883
-                      ]
-                    }
-                  ],
-                  "userType": null,
-                  "ignoreProfileData": false,
-                  "value": 34390,
-                  "messages": [],
-                  "items": [
-                    {
-                      "uniqueId": "9D6E447B3FF64CEDA33B17C01379C119",
-                      "id": "2",
-                      "productId": "2005",
-                      "productRefId": "",
-                      "refId": "CBC30L",
-                      "ean": null,
-                      "name": "Chopp Brahma Claro 30L",
-                      "skuName": "Chopp Brahma Claro 30L",
-                      "modalType": null,
-                      "parentItemIndex": null,
-                      "parentAssemblyBinding": null,
-                      "assemblies": [],
-                      "priceValidUntil": "2022-07-13T18:30:46Z",
-                      "tax": 0,
-                      "taxCode": "54WC8ZN6K8",
-                      "price": 32890,
-                      "listPrice": 49900,
-                      "manualPrice": null,
-                      "manualPriceAppliedBy": null,
-                      "sellingPrice": 32890,
-                      "rewardValue": 0,
-                      "isGift": false,
-                      "additionalInfo": {
-                        "dimension": null,
-                        "brandName": "Brahma",
-                        "brandId": "2000000",
-                        "offeringInfo": null,
-                        "offeringType": null,
-                        "offeringTypeId": null
-                      },
-                      "preSaleDate": null,
-                      "productCategoryIds": "/1/",
-                      "productCategories": {
-                        "1": "Bebidas"
-                      },
-                      "quantity": 3,
-                      "seller": "1",
-                      "sellerChain": [
-                        "1"
-                      ],
-                      "imageUrl": "http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000",
-                      "detailUrl": "/chopp-brahma-claro-30l/p",
-                      "components": [],
-                      "bundleItems": [],
-                      "attachments": [],
-                      "attachmentOfferings": [],
-                      "offerings": [],
-                      "priceTags": [],
-                      "availability": "available",
-                      "measurementUnit": "un",
-                      "unitMultiplier": 1,
-                      "manufacturerCode": null,
-                      "priceDefinition": {
-                        "calculatedSellingPrice": 32890,
-                        "total": 32890,
-                        "sellingPrices": [
-                          {
-                            "value": 32890,
-                            "quantity": 1
-                          }
-                        ]
-                      }
-                    }
-                  ],
-                  "selectableGifts": [],
-                  "totalizers": [
-                    {
-                      "id": "Items",
-                      "name": "Total dos Itens",
-                      "value": 15000
-                    }
-                  ],
-                  "shippingData": {
-                    "address": {
-                      "addressType": "residential",
-                      "receiverName": "Clark Kent",
-                      "addressId": "teste",
-                      "isDisposable": true,
-                      "postalCode": "70386000",
-                      "city": "Brasília",
-                      "state": "DF",
-                      "country": "BRA",
-                      "street": "Rua da minha casa",
-                      "number": "123",
-                      "neighborhood": "Copacabana",
-                      "complement": "15º andar",
-                      "reference": null,
-                      "geoCoordinates": [
-                        -47.924747467041016,
-                        -15.832582473754883
-                      ]
-                    },
-                    "logisticsInfo": [
-                      {
-                        "itemIndex": 0,
-                        "selectedSla": "Normal",
-                        "selectedDeliveryChannel": "delivery",
-                        "addressId": "teste",
-                        "slas": [
-                          {
-                            "id": "Normal",
-                            "deliveryChannel": "delivery",
-                            "name": "Normal",
-                            "deliveryIds": [
-                              {
-                                "courierId": "1",
-                                "warehouseId": "1_1",
-                                "dockId": "1",
-                                "courierName": "Transportadora",
-                                "quantity": 1,
-                                "kitItemDetails": []
-                              }
-                            ],
-                            "shippingEstimate": "3bd",
-                            "shippingEstimateDate": null,
-                            "lockTTL": "10d",
-                            "availableDeliveryWindows": [],
-                            "deliveryWindow": null,
-                            "price": 1500,
-                            "listPrice": 1500,
-                            "tax": 0,
-                            "pickupStoreInfo": {
-                              "isPickupStore": false,
-                              "friendlyName": null,
-                              "address": null,
-                              "additionalInfo": null,
-                              "dockId": null
-                            },
-                            "pickupPointId": null,
-                            "pickupDistance": 0,
-                            "polygonName": null,
-                            "transitTime": "3bd"
-                          }
-                        ],
-                        "shipsTo": [
-                          "BRA",
-                          "COL",
-                          "USA"
-                        ],
-                        "itemId": "2",
-                        "deliveryChannels": [
-                          {
-                            "id": "delivery"
-                          },
-                          {
-                            "id": "pickup-in-point"
-                          }
-                        ]
-                      }
-                    ],
-                    "selectedAddresses": [
-                      {
-                        "addressType": "residential",
-                        "receiverName": "Clark Kent",
-                        "addressId": "teste",
-                        "isDisposable": true,
-                        "postalCode": "12345000",
-                        "city": "Rio de Janeiro",
-                        "state": "RJ",
-                        "country": "BRA",
-                        "street": "Rua da minha casa",
-                        "number": "123",
-                        "neighborhood": "Copacabana",
-                        "complement": "15º andar",
-                        "reference": null,
-                        "geoCoordinates": [
-                          -47.924747467041016,
-                          -15.832582473754883
-                        ]
-                      }
-                    ],
-                    "availableAddresses": [
-                      {
-                        "addressType": "residential",
-                        "receiverName": "Clark Kent",
-                        "addressId": "teste",
-                        "isDisposable": true,
-                        "postalCode": "12345000",
-                        "city": "Rio de Janeiro",
-                        "state": "RJ",
-                        "country": "BRA",
-                        "street": "Rua da minha casa",
-                        "number": "123",
-                        "neighborhood": "Copacabana",
-                        "complement": "15º andar",
-                        "reference": null,
-                        "geoCoordinates": [
-                          -47.924747467041016,
-                          -15.832582473754883
-                        ]
-                      }
-                    ],
-                    "pickupPoints": []
-                  },
-                  "clientProfileData": {
-                    "email": "clark.kent@example.com",
-                    "firstName": "Clark",
-                    "lastName": "Kent",
-                    "document": "12345678900",
-                    "documentType": "cpf",
-                    "phone": "+5521998765432",
-                    "corporateName": null,
-                    "tradeName": null,
-                    "corporateDocument": null,
-                    "stateInscription": null,
-                    "corporatePhone": null,
-                    "isCorporate": false,
-                    "profileCompleteOnLoading": false,
-                    "profileErrorOnLoading": null,
-                    "customerClass": null
-                  },
-                  "paymentData": {
-                    "installmentOptions": [
-                      {
-                        "paymentSystem": "2",
-                        "bin": null,
-                        "paymentName": null,
-                        "paymentGroupName": null,
-                        "value": 15000,
-                        "installments": [
-                          {
-                            "count": 1,
-                            "hasInterestRate": false,
-                            "interestRate": 0,
-                            "value": 15000,
-                            "total": 15000,
-                            "sellerMerchantInstallments": [
-                              {
-                                "id": "LOJADOBRENO",
-                                "count": 1,
-                                "hasInterestRate": false,
-                                "interestRate": 0,
-                                "value": 15000,
-                                "total": 15000
-                              }
-                            ]
-                          },
-                          {
-                            "count": 2,
-                            "hasInterestRate": false,
-                            "interestRate": 0,
-                            "value": 7500,
-                            "total": 15000,
-                            "sellerMerchantInstallments": [
-                              {
-                                "id": "LOJADOBRENO",
-                                "count": 2,
-                                "hasInterestRate": false,
-                                "interestRate": 0,
-                                "value": 7500,
-                                "total": 15000
-                              }
-                            ]
-                          }
-                        ]
-                      }
-                    ],
-                    "paymentSystems": [
-                      {
-                        "id": 2,
-                        "name": "Visa",
-                        "groupName": "creditCardPaymentGroup",
-                        "validator": {
-                          "regex": "^2[1-8]{17}$",
-                          "mask": "9999 9999 9999 9999",
-                          "cardCodeRegex": "^[0-3]{8}$",
-                          "cardCodeMask": "999",
-                          "weights": [
-                            2,
-                            1,
-                            2,
-                            1,
-                            2,
-                            1
-                          ],
-                          "useCvv": true,
-                          "useExpirationDate": true,
-                          "useCardHolderName": true,
-                          "useBillingAddress": true
-                        },
-                        "stringId": "2",
-                        "template": "creditCardPaymentGroup-template",
-                        "requiresDocument": false,
-                        "isCustom": false,
-                        "description": null,
-                        "requiresAuthentication": false,
-                        "dueDate": "2020-03-05T14:59:00.7879306Z",
-                        "availablePayments": null
-                      }
-                    ],
-                    "payments": [],
-                    "giftCards": [],
-                    "giftCardMessages": [],
-                    "availableAccounts": [],
-                    "availableTokens": []
-                  },
-                  "marketingData": {
-                    "coupon": "free-shipping",
-                    "utmSource": "app",
-                    "utmMedium": "CPC",
-                    "utmCampaign": "Black friday",
-                    "utmipage": null,
-                    "utmiPart": null,
-                    "utmiCampaign": null
-                  },
-                  "sellers": [
-                    {
-                      "id": "1",
-                      "name": "lojadobreno",
-                      "logo": ""
-                    }
-                  ],
-                  "clientPreferencesData": {
-                    "locale": "pt-BR",
-                    "optinNewsLetter": false
-                  },
-                  "commercialConditionData": null,
-                  "storePreferencesData": {
-                    "countryCode": "BRA",
-                    "saveUserData": true,
-                    "timeZone": "E. South America Standard Time",
-                    "currencyCode": "BRL",
-                    "currencyLocale": 1046,
-                    "currencySymboupdate cartl": "R$",
-                    "currencyFormatInfo": {
-                      "currencyDecimalDigits": 2,
-                      "currencyDecimalSeparator": ",",
-                      "currencyGroupSeparator": ".",
-                      "currencyGroupSize": 3,
-                      "startsWithCurrencySymbol": true
-                    }
-                  },
-                  "giftRegistryData": null,
-                  "openTextField": null,
-                  "invoiceData": null,
-                  "customData": null,
-                  "itemMetadata": {
-                    "items": [
-                      {
-                        "id": "1",
-                        "seller": "1",
-                        "name": "Ração Royal Canin Feline Urinary 500g",
-                        "skuName": "Ração Royal Canin Feline Urinary 500g",
-                        "productId": "1",
-                        "refId": "0001",
-                        "ean": "123456789",
-                        "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
-                        "detailUrl": "/racao-royal-canin-feline-urinary/p",
-                        "assemblyOptions": []
-                      }
-                    ]
-                  },
-                  "hooksData": null,
-                  "ratesAndBenefitsData": {
-                    "rateAndBenefitsIdentifiers": [],
-                    "teaser": []
-                  },
-                  "subscriptionData": null,
-                  "itemsOrdination": {
-                    "criteria": "NAME",
-                    "ascending": true
-                  }
-                }
-              }
-            }
-          }
-        },
-        "deprecated": false
-      }
-    },
-    "/api/checkout/pub/orderForm/{orderFormId}/items/{itemIndex}/price": {
-      "put": {
-        "tags": [
-          "Shopping cart"
-        ],
-        "summary": "Change price",
-        "description": "This request changes the price of an SKU in a cart.\r\n\r\nThe [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.\n\r\n\rYou need to inform which cart you are referring to, by sending its `orderFormId` and what is the item whose price you want to change, by sending its `itemIndex`.\n\r\n\rYou also need to pass the new price value in the body.\n\r\n\rRemember that, to use this endpoint, the feature of *manual price* must be active. To check if it's active, use the [Get orderForm configuration](https://developers.vtex.com/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`.\n\r\n\r> Whenever you use this request to change the price of an item, all items in that cart with the same SKU are affected by this change. This applies even to items that share the SKU but have been separated into different objects in the `items` array due to customizations or attachments, for example.",
-        "operationId": "PriceChange",
-        "parameters": [
-          {
-            "name": "orderFormId",
-            "in": "path",
-            "description": "ID of the orderForm corresponding to the cart whose items will have the price changed.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "ede846222cd44046ba6c638442c3505a"
-            }
-          },
-          {
-            "name": "itemIndex",
-            "in": "path",
-            "description": "The index of the item in the cart. Each cart item is identified by an index, starting in 0.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string"
-            }
-          },
-          {
-            "name": "Content-Type",
-            "in": "header",
-            "description": "Type of the content being sent.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "Accept",
-            "in": "header",
-            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          }
-        ],
-        "requestBody": {
-          "description": "",
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/PriceChangeRequest"
-              },
-              "example": {
-                "price": 10000
-              }
-            }
-          },
-          "required": true
-        },
-        "responses": {
-          "200": {
-            "description": "OK",
-            "content": {
-              "application/json": {
-                "example": {
-                  "orderFormId": "ede846222cd44046ba6c638442c3505a",
-                  "salesChannel": "1",
-                  "loggedIn": true,
-                  "isCheckedIn": false,
-                  "storeId": null,
-                  "checkedInPickupPointId": null,
-                  "allowManualPrice": true,
-                  "canEditData": true,
-                  "userProfileId": null,
-                  "userType": null,
-                  "ignoreProfileData": false,
-                  "value": 10000,
-                  "messages": [],
-                  "items": [
-                    {
-                      "uniqueId": "E0F2B7AF5CD74D668F1E27537206912C",
-                      "id": "1",
-                      "productId": "1",
-                      "productRefId": "",
-                      "refId": "0001",
-                      "ean": "123456789",
-                      "name": "Ração Royal Canin Feline Urinary 500g",
-                      "skuName": "Ração Royal Canin Feline Urinary 500g",
-                      "modalType": null,
-                      "parentItemIndex": null,
-                      "parentAssemblyBinding": null,
-                      "assemblies": [],
-                      "priceValidUntil": "2021-02-27T14:59:00.8288784Z",
-                      "tax": 0,
-                      "taxCode": "54WC8ZN6K8",
-                      "price": 15000,
-                      "listPrice": 30000,
-                      "manualPrice": 10000,
-                      "sellingPrice": 10000,
-                      "rewardValue": 0,
-                      "isGift": false,
-                      "additionalInfo": {
-                        "brandName": "Royal Canin",
-                        "brandId": "2000000",
-                        "offeringInfo": null,
-                        "offeringType": null,
-                        "offeringTypeId": null
-                      },
-                      "preSaleDate": null,
-                      "productCategoryIds": "/1/10/",
-                      "productCategories": {
-                        "10": "Ração Seca",
-                        "1": "Alimentação"
-                      },
-                      "quantity": 1,
-                      "seller": "1",
-                      "sellerChain": [
-                        "1"
-                      ],
-                      "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
-                      "detailUrl": "/racao-royal-canin-feline-urinary/p",
-                      "components": [],
-                      "bundleItems": [],
-                      "attachments": [],
-                      "attachmentOfferings": [],
-                      "offerings": [],
-                      "priceTags": [
-                        {
-                          "name": "DISCOUNT@MANUALPRICE",
-                          "value": -5000,
-                          "rawValue": -50.0,
-                          "isPercentual": false,
-                          "identifier": null
-                        }
-                      ],
-                      "availability": "available",
-                      "measurementUnit": "un",
-                      "unitMultiplier": 1.0,
-                      "manufacturerCode": null
-                    }
-                  ],
-                  "selectableGifts": [],
-                  "totalizers": [
-                    {
-                      "id": "Items",
-                      "name": "Total dos Itens",
-                      "value": 15000
-                    },
-                    {
-                      "id": "Discounts",
-                      "name": "Total dos Descontos",
-                      "value": -5000
-                    }
-                  ],
-                  "shippingData": {
-                    "address": null,
-                    "logisticsInfo": [
-                      {
-                        "itemIndex": 0,
-                        "selectedSla": null,
-                        "selectedDeliveryChannel": "delivery",
-                        "addressId": null,
-                        "slas": [],
-                        "shipsTo": [
-                          "BRA"
-                        ],
-                        "itemId": "1",
-                        "deliveryChannels": [
-                          {
-                            "id": "pickup-in-point"
-                          },
-                          {
-                            "id": "delivery"
-                          }
-                        ]
-                      }
-                    ],
-                    "selectedAddresses": [],
-                    "availableAddresses": [],
-                    "pickupPoints": []
-                  },
-                  "clientProfileData": null,
-                  "paymentData": {
-                    "installmentOptions": [
-                      {
-                        "paymentSystem": "2",
-                        "bin": null,
-                        "paymentName": null,
-                        "paymentGroupName": null,
-                        "value": 10000,
-                        "installments": [
-                          {
-                            "count": 1,
-                            "hasInterestRate": false,
-                            "interestRate": 0,
-                            "value": 10000,
-                            "total": 10000,
-                            "sellerMerchantInstallments": [
-                              {
-                                "id": "LOJADOBRENO",
-                                "count": 1,
-                                "hasInterestRate": false,
-                                "interestRate": 0,
-                                "value": 10000,
-                                "total": 10000
-                              }
-                            ]
-                          },
-                          {
-                            "count": 2,
-                            "hasInterestRate": false,
-                            "interestRate": 0,
-                            "value": 5000,
-                            "total": 10000,
-                            "sellerMerchantInstallments": [
-                              {
-                                "id": "LOJADOBRENO",
-                                "count": 2,
-                                "hasInterestRate": false,
-                                "interestRate": 0,
-                                "value": 5000,
-                                "total": 10000
-                              }
-                            ]
-                          }
-                        ]
-                      }
-                    ],
-                    "paymentSystems": [
-                      {
-                        "id": 2,
-                        "name": "Visa",
-                        "groupName": "creditCardPaymentGroup",
-                        "validator": {
-                          "regex": "^4[0-9]{15}$",
-                          "mask": "9999 9999 9999 9999",
-                          "cardCodeRegex": "^[0-9]{3}$",
-                          "cardCodeMask": "999",
-                          "weights": [
-                            2,
-                            1,
-                            2,
-                            1,
-                            2
-                          ],
-                          "useCvv": true,
-                          "useExpirationDate": true,
-                          "useCardHolderName": true,
-                          "useBillingAddress": true
-                        },
-                        "stringId": "2",
-                        "template": "creditCardPaymentGroup-template",
-                        "requiresDocument": false,
-                        "isCustom": false,
-                        "description": null,
-                        "requiresAuthentication": false,
-                        "dueDate": "2020-03-05T16:42:31.7836281Z",
-                        "availablePayments": null
-                      }
-                    ],
-                    "payments": [],
-                    "giftCards": [],
-                    "giftCardMessages": [],
-                    "availableAccounts": [],
-                    "availableTokens": []
-                  },
-                  "marketingData": null,
-                  "sellers": [
-                    {
-                      "id": "1",
-                      "name": "lojadobreno",
-                      "logo": ""
-                    }
-                  ],
-                  "clientPreferencesData": {
-                    "locale": "pt-BR",
-                    "optinNewsLetter": null
-                  },
-                  "commercialConditionData": null,
-                  "storePreferencesData": {
-                    "countryCode": "BRA",
-                    "saveUserData": true,
-                    "timeZone": "E. South America Standard Time",
-                    "currencyCode": "BRL",
-                    "currencyLocale": 1046,
-                    "currencySymbol": "R$",
-                    "currencyFormatInfo": {
-                      "currencyDecimalDigits": 2,
-                      "currencyDecimalSeparator": ",",
-                      "currencyGroupSeparator": ".",
-                      "currencyGroupSize": 3,
-                      "startsWithCurrencySymbol": true
-                    }
-                  },
-                  "giftRegistryData": null,
-                  "openTextField": null,
-                  "invoiceData": null,
-                  "customData": null,
-                  "itemMetadata": {
-                    "items": [
-                      {
-                        "id": "1",
-                        "seller": "1",
-                        "name": "Ração Royal Canin Feline Urinary 500g",
-                        "skuName": "Ração Royal Canin Feline Urinary 500g",
-                        "productId": "1",
-                        "refId": "0001",
-                        "ean": "123456789",
-                        "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
-                        "detailUrl": "/racao-royal-canin-feline-urinary/p",
-                        "assemblyOptions": []
-                      }
-                    ]
-                  },
-                  "hooksData": null,
-                  "ratesAndBenefitsData": {
-                    "rateAndBenefitsIdentifiers": [],
-                    "teaser": []
-                  },
-                  "subscriptionData": null,
-                  "itemsOrdination": null
-                }
-              }
-            }
-          }
-        },
-        "deprecated": false
-      }
-    },
-    "/api/checkout/pub/orderForm/{orderFormId}/profile": {
-      "patch": {
-        "tags": [
-          "Shopping cart"
-        ],
-        "summary": "Ignore profile data",
-        "description": "When a shopper provides an email address at Checkout, the platform tries to retrieve existing profile information for that email and add it to the shopping cart information. Use this request if you want to change this behavior for a given cart, meaning profile information will not be included in the order automattically.\r\n\r\nThe [orderForm](https://developers.vtex.com/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.\r\n\r\nNote that this request will only work if you have not sent the `clientProfileData` to the cart yet. Sending it to a cart that already has a `clientProfileData` should return a status `403 Forbidden` error, with an `Access denied` message.",
-        "operationId": "IgnoreProfileData",
-        "security": [],
-        "parameters": [
-          {
-            "name": "orderFormId",
-            "in": "path",
-            "description": "ID of the orderForm corresponding to the cart whose items will have the price changed.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "ede846222cd44046ba6c638442c3505a"
-            }
-          },
-          {
-            "name": "Content-Type",
-            "in": "header",
-            "description": "Type of the content being sent.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "Accept",
-            "in": "header",
-            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          }
-        ],
-        "requestBody": {
-          "description": "",
-          "content": {
-            "application/json": {
-              "schema": {
-                "type": "object",
-                "properties": {
-                  "ignoreProfileData": {
-                    "type": "boolean",
-                    "description": "Indicates whether profile data should be ignored.",
-                    "default": false
-                  }
-                }
-              },
-              "example": {
-                "price": 10000
-              }
-            }
-          },
-          "required": true
-        },
-        "responses": {
-          "200": {
-            "description": "",
-            "headers": {},
-            "content": {
-              "application/json": {
-                "example": {
-                  "orderFormId": "68b287ae65534704b1a1e42e47c82abc",
-                  "salesChannel": "1",
-                  "loggedIn": true,
-                  "isCheckedIn": false,
-                  "storeId": null,
-                  "checkedInPickupPointId": null,
-                  "allowManualPrice": false,
-                  "canEditData": true,
-                  "userProfileId": null,
-                  "userType": null,
-                  "ignoreProfileData": true,
-                  "value": 0,
-                  "messages": [],
-                  "items": [],
-                  "selectableGifts": [],
-                  "totalizers": [],
-                  "shippingData": null,
-                  "clientProfileData": {
-                    "email": null,
-                    "firstName": null,
-                    "lastName": null,
-                    "document": null,
-                    "documentType": null,
-                    "phone": null,
-                    "corporateName": null,
-                    "tradeName": null,
-                    "corporateDocument": null,
-                    "stateInscription": null,
-                    "corporatePhone": null,
-                    "isCorporate": false,
-                    "profileCompleteOnLoading": null,
-                    "profileErrorOnLoading": null,
-                    "customerClass": null
-                  },
-                  "paymentData": {
-                    "updateStatus": "updated",
-                    "installmentOptions": [],
-                    "paymentSystems": [],
-                    "payments": [],
-                    "giftCards": [],
-                    "giftCardMessages": [],
-                    "availableAccounts": [],
-                    "availableTokens": []
-                  },
-                  "marketingData": null,
-                  "sellers": [],
-                  "clientPreferencesData": {
-                    "locale": "pt-BR",
-                    "optinNewsLetter": null
-                  },
-                  "commercialConditionData": null,
-                  "storePreferencesData": {
-                    "countryCode": "BRA",
-                    "saveUserData": true,
-                    "timeZone": "E. South America Standard Time",
-                    "currencyCode": "BRL",
-                    "currencyLocale": 1046,
-                    "currencySymbol": "R$",
-                    "currencyFormatInfo": {
-                      "currencyDecimalDigits": 2,
-                      "currencyDecimalSeparator": ",",
-                      "currencyGroupSeparator": ".",
-                      "currencyGroupSize": 3,
-                      "startsWithCurrencySymbol": true
-                    }
-                  },
-                  "giftRegistryData": null,
-                  "openTextField": null,
-                  "invoiceData": null,
-                  "customData": null,
-                  "itemMetadata": null,
-                  "hooksData": null,
-                  "ratesAndBenefitsData": null,
-                  "subscriptionData": null,
-                  "itemsOrdination": null
-                }
-              }
-            }
-          }
-        },
-        "deprecated": false
-      }
-    },
-    "/api/checkout/pub/profiles": {
-      "get": {
-        "tags": [
-          "Cart attachments"
-        ],
-        "summary": "Get client profile by email",
-        "description": "Retrieve a client's profile information by providing an email address.\n\r\n\rIf the response body fields are empty, the following situations may have occurred:\n\r\n\r1. There is no client registered with the email address provided in your store, or;\n\r2. 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).\r\n\r\n>⚠️ 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.",
-        "operationId": "GetClientProfileByEmail",
-        "security": [],
-        "parameters": [
-          {
-            "name": "Content-Type",
-            "in": "header",
-            "description": "Type of the content being sent.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "Accept",
-            "in": "header",
-            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "email",
-            "in": "query",
-            "description": "Client's email address to be searched.",
-            "required": true,
-            "style": "form",
-            "schema": {
-              "type": "string",
-              "example": "clark.kent@examplemail.com"
-            }
-          },
-          {
-            "name": "ensureComplete",
-            "in": "query",
-            "description": "Indicates whether the returned profiles must be complete or not.",
-            "required": false,
-            "style": "form",
-            "schema": {
-              "type": "boolean",
-              "example": false,
-              "default": true
-            }
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "OK",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "object",
-                  "properties": {
-                    "userProfileId": {
-                      "type": "string",
-                      "description": "Unique ID associated with the customer profile."
-                    },
-                    "profileProvider": {
-                      "type": "string",
-                      "description": "Profile provider."
-                    },
-                    "availableAccounts": {
-                      "type": "array",
-                      "description": "Available accounts.",
-                      "items": {
-                        "type": "string"
-                      }
-                    },
-                    "availableAddresses": {
-                      "type": "array",
-                      "description": "Information on each available address.",
-                      "items": {
-                        "type": "object",
-                        "properties": {
-                          "addressType": {
-                            "type": "string",
-                            "description": "Address type."
-                          },
-                          "receiverName": {
-                            "type": "string",
-                            "description": "Name of the receiver."
-                          },
-                          "addressId": {
-                            "type": "string",
-                            "description": "Address ID."
-                          },
-                          "isDisposable": {
-                            "type": "boolean",
-                            "description": "Indicates whether address is disposable."
-                          },
-                          "city": {
-                            "type": "string",
-                            "description": "City of the address."
-                          },
-                          "state": {
-                            "type": "string",
-                            "description": "State of the address."
-                          },
-                          "country": {
-                            "type": "string",
-                            "description": "Country of the address. ISO three-letter code."
-                          },
-                          "street": {
-                            "type": "string",
-                            "description": "Street of the address."
-                          },
-                          "number": {
-                            "type": "string",
-                            "description": "Number of the address."
-                          },
-                          "neighborhood": {
-                            "type": "string",
-                            "description": "Neighborhood of the address."
-                          },
-                          "complement": {
-                            "type": "string",
-                            "description": "Complement to the address.",
-                            "nullable": true
-                          },
-                          "reference": {
-                            "type": "string",
-                            "description": "Reference that may help in the location of the address.",
-                            "nullable": true
-                          },
-                          "geoCoordinates": {
-                            "type": "array",
-                            "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
-                            "items": {
-                              "type": "number"
-                            }
-                          }
-                        }
-                      }
-                    },
-                    "userProfile": {
-                      "type": "object",
-                      "description": "Customer profile information.",
-                      "properties": {
-                        "email": {
-                          "type": "string",
-                          "description": "Email address."
-                        },
-                        "firstName": {
-                          "type": "string",
-                          "description": "First name."
-                        },
-                        "lastName": {
-                          "type": "string",
-                          "description": "Last name."
-                        },
-                        "document": {
-                          "type": "string",
-                          "description": "Document."
-                        },
-                        "documentType": {
-                          "type": "string",
-                          "description": "Document type."
-                        },
-                        "phone": {
-                          "type": "string",
-                          "description": "Telephone number."
-                        },
-                        "corporateName": {
-                          "type": "string",
-                          "description": "Name of the company. Used for corporate clients.",
-                          "nullable": true
-                        },
-                        "tradeName": {
-                          "type": "string",
-                          "description": "Trade name. Used for corporate clients.",
-                          "nullable": true
-                        },
-                        "corporateDocument": {
-                          "type": "string",
-                          "description": "Document. Used for corporate clients.",
-                          "nullable": true
-                        },
-                        "stateInscription": {
-                          "type": "string",
-                          "description": "State inscription. Used for corporate clients.",
-                          "nullable": true
-                        },
-                        "corporatePhone": {
-                          "type": "string",
-                          "description": "Telephone number. Used for corporate clients.",
-                          "nullable": true
-                        },
-                        "isCorporate": {
-                          "type": "boolean",
-                          "description": "Indicates whether client is corporate.",
-                          "default": false
-                        },
-                        "profileCompleteOnLoading": {
-                          "type": "string",
-                          "description": "Profile complete when loading.",
-                          "nullable": true
-                        },
-                        "profileErrorOnLoading": {
-                          "type": "string",
-                          "description": "Profile error when loading.",
-                          "nullable": true
-                        },
-                        "customerClass": {
-                          "type": "string",
-                          "description": "Customer class.",
-                          "nullable": true
-                        }
-                      }
-                    },
-                    "isComplete": {
-                      "type": "boolean",
-                      "description": "Indicates whether customer profile is complete."
-                    }
-                  }
-                },
-                "example": {
-                  "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
-                  "profileProvider": "VTEX",
-                  "availableAccounts": [],
-                  "availableAddresses": [
-                    {
-                      "addressType": "residential",
-                      "receiverName": "Clark Kent",
-                      "addressId": "666c2e830bd9474ab6f6cc53fb6dd2d2",
-                      "isDisposable": false,
-                      "postalCode": "12345-000",
-                      "city": "Metropolis",
-                      "state": "NY",
-                      "country": "USA",
-                      "street": "My street",
-                      "number": "123",
-                      "neighborhood": "My neighborhood",
-                      "complement": null,
-                      "reference": null,
-                      "geoCoordinates": [
-                        -47.924747467041016,
-                        -15.832582473754883
-                      ]
-                    }
-                  ],
-                  "userProfile": {
-                    "email": "clark.kent@example.com",
-                    "firstName": "Clark",
-                    "lastName": "Kent",
-                    "document": "12345678900",
-                    "documentType": "cpf",
-                    "phone": "+556199999999",
-                    "corporateName": null,
-                    "tradeName": null,
-                    "corporateDocument": null,
-                    "stateInscription": null,
-                    "corporatePhone": null,
-                    "isCorporate": false,
-                    "profileCompleteOnLoading": null,
-                    "profileErrorOnLoading": null,
-                    "customerClass": null
-                  },
-                  "isComplete": true
-                }
-              }
-            }
-          }
-        },
-        "deprecated": false
-      }
-    },
-    "/api/checkout/pub/orderForm/{orderFormId}/attachments/clientProfileData": {
-      "post": {
-        "tags": [
-          "Cart attachments"
-        ],
-        "summary": "Add client profile",
-        "description": "Use this request to include client profile information to a given shopping cart.\r\n\r\nThe [orderForm](https://developers.vtex.com/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.\n\r\n\r> This request has a time out of 12 seconds.\r\n\r\n>⚠️ 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.",
-        "operationId": "AddClientProfile",
-        "security": [],
-        "parameters": [
-          {
-            "name": "Content-Type",
-            "in": "header",
-            "description": "Type of the content being sent.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "Accept",
-            "in": "header",
-            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "orderFormId",
-            "in": "path",
-            "description": "ID of the orderForm that will receive client profile information.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string"
-            }
-          }
-        ],
-        "requestBody": {
-          "content": {
-            "application/json": {
-              "schema": {
-                "type": "object",
-                "description": "Customer's profile information.",
-                "required": [
-                  "email",
-                  "firstName",
-                  "lastName",
-                  "documentType",
-                  "document"
-                ],
-                "properties": {
-                  "email": {
-                    "type": "string",
-                    "description": "Customer's email address.",
-                    "default": "customer@examplemail.com"
-                  },
-                  "firstName": {
-                    "type": "string",
-                    "description": "Customer's first name.",
-                    "default": "first-name"
-                  },
-                  "lastName": {
-                    "type": "string",
-                    "description": "Customer's last name.",
-                    "default": "last-name"
-                  },
-                  "documentType": {
-                    "type": "string",
-                    "description": "Type of the document informed by the customer.",
-                    "default": "cpf"
-                  },
-                  "document": {
-                    "type": "string",
-                    "description": "Document number informed by the customer.",
-                    "default": "123456789"
-                  },
-                  "phone": {
-                    "type": "string",
-                    "description": "Customer's phone number.",
-                    "default": "+55110988887777"
-                  },
-                  "corporateName": {
-                    "type": "string",
-                    "description": "Company name, if the customer is a legal entity.",
-                    "default": "company-name"
-                  },
-                  "tradeName": {
-                    "type": "string",
-                    "description": "Trade name, if the customer is a legal entity.",
-                    "default": "trade-name"
-                  },
-                  "corporateDocument": {
-                    "type": "string",
-                    "description": "Corporate document, if the customer is a legal entity.",
-                    "default": "12345678000100"
-                  },
-                  "stateInscription": {
-                    "type": "string",
-                    "description": "State inscription, if the customer is a legal entity.",
-                    "default": "12345678"
-                  },
-                  "corporatePhone": {
-                    "type": "string",
-                    "description": "Corporate phone number, if the customer is a legal entity.",
-                    "default": "+551100988887777"
-                  },
-                  "isCorporate": {
-                    "type": "boolean",
-                    "description": "`true` if the customer is a legal entity.",
-                    "default": false
-                  }
-                }
-              }
-            }
-          },
-          "required": true
-        },
-        "responses": {
-          "200": {
-            "description": "OK",
-            "headers": {},
-            "content": {
-              "application/json": {
-                "example": {
-                  "orderFormId": "9ceee0fde6db489fbc809a0e2ab13a86",
-                  "salesChannel": "1",
-                  "loggedIn": false,
-                  "isCheckedIn": false,
-                  "storeId": null,
-                  "checkedInPickupPointId": null,
-                  "allowManualPrice": false,
-                  "canEditData": true,
-                  "userProfileId": null,
-                  "userType": null,
-                  "ignoreProfileData": false,
-                  "value": 0,
-                  "messages": [],
-                  "items": [],
-                  "selectableGifts": [],
-                  "totalizers": [],
-                  "shippingData": null,
-                  "clientProfileData": {
-                    "email": "clark.kent@examplemail.com",
-                    "firstName": "Clark",
-                    "lastName": "Kent",
-                    "document": "44444444444",
-                    "documentType": "cpf",
-                    "phone": "+5511123456789",
-                    "corporateName": null,
-                    "tradeName": null,
-                    "corporateDocument": null,
-                    "stateInscription": null,
-                    "corporatePhone": null,
-                    "isCorporate": false,
-                    "profileCompleteOnLoading": false,
-                    "profileErrorOnLoading": false,
-                    "customerClass": null
-                  },
-                  "paymentData": {
-                    "updateStatus": "updated",
-                    "installmentOptions": [],
-                    "paymentSystems": [],
-                    "payments": [],
-                    "giftCards": [],
-                    "giftCardMessages": [],
-                    "availableAccounts": [],
-                    "availableTokens": []
-                  },
-                  "marketingData": null,
-                  "sellers": [],
-                  "clientPreferencesData": {
-                    "locale": "pt-BR",
-                    "optinNewsLetter": null
-                  },
-                  "commercialConditionData": null,
-                  "storePreferencesData": {
-                    "countryCode": "BRA",
-                    "saveUserData": true,
-                    "timeZone": "E. South America Standard Time",
-                    "currencyCode": "BRL",
-                    "currencyLocale": 1046,
-                    "currencySymbol": "R$",
-                    "currencyFormatInfo": {
-                      "currencyDecimalDigits": 2,
-                      "currencyDecimalSeparator": ",",
-                      "currencyGroupSeparator": ".",
-                      "currencyGroupSize": 3,
-                      "startsWithCurrencySymbol": true
-                    }
-                  },
-                  "giftRegistryData": null,
-                  "openTextField": null,
-                  "invoiceData": null,
-                  "customData": null,
-                  "itemMetadata": null,
-                  "hooksData": null,
-                  "ratesAndBenefitsData": null,
-                  "subscriptionData": null,
-                  "itemsOrdination": null
-                }
-              }
-            }
-          }
-        },
-        "deprecated": false
-      }
-    },
-    "/api/checkout/pub/orderForm/{orderFormId}/attachments/shippingData": {
-      "post": {
-        "tags": [
-          "Cart attachments"
-        ],
-        "summary": "Add shipping address and select delivery option",
-        "description": "Use this request to include shipping information and/or selected delivery option to a given shopping cart.\r\n\r\nTo add shipping addresses send the `selectedAddresses` array. For delivery option use the `logisticsInfo` array.\r\n\r\nThe [orderForm](https://developers.vtex.com/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.\n\r\n\r> This request has a time out of 12 seconds.\r\n\r\n>⚠️ 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.",
-        "operationId": "AddShippingAddress",
-        "security": [],
-        "parameters": [
-          {
-            "name": "Content-Type",
-            "in": "header",
-            "description": "Type of the content being sent.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "Accept",
-            "in": "header",
-            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "orderFormId",
-            "in": "path",
-            "description": "ID of the orderForm that will receive client profile information.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string"
-            }
-          }
-        ],
-        "requestBody": {
-          "content": {
-            "application/json": {
-              "schema": {
-                "type": "object",
-                "properties": {
-                  "clearAddressIfPostalCodeNotFound": {
-                    "type": "boolean",
-                    "description": "This field should be sent as `false` to prevent the address information from being filled in automatically based on the `postalCode` information.",
-                    "example": false
-                  },
-                  "selectedAddresses": {
-                    "type": "array",
-                    "description": "List of objects with addresses information.",
-                    "items": {
-                      "type": "object",
-                      "properties": {
-                        "addressType": {
-                          "type": "string",
-                          "description": "Type of address. For example, `Residential` or `Pickup`, among others.",
-                          "example": "residential"
-                        },
-                        "receiverName": {
-                          "type": "string",
-                          "description": "Name of the person who is going to receive the order.",
-                          "example": "receiver name"
-                        },
-                        "addressId": {
-                          "type": "string",
-                          "description": "Address ID.",
-                          "example": "c3701fc4c61b4d1b91f67e81415db44d"
-                        },
-                        "postalCode": {
-                          "type": "string",
-                          "description": "Postal Code.",
-                          "example": "12345-000"
-                        },
-                        "city": {
-                          "type": "string",
-                          "description": "City of the shipping address.",
-                          "example": "Rio de Janeiro"
-                        },
-                        "state": {
-                          "type": "string",
-                          "description": "State of the shipping address.",
-                          "example": "RJ"
-                        },
-                        "country": {
-                          "type": "string",
-                          "description": "Three letter ISO code of the country of the shipping address.",
-                          "example": "BRA"
-                        },
-                        "street": {
-                          "type": "string",
-                          "description": "Street of the shipping address.",
-                          "example": "Praia de Botafogo"
-                        },
-                        "number": {
-                          "type": "string",
-                          "description": "Number of the building, house or apartment in the shipping address.",
-                          "example": "300"
-                        },
-                        "neighborhood": {
-                          "type": "string",
-                          "description": "Neighborhood of the shipping address.",
-                          "example": "Botafogo"
-                        },
-                        "complement": {
-                          "type": "string",
-                          "description": "Complement to the shipping address in case it applies.",
-                          "example": "3rd floor"
-                        },
-                        "reference": {
-                          "type": "string",
-                          "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
-                          "example": "Grey building"
-                        },
-                        "geoCoordinates": {
-                          "type": "array",
-                          "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
-                          "default": [
-                            -47.924747467041016,
-                            -15.832582473754883
-                          ],
-                          "items": {
-                            "type": "number",
-                            "example": -47.924747467041016
-                          }
-                        }
-                      }
-                    }
-                  },
-                  "logisticsInfo": {
-                    "type": "array",
-                    "description": "Array with logistics information on each item of the `items` array in the `orderForm`.",
-                    "items": {
-                      "type": "object",
-                      "properties": {
-                        "itemIndex": {
-                          "type": "integer",
-                          "description": "Index of item in items array",
-                          "example": 0
-                        },
-                        "selectedDeliveryChannel": {
-                          "type": "string",
-                          "description": "Delivery channel selected by the customer. For example, `\"delivery\"` or `\"pickup-in-point\"`.",
-                          "example": "delivery"
-                        },
-                        "selectedSla": {
-                          "type": "string",
-                          "description": "Selected SLA. For example, `\"normal\"` or `\"express\"`.",
-                          "example": "normal"
-                        }
-                      }
-                    }
-                  }
-                }
-              }
-            }
-          },
-          "required": true
-        },
-        "responses": {
-          "200": {
-            "description": "OK",
-            "headers": {},
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "object",
-                  "properties": {
-                    "orderFormId": {
-                      "type": "string",
-                      "description": "ID of the `orderForm` corresponding to a specific cart."
-                    },
-                    "salesChannel": {
-                      "type": "string",
-                      "description": "Attribute created by the seller, in their VTEX store configuration."
-                    },
-                    "loggedIn": {
-                      "type": "boolean",
-                      "description": "Indicates whether the user is logged into the store."
-                    },
-                    "isCheckedIn": {
-                      "type": "boolean",
-                      "description": "Indicates whether order is checked in."
-                    },
-                    "storeId": {
-                      "type": "string",
-                      "description": "ID of the store.",
-                      "nullable": true
-                    },
-                    "checkedInPickupPointId": {
-                      "type": "string",
-                      "description": "Checked in pickuppoint identification.",
-                      "nullable": true
-                    },
-                    "allowManualPrice": {
-                      "type": "boolean",
-                      "description": "Permission to modify item price manually."
-                    },
-                    "canEditData": {
-                      "type": "boolean",
-                      "description": "Data can be edited."
-                    },
-                    "userProfileId": {
-                      "type": "string",
-                      "description": "Unique ID associated with the customer profile.",
-                      "nullable": true
-                    },
-                    "userType": {
-                      "type": "string",
-                      "description": "User type.",
-                      "nullable": true
-                    },
-                    "ignoreProfileData": {
-                      "type": "boolean",
-                      "description": "Ignore customer profile data."
-                    },
-                    "value": {
-                      "type": "integer",
-                      "description": "Total value of the order without separating cents. For example, $24.99 is represented `2499`."
-                    },
-                    "messages": {
-                      "type": "array",
-                      "description": "Array containing an object for each message generated by our servers while processing the request."
-                    },
-                    "items": {
-                      "type": "array",
-                      "description": "Information on each item in the order.",
-                      "items": {
-                        "type": "object",
-                        "properties": {
-                          "uniqueId": {
-                            "type": "string",
-                            "description": "Unique ID."
-                          },
-                          "id": {
-                            "type": "string",
-                            "description": "ID of the item."
-                          },
-                          "productId": {
-                            "type": "string",
-                            "description": "Product ID."
-                          },
-                          "productRefId": {
-                            "type": "string",
-                            "description": "Product Ref ID."
-                          },
-                          "refId": {
-                            "type": "string",
-                            "description": "Ref ID."
-                          },
-                          "ean": {
-                            "type": "string",
-                            "description": "European Article Number.",
-                            "nullable": true
-                          },
-                          "name": {
-                            "type": "string",
-                            "description": "Product name."
-                          },
-                          "skuName": {
-                            "type": "string",
-                            "description": "SKU name."
-                          },
-                          "modalType": {
-                            "type": "string",
-                            "description": "Modal type.",
-                            "nullable": true
-                          },
-                          "parentItemIndex": {
-                            "type": "integer",
-                            "description": "Parent item index.",
-                            "nullable": true
-                          },
-                          "parentAssemblyBinding": {
-                            "type": "string",
-                            "description": "Parent assembly binding.",
-                            "nullable": true
-                          },
-                          "priceValidUntil": {
-                            "type": "string",
-                            "description": "Price expiration date and time."
-                          },
-                          "tax": {
-                            "type": "integer",
-                            "description": "Tax value in cents."
-                          },
-                          "price": {
-                            "type": "integer",
-                            "description": "Price in cents."
-                          },
-                          "listPrice": {
-                            "type": "integer",
-                            "description": "List price in cents."
-                          },
-                          "manualPrice": {
-                            "type": "integer",
-                            "description": "Manual price in cents.",
-                            "nullable": true
-                          },
-                          "manualPriceAppliedBy": {
-                            "type": "string",
-                            "description": "User that applied the manual price, if that is the case.",
-                            "nullable": true
-                          },
-                          "sellingPrice": {
-                            "type": "integer",
-                            "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
-                          },
-                          "rewardValue": {
-                            "type": "integer",
-                            "description": "Reward value in cents."
-                          },
-                          "isGift": {
-                            "type": "boolean",
-                            "description": "Indicates whether item is a gift."
-                          },
-                          "additionalInfo": {
-                            "type": "object",
-                            "description": "Additional information.",
-                            "properties": {
-                              "dimension": {
-                                "type": "string",
-                                "description": "Dimension.",
-                                "nullable": true
-                              },
-                              "brandName": {
-                                "type": "string",
-                                "description": "Brand name."
-                              },
-                              "brandId": {
-                                "type": "string",
-                                "description": "Brand ID."
-                              },
-                              "offeringInfo": {
-                                "type": "string",
-                                "description": "Offering information.",
-                                "nullable": true
-                              },
-                              "offeringType": {
-                                "type": "string",
-                                "description": "Offering type.",
-                                "nullable": true
-                              },
-                              "offeringTypeId": {
-                                "type": "string",
-                                "description": "Offering type ID.",
-                                "nullable": true
-                              }
-                            }
-                          },
-                          "preSaleDate": {
-                            "type": "string",
-                            "description": "Presale date.",
-                            "nullable": true
-                          },
-                          "productCategoryIds": {
-                            "type": "string",
-                            "description": "Product category IDs."
-                          },
-                          "productCategories": {
-                            "type": "object",
-                            "description": "Object, where each field is an ID from `productCategoryIds`.",
-                            "properties": {
-                              "{ID}": {
-                                "type": "string",
-                                "description": "Product category corresponding to the ID in the field key."
-                              }
-                            }
-                          },
-                          "quantity": {
-                            "type": "integer",
-                            "description": "Quantity."
-                          },
-                          "seller": {
-                            "type": "string",
-                            "description": "Seller."
-                          },
-                          "sellerChain": {
-                            "type": "array",
-                            "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
-                            "items": {
-                              "type": "string",
-                              "description": "Seller."
-                            }
-                          },
-                          "imageUrl": {
-                            "type": "string",
-                            "description": "Image URL."
-                          },
-                          "detailUrl": {
-                            "type": "string",
-                            "description": "Detail URL."
-                          },
-                          "bundleItems": {
-                            "type": "array",
-                            "description": "Information on services sold along with the SKU. Example: a gift package.",
-                            "items": {
-                              "type": "object",
-                              "properties": {
-                                "type": {
-                                  "type": "string",
-                                  "description": "Service type."
-                                },
-                                "id": {
-                                  "type": "integer",
-                                  "description": "Service identifier."
-                                },
-                                "name": {
-                                  "type": "string",
-                                  "description": "Service name."
-                                },
-                                "price": {
-                                  "type": "integer",
-                                  "description": "Service price in cents."
-                                }
-                              }
-                            }
-                          },
-                          "attachments": {
-                            "type": "array",
-                            "description": "Array containing information on attachments.",
-                            "items": {
-                              "type": "string"
-                            }
-                          },
-                          "priceTags": {
-                            "type": "array",
-                            "description": "Array of price tags, each of which, modifies the price in some way, like discounts or rates that apply to the item in the context of the order.",
-                            "items": {
-                              "type": "object",
-                              "properties": {
-                                "identifier": {
-                                  "type": "string",
-                                  "description": "Price tag identifier."
-                                },
-                                "isPercentual": {
-                                  "type": "boolean",
-                                  "description": "Indicates whether price tag value is applied through a percentage."
-                                },
-                                "name": {
-                                  "type": "string",
-                                  "description": "Price tag name."
-                                },
-                                "rawValue": {
-                                  "type": "integer",
-                                  "description": "Price tag raw value."
-                                },
-                                "value": {
-                                  "type": "integer",
-                                  "description": "Price tag value."
-                                }
-                              }
-                            }
-                          },
-                          "availability": {
-                            "type": "string",
-                            "description": "Availability."
-                          },
-                          "measurementUnit": {
-                            "type": "string",
-                            "description": "Measurement unit."
-                          },
-                          "unitMultiplier": {
-                            "type": "integer",
-                            "description": "Unit multiplier."
-                          },
-                          "manufacturerCode": {
-                            "type": "string",
-                            "description": "Manufacturer code.",
-                            "nullable": true
-                          },
-                          "priceDefinition": {
-                            "type": "object",
-                            "description": "Price information for all units of a specific item.",
-                            "properties": {
-                              "calculatedSellingPrice": {
-                                "type": "integer",
-                                "description": "Item's calculated unitary selling price in cents."
-                              },
-                              "total": {
-                                "type": "integer",
-                                "description": "Total value for all units of the item in cents."
-                              },
-                              "sellingPrices": {
-                                "type": "array",
-                                "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
-                                "items": {
-                                  "type": "object",
-                                  "properties": {
-                                    "value": {
-                                      "type": "integer",
-                                      "description": "Value in cents for that specific rounding."
-                                    },
-                                    "quantity": {
-                                      "type": "integer",
-                                      "description": "Rounding quantity, meaning how many items are rounded to this value."
-                                    }
-                                  }
-                                }
-                              }
-                            }
-                          }
-                        }
-                      }
-                    },
-                    "selectableGifts": {
-                      "type": "array",
-                      "description": "Array containing the data of the item selected as a gift."
-                    },
-                    "totalizers": {
-                      "type": "array",
-                      "description": "Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value)."
-                    },
-                    "shippingData": {
-                      "type": "object",
-                      "description": "Shipping information pertinent to the order.",
-                      "properties": {
-                        "address": {
-                          "type": "object",
-                          "description": "Address information.",
-                          "properties": {
-                            "addressType": {
-                              "type": "string",
-                              "description": "Type of address. For example, `Residential` or `Pickup`."
-                            },
-                            "receiverName": {
-                              "type": "string",
-                              "description": "Name of the person who is going to receive the order."
-                            },
-                            "addressId": {
-                              "type": "string",
-                              "description": "Address ID."
-                            },
-                            "isDisposable": {
-                              "type": "boolean",
-                              "description": "Indicates whether address is disposable."
-                            },
-                            "postalCode": {
-                              "type": "string",
-                              "description": "Postal code."
-                            },
-                            "city": {
-                              "type": "string",
-                              "description": "City of the shipping address."
-                            },
-                            "state": {
-                              "type": "string",
-                              "description": "State of the shipping address."
-                            },
-                            "country": {
-                              "type": "string",
-                              "description": "Three letter ISO code of the country of the shipping address."
-                            },
-                            "street": {
-                              "type": "string",
-                              "description": "Street of the shipping address."
-                            },
-                            "number": {
-                              "type": "string",
-                              "description": "Number of the building, house or apartment in the shipping address."
-                            },
-                            "neighborhood": {
-                              "type": "string",
-                              "description": "Neighborhood of the shipping address."
-                            },
-                            "complement": {
-                              "type": "string",
-                              "description": "Complement to the shipping address, in case it applies.",
-                              "nullable": true
-                            },
-                            "reference": {
-                              "type": "string",
-                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
-                              "nullable": true
-                            },
-                            "geoCoordinates": {
-                              "type": "array",
-                              "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
-                              "items": {
-                                "type": "number"
-                              }
-                            }
-                          }
-                        },
-                        "logisticsInfo": {
-                          "type": "array",
-                          "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "itemIndex": {
-                                "type": "integer",
-                                "description": "Index corresponding to the position of the object in the `items` array."
-                              },
-                              "selectedSla": {
-                                "type": "string",
-                                "description": "SLA selected by the customer.",
-                                "nullable": true
-                              },
-                              "selectedDeliveryChannel": {
-                                "type": "string",
-                                "description": "Delivery channel selected by the customer.",
-                                "nullable": true
-                              },
-                              "addressId": {
-                                "type": "string",
-                                "description": "Address ID."
-                              },
-                              "slas": {
-                                "type": "array",
-                                "description": "Information on available SLAs.",
-                                "items": {
-                                  "type": "object",
-                                  "properties": {
-                                    "id": {
-                                      "type": "string",
-                                      "description": "SLA ID."
-                                    },
-                                    "deliveryChannel": {
-                                      "type": "string",
-                                      "description": "Delivery channel."
-                                    },
-                                    "name": {
-                                      "type": "string",
-                                      "description": "SLA name."
-                                    },
-                                    "deliveryIds": {
-                                      "type": "array",
-                                      "description": "Information on each delivery ID.",
-                                      "items": {
-                                        "type": "object",
-                                        "properties": {
-                                          "courierId": {
-                                            "type": "string",
-                                            "description": "Courier ID."
-                                          },
-                                          "warehouseId": {
-                                            "type": "string",
-                                            "description": "Warehouse ID."
-                                          },
-                                          "dockId": {
-                                            "type": "string",
-                                            "description": "Warehouse ID."
-                                          },
-                                          "courierName": {
-                                            "type": "string",
-                                            "description": "Courier name."
-                                          },
-                                          "quantity": {
-                                            "type": "integer",
-                                            "description": "Quantity."
-                                          }
-                                        }
-                                      }
-                                    },
-                                    "shippingEstimate": {
-                                      "type": "string",
-                                      "description": "Shipping estimate. For instance, Three business days will be represented `3bd`."
-                                    },
-                                    "shippingEstimateDate": {
-                                      "type": "string",
-                                      "description": "Shipping estimate date.",
-                                      "nullable": true
-                                    },
-                                    "lockTTL": {
-                                      "type": "string",
-                                      "description": "Estimate date of delivery.",
-                                      "nullable": true
-                                    },
-                                    "availableDeliveryWindows": {
-                                      "type": "object",
-                                      "description": "This object contains information about the delivery window available to the shopper.",
-                                      "properties": {
-                                        "startDateUtc": {
-                                          "type": "string",
-                                          "description": "Delivery window starting day and time in UTC."
-                                        },
-                                        "endDateUtc": {
-                                          "type": "string",
-                                          "description": "Delivery window ending day and time in UTC."
-                                        },
-                                        "price": {
-                                          "type": "integer",
-                                          "description": "Delivery window price."
-                                        },
-                                        "lisPrice": {
-                                          "type": "integer",
-                                          "description": "Delivery window list price."
-                                        },
-                                        "tax": {
-                                          "type": "integer",
-                                          "description": "Delivery window tax."
-                                        }
-                                      }
-                                    },
-                                    "deliveryWindow": {
-                                      "type": "object",
-                                      "description": "In case of scheduled delivery, this object will contain information on the delivery window selected by the shopper.",
-                                      "properties": {
-                                        "startDateUtc": {
-                                          "type": "string",
-                                          "description": "Delivery window starting day and time in UTC."
-                                        },
-                                        "endDateUtc": {
-                                          "type": "string",
-                                          "description": "Delivery window ending day and time in UTC."
-                                        },
-                                        "price": {
-                                          "type": "integer",
-                                          "description": "Delivery window price."
-                                        },
-                                        "lisPrice": {
-                                          "type": "integer",
-                                          "description": "Delivery window list price."
-                                        },
-                                        "tax": {
-                                          "type": "integer",
-                                          "description": "Delivery window tax."
-                                        }
-                                      }
-                                    },
-                                    "price": {
-                                      "type": "integer",
-                                      "description": "Price in cents."
-                                    },
-                                    "listPrice": {
-                                      "type": "integer",
-                                      "description": "List price in cents."
-                                    },
-                                    "tax": {
-                                      "type": "integer",
-                                      "description": "Tax in cents."
-                                    },
-                                    "pickupStoreInfo": {
-                                      "type": "object",
-                                      "description": "Information on the pickup store.",
-                                      "properties": {
-                                        "isPickupStore": {
-                                          "type": "boolean",
-                                          "description": "Indicates whether it is the pickup store."
-                                        },
-                                        "friendlyName": {
-                                          "type": "string",
-                                          "description": "Friendly name.",
-                                          "nullable": true
-                                        },
-                                        "address": {
-                                          "type": "object",
-                                          "description": "Address information.",
-                                          "nullable": true,
-                                          "properties": {
-                                            "addressType": {
-                                              "type": "string",
-                                              "description": "Type of address. For example, `Residential` or `Pickup`."
-                                            },
-                                            "receiverName": {
-                                              "type": "string",
-                                              "description": "Name of the person who is going to receive the order."
-                                            },
-                                            "addressId": {
-                                              "type": "string",
-                                              "description": "Address ID."
-                                            },
-                                            "isDisposable": {
-                                              "type": "boolean",
-                                              "description": "Indicates whether address is disposable."
-                                            },
-                                            "postalCode": {
-                                              "type": "string",
-                                              "description": "Postal code."
-                                            },
-                                            "city": {
-                                              "type": "string",
-                                              "description": "City of the shipping address."
-                                            },
-                                            "state": {
-                                              "type": "string",
-                                              "description": "State of the shipping address."
-                                            },
-                                            "country": {
-                                              "type": "string",
-                                              "description": "Three letter ISO code of the country of the shipping address."
-                                            },
-                                            "street": {
-                                              "type": "string",
-                                              "description": "Street of the shipping address."
-                                            },
-                                            "number": {
-                                              "type": "string",
-                                              "description": "Number of the building, house or apartment in the shipping address."
-                                            },
-                                            "neighborhood": {
-                                              "type": "string",
-                                              "description": "Neighborhood of the shipping address."
-                                            },
-                                            "complement": {
-                                              "type": "string",
-                                              "description": "Complement to the shipping address, in case it applies.",
-                                              "nullable": true
-                                            },
-                                            "reference": {
-                                              "type": "string",
-                                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
-                                              "nullable": true
-                                            },
-                                            "geoCoordinates": {
-                                              "type": "array",
-                                              "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
-                                              "items": {
-                                                "type": "number"
-                                              }
-                                            }
-                                          }
-                                        },
-                                        "additionalInfo": {
-                                          "type": "string",
-                                          "description": "Additional information.",
-                                          "nullable": true
-                                        },
-                                        "dockId": {
-                                          "type": "string",
-                                          "description": "Corresponding dock ID.",
-                                          "nullable": true
-                                        }
-                                      }
-                                    },
-                                    "pickupPointId": {
-                                      "type": "string",
-                                      "description": "Pickup point ID.",
-                                      "nullable": true
-                                    },
-                                    "pickupDistance": {
-                                      "type": "integer",
-                                      "description": "Pickup point distance."
-                                    },
-                                    "polygonName": {
-                                      "type": "string",
-                                      "description": "Polygon name.",
-                                      "nullable": true
-                                    },
-                                    "transitTime": {
-                                      "type": "string",
-                                      "description": "Transit time. For instance, \"three business days\" is represented `3bd`."
-                                    }
-                                  }
-                                }
-                              },
-                              "shipsTo": {
-                                "type": "array",
-                                "description": "List of countries that the item may be shipped to.",
-                                "items": {
-                                  "type": "string",
-                                  "description": "Three letter country code."
-                                }
-                              },
-                              "itemId": {
-                                "type": "string",
-                                "description": "Item ID."
-                              },
-                              "deliveryChannels": {
-                                "type": "array",
-                                "description": "List of available delivery channels.",
-                                "items": {
-                                  "type": "object",
-                                  "properties": {
-                                    "id": {
-                                      "type": "string",
-                                      "description": "Delivery channel ID."
-                                    }
-                                  }
-                                }
-                              }
-                            }
-                          }
-                        },
-                        "selectedAddresses": {
-                          "type": "array",
-                          "description": "Array with information on the selected addresses for the order.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "addressType": {
-                                "type": "string",
-                                "description": "Type of address. For example, `Residential` or `Pickup`."
-                              },
-                              "receiverName": {
-                                "type": "string",
-                                "description": "Name of the person who is going to receive the order."
-                              },
-                              "addressId": {
-                                "type": "string",
-                                "description": "Address ID."
-                              },
-                              "isDisposable": {
-                                "type": "boolean",
-                                "description": "Indicates whether address is disposable."
-                              },
-                              "postalCode": {
-                                "type": "string",
-                                "description": "Postal code."
-                              },
-                              "city": {
-                                "type": "string",
-                                "description": "City of the shipping address."
-                              },
-                              "state": {
-                                "type": "string",
-                                "description": "State of the shipping address."
-                              },
-                              "country": {
-                                "type": "string",
-                                "description": "Three letter ISO code of the country of the shipping address."
-                              },
-                              "street": {
-                                "type": "string",
-                                "description": "Street of the shipping address."
-                              },
-                              "number": {
-                                "type": "string",
-                                "description": "Number of the building, house or apartment in the shipping address."
-                              },
-                              "neighborhood": {
-                                "type": "string",
-                                "description": "Neighborhood of the shipping address."
-                              },
-                              "complement": {
-                                "type": "string",
-                                "description": "Complement to the shipping address, in case it applies.",
-                                "nullable": true
-                              },
-                              "reference": {
-                                "type": "string",
-                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
-                                "nullable": true
-                              },
-                              "geoCoordinates": {
-                                "type": "array",
-                                "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
-                                "items": {
-                                  "type": "number"
-                                }
-                              }
-                            }
-                          }
-                        },
-                        "availableAddresses": {
-                          "type": "array",
-                          "description": "Information on each available address.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "addressType": {
-                                "type": "string",
-                                "description": "Address type."
-                              },
-                              "receiverName": {
-                                "type": "string",
-                                "description": "Name of the receiver."
-                              },
-                              "addressId": {
-                                "type": "string",
-                                "description": "Address ID."
-                              },
-                              "isDisposable": {
-                                "type": "boolean",
-                                "description": "Indicates whether address is disposable."
-                              },
-                              "city": {
-                                "type": "string",
-                                "description": "City of the address."
-                              },
-                              "state": {
-                                "type": "string",
-                                "description": "State of the address."
-                              },
-                              "country": {
-                                "type": "string",
-                                "description": "Country of the address. ISO three-letter code."
-                              },
-                              "street": {
-                                "type": "string",
-                                "description": "Street of the address."
-                              },
-                              "number": {
-                                "type": "string",
-                                "description": "Number of the address."
-                              },
-                              "neighborhood": {
-                                "type": "string",
-                                "description": "Neighborhood of the address."
-                              },
-                              "complement": {
-                                "type": "string",
-                                "description": "Complement to the address.",
-                                "nullable": true
-                              },
-                              "reference": {
-                                "type": "string",
-                                "description": "Reference that may help in the location of the address.",
-                                "nullable": true
-                              },
-                              "geoCoordinates": {
-                                "type": "array",
-                                "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
-                                "items": {
-                                  "type": "number",
-                                  "description": "Items information."
-                                }
-                              }
-                            }
-                          }
-                        },
-                        "pickupPoints": {
-                          "type": "array",
-                          "description": "Array containing pickup points information."
-                        }
-                      }
-                    },
-                    "clientProfileData": {
-                      "type": "object",
-                      "description": "Customer's profile information.",
-                      "properties": {
-                        "email": {
-                          "type": "string",
-                          "description": "Email address."
-                        },
-                        "firstName": {
-                          "type": "string",
-                          "description": "First name."
-                        },
-                        "lastName": {
-                          "type": "string",
-                          "description": "Last name."
-                        },
-                        "documentType": {
-                          "type": "string",
-                          "description": "Type of the document informed by the customer."
-                        },
-                        "document": {
-                          "type": "string",
-                          "description": "Document informed by the customer."
-                        },
-                        "phone": {
-                          "type": "string",
-                          "description": "Phone number."
-                        },
-                        "corporateName": {
-                          "type": "string",
-                          "description": "Company name, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "tradeName": {
-                          "type": "string",
-                          "description": "Trade name, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "corporateDocument": {
-                          "type": "string",
-                          "description": "Corporate document, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "stateInscription": {
-                          "type": "string",
-                          "description": "State inscription, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "corporatePhone": {
-                          "type": "string",
-                          "description": "Corporate phone number, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "isCorporate": {
-                          "type": "boolean",
-                          "description": "Indicates whether the customer is a legal entity."
-                        },
-                        "profileCompleteOnLoading": {
-                          "type": "boolean",
-                          "description": "Indicates whether profile is complete on loading."
-                        },
-                        "profileErrorOnLoading": {
-                          "type": "boolean",
-                          "description": "Indicates whether profile presents error on loading.",
-                          "nullable": true
-                        },
-                        "customerClass": {
-                          "type": "string",
-                          "description": "Customer class.",
-                          "nullable": true
-                        }
-                      }
-                    },
-                    "paymentData": {
-                      "type": "object",
-                      "description": "Payment data information.",
-                      "properties": {
-                        "updateStatus": {
-                          "type": "string",
-                          "description": "Indicate whether this object's information is up to date according to the order's items. An order can not be placed if `\"outdated\"`"
-                        },
-                        "installmentOptions": {
-                          "type": "array",
-                          "description": "Installment options information.",
-                          "properties": {
-                            "paymentSystem": {
-                              "type": "integer",
-                              "description": "Payment system identification."
-                            },
-                            "bin": {
-                              "type": "string",
-                              "description": "Bin.",
-                              "nullable": true
-                            },
-                            "paymentName": {
-                              "type": "string",
-                              "description": "Payment name."
-                            },
-                            "paymentGroupName": {
-                              "type": "string",
-                              "description": "Payment group name."
-                            },
-                            "value": {
-                              "type": "integer",
-                              "description": "Total value assigned to this payment."
-                            },
-                            "installments": {
-                              "type": "array",
-                              "description": "Installments information.",
-                              "properties": {
-                                "count": {
-                                  "type": "integer",
-                                  "description": "Count information."
-                                },
-                                "hasInterestRate": {
-                                  "type": "boolean",
-                                  "description": "Indicates whether the payment has interest."
-                                },
-                                "interestRate": {
-                                  "type": "integer",
-                                  "description": "Interest rate value."
-                                },
-                                "value": {
-                                  "type": "integer",
-                                  "description": "Value of the order without the interest rate. The value is shown without separating cents."
-                                },
-                                "total": {
-                                  "type": "integer",
-                                  "description": "Total value of the order without separating cents. For example, $24.99 is represented `2499`."
-                                },
-                                "sellerMerchantInstallments": {
-                                  "type": "array",
-                                  "description": "Seller merchant installments information."
-                                }
-                              }
-                            }
-                          }
-                        },
-                        "paymentSystems": {
-                          "type": "array",
-                          "description": "Information on payment systems.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "id": {
-                                "type": "integer",
-                                "description": "Payment system ID."
-                              },
-                              "name": {
-                                "type": "string",
-                                "description": "Payment system name."
-                              },
-                              "groupName": {
-                                "type": "string",
-                                "description": "Payment group name."
-                              },
-                              "validator": {
-                                "type": "object",
-                                "description": "Payment system validator.",
-                                "nullable": true
-                              },
-                              "stringId": {
-                                "type": "string",
-                                "description": "String ID."
-                              },
-                              "template": {
-                                "type": "string",
-                                "description": "Template."
-                              },
-                              "requiresDocument": {
-                                "type": "boolean",
-                                "description": "Indicates whether a document is required."
-                              },
-                              "displayDocument": {
-                                "type": "boolean",
-                                "description": "Indicates whether a document is shown."
-                              },
-                              "isCustom": {
-                                "type": "boolean",
-                                "description": "Indicates whether it is custom."
-                              },
-                              "description": {
-                                "type": "string",
-                                "description": "Description."
-                              },
-                              "requiresAuthentication": {
-                                "type": "boolean",
-                                "description": "Indicates whether a authentication is required."
-                              },
-                              "dueDate": {
-                                "type": "string",
-                                "description": "Payment due date."
-                              },
-                              "availablePayments": {
-                                "type": "string",
-                                "description": "Availability of payment.",
-                                "nullable": true
-                              }
-                            }
-                          }
-                        },
-                        "payments": {
-                          "type": "array",
-                          "description": "Information on each payment."
-                        },
-                        "giftCards": {
-                          "type": "array",
-                          "description": "Gift card information, if it applies to the order."
-                        },
-                        "giftCardMessages": {
-                          "type": "array",
-                          "description": "Array of gift card messages."
-                        },
-                        "availableAccounts": {
-                          "type": "array",
-                          "description": "Available accounts."
-                        },
-                        "availableTokens": {
-                          "type": "array",
-                          "description": "Available tokens."
-                        },
-                        "availableAssociations": {
-                          "type": "object",
-                          "description": "Available associations."
-                        }
-                      }
-                    },
-                    "marketingData": {
-                      "type": "object",
-                      "description": "Object containing promotion data such as coupon tracking information and internal or external UTMs.",
-                      "nullable": true
-                    },
-                    "sellers": {
-                      "type": "array",
-                      "description": "Information on each seller.",
-                      "items": {
-                        "type": "object",
-                        "properties": {
-                          "id": {
-                            "type": "string",
-                            "description": "Seller ID."
-                          },
-                          "name": {
-                            "type": "string",
-                            "description": "Seller name."
-                          },
-                          "logo": {
-                            "type": "string",
-                            "description": "Seller logo.",
-                            "nullable": true
-                          }
-                        }
-                      }
-                    },
-                    "clientPreferencesData": {
-                      "type": "object",
-                      "description": "Object containing preferences from the client who placed the order.",
-                      "properties": {
-                        "locale": {
-                          "type": "string",
-                          "description": "Client's locale. Examples: `pt-BR` and `en-US`."
-                        },
-                        "optinNewsLetter": {
-                          "type": "boolean",
-                          "description": "`true` if the client opted to receive newsletter from the store."
-                        }
-                      }
-                    },
-                    "commercialConditionData": {
-                      "type": "object",
-                      "description": "Object containing commercial condition information.",
-                      "nullable": true
-                    },
-                    "storePreferencesData": {
-                      "type": "object",
-                      "description": "Object containing data from the store's configuration (stored in VTEX's License Manager).",
-                      "properties": {
-                        "countryCode": {
-                          "type": "string",
-                          "description": "Three letters ISO code of the country (ISO 3166 ALPHA-3)."
-                        },
-                        "saveUserData": {
-                          "type": "boolean",
-                          "description": "Defines whether the customer want the store to keep their personal and payment data saved."
-                        },
-                        "timeZone": {
-                          "type": "string",
-                          "description": "Time zone from where the order was made."
-                        },
-                        "currencyCode": {
-                          "type": "string",
-                          "description": "Currency code in ISO 4217. For example, `BRL`."
-                        },
-                        "currencyLocale": {
-                          "type": "integer",
-                          "format": "int32",
-                          "description": "Currency Locale Code in LCID in decimal."
-                        },
-                        "currencySymbol": {
-                          "type": "string",
-                          "description": "Currency symbol."
-                        },
-                        "CurrencyFormatInfo": {
-                          "description": "Object with currency format details.",
-                          "type": "object",
-                          "properties": {
-                            "CurrencyDecimalDigits": {
-                              "type": "integer",
-                              "format": "int32",
-                              "description": "Quantity of currency decimal digits."
-                            },
-                            "CurrencyDecimalSeparator": {
-                              "type": "string",
-                              "description": "Defines what currency decimal separator will be applied."
-                            },
-                            "CurrencyGroupSeparator": {
-                              "type": "string",
-                              "description": "Defines what currency group separator will be applied."
-                            },
-                            "CurrencyGroupSize": {
-                              "type": "integer",
-                              "format": "int32",
-                              "description": "Defines how many characters will be grouped."
-                            },
-                            "StartsWithCurrencySymbol": {
-                              "type": "boolean",
-                              "description": "Defines if all prices will be initiated with the currency symbol (`true`) or not (`false`)."
-                            }
-                          }
-                        }
-                      }
-                    },
-                    "giftRegistryData": {
-                      "type": "object",
-                      "description": "Gift registry list information.",
-                      "nullable": true
-                    },
-                    "openTextField": {
-                      "type": "string",
-                      "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).",
-                      "nullable": true
-                    },
-                    "invoiceData": {
-                      "type": "object",
-                      "description": "Object containing information pertinent to the order's invoice.",
-                      "nullable": true
-                    },
-                    "customData": {
-                      "type": "object",
-                      "description": "Customer additional information.",
-                      "nullable": true
-                    },
-                    "itemMetadata": {
-                      "type": "object",
-                      "description": "Item metadata.",
-                      "nullable": true
-                    },
-                    "hooksData": {
-                      "type": "object",
-                      "description": "Hooks information.",
-                      "nullable": true
-                    },
-                    "ratesAndBenefitsData": {
-                      "type": "object",
-                      "description": "Information on rates and benefits that apply to the order.",
-                      "nullable": true
-                    },
-                    "subscriptionData": {
-                      "type": "object",
-                      "description": "Subscription information.",
-                      "nullable": true
-                    },
-                    "itemsOrdination": {
-                      "type": "object",
-                      "description": "Object containing information about the ordering of items within the orderForm.",
-                      "nullable": true
-                    }
-                  }
-                },
-                "example": {
-                  "orderFormId": "2f586e50342a4f87b7e0654c56299e88",
-                  "salesChannel": "1",
-                  "loggedIn": false,
-                  "isCheckedIn": false,
-                  "storeId": null,
-                  "checkedInPickupPointId": null,
-                  "allowManualPrice": false,
-                  "canEditData": true,
-                  "userProfileId": null,
-                  "userType": null,
-                  "ignoreProfileData": false,
-                  "value": 0,
-                  "messages": [],
-                  "items": [],
-                  "selectableGifts": [],
-                  "totalizers": [],
-                  "shippingData": {
-                    "address": {
-                      "addressType": "residential",
-                      "receiverName": "Clark Kent",
-                      "addressId": "c3701fc4c61b4d1b91f67e81415db44d",
-                      "isDisposable": true,
-                      "postalCode": "12345000",
-                      "city": "Rio de Janeiro",
-                      "state": "ST",
-                      "country": "BRA",
-                      "street": "My street",
-                      "number": "1091",
-                      "neighborhood": "My neighborhood",
-                      "complement": null,
-                      "reference": null,
-                      "geoCoordinates": []
-                    },
-                    "logisticsInfo": [
-                      {
-                        "itemIndex": 0,
-                        "selectedSla": null,
-                        "selectedDeliveryChannel": null,
-                        "addressId": "f239ad30f8c948a382543ab2c739b967",
-                        "slas": [
-                          {
-                            "id": "Retirada (VTEXSP)",
-                            "deliveryChannel": "pickup-in-point",
-                            "name": "Retirada (VTEXSP)",
-                            "deliveryIds": [
-                              {
-                                "courierId": "1ee17c2",
-                                "warehouseId": "1_1",
-                                "dockId": "1",
-                                "courierName": "Retira em Loja",
-                                "quantity": 2,
-                                "kitItemDetails": []
-                              }
-                            ],
-                            "shippingEstimate": "3bd",
-                            "shippingEstimateDate": null,
-                            "lockTTL": null,
-                            "availableDeliveryWindows": {
-                              "startDateUtc": "2017-03-27T00:00:00+00:00",
-                              "endDateUtc": "2017-03-27T00:00:00+00:00",
-                              "price": 0,
-                              "lisPrice": 0,
-                              "tax": 0
-                            },
-                            "deliveryWindow": {
-                              "startDateUtc": "2014-04-21T09:00:00+00:00",
-                              "endDateUtc": "2014-04-21T12:00:00+00:00",
-                              "price": 0,
-                              "listprice": 1000,
-                              "tax": 0
-                            },
-                            "price": 250,
-                            "listPrice": 250,
-                            "tax": 0,
-                            "pickupStoreInfo": {
-                              "isPickupStore": true,
-                              "friendlyName": "VTEX SP",
-                              "address": {
-                                "addressType": "pickup",
-                                "receiverName": "Clark Kent",
-                                "addressId": "VTEXSP",
-                                "isDisposable": true,
-                                "postalCode": "04538-132",
-                                "city": "São Paulo",
-                                "state": "SP",
-                                "country": "BRA",
-                                "street": "Avenida Brigadeiro Faria Lima",
-                                "number": "4440",
-                                "neighborhood": "Itaim Bibi",
-                                "complement": "",
-                                "reference": null,
-                                "geoCoordinates": [
-                                  -47.924747467041016,
-                                  -15.832582473754883
-                                ]
-                              },
-                              "additionalInfo": "",
-                              "dockId": "1"
-                            },
-                            "pickupPointId": "1_VTEXSP",
-                            "pickupDistance": 15,
-                            "polygonName": null,
-                            "transitTime": "3bd"
-                          }
-                        ],
-                        "shipsTo": [
-                          "BRA",
-                          "COL",
-                          "USA"
-                        ],
-                        "itemId": "2",
-                        "deliveryChannels": [
-                          {
-                            "id": "pickup-in-point"
-                          },
-                          {
-                            "id": "delivery"
-                          }
-                        ]
-                      }
-                    ],
-                    "selectedAddresses": [
-                      {
-                        "addressType": "residential",
-                        "receiverName": "Clark Kent",
-                        "addressId": "c3701fc4c61b4d1b91f67e81415db44d",
-                        "isDisposable": true,
-                        "postalCode": "12345000",
-                        "city": "Rio de Janeiro",
-                        "state": "ST",
-                        "country": "BRA",
-                        "street": "My street",
-                        "number": "1091",
-                        "neighborhood": "My neighborhood",
-                        "complement": null,
-                        "reference": null,
-                        "geoCoordinates": []
-                      }
-                    ],
-                    "availableAddresses": [
-                      {
-                        "addressType": "residential",
-                        "receiverName": "Clark Kent",
-                        "addressId": "ae3173b32bf64663a81fc42b057be211",
-                        "isDisposable": true,
-                        "postalCode": "70386060",
-                        "city": "Brasília",
-                        "state": "DF",
-                        "country": "BRA",
-                        "street": "Quadra SQS 116 Bloco F",
-                        "number": "101",
-                        "neighborhood": "Asa Sul",
-                        "complement": null,
-                        "reference": null,
-                        "geoCoordinates": [
-                          -47.925922393798828,
-                          -15.832707405090332
-                        ]
-                      },
-                      {
-                        "addressType": "residential",
-                        "receiverName": "Clark Kent",
-                        "addressId": "449dcbe11c5844098fb4545a49cf6e07",
-                        "isDisposable": true,
-                        "postalCode": "00076555",
-                        "city": "Brasília",
-                        "state": "DF",
-                        "country": "BRA",
-                        "street": "My street",
-                        "number": "101",
-                        "neighborhood": "Asa sul",
-                        "complement": null,
-                        "reference": null,
-                        "geoCoordinates": []
-                      },
-                      {
-                        "addressType": "residential",
-                        "receiverName": "Clark Kent",
-                        "addressId": "c3701fc4c61b4d1b91f67e81415db44d",
-                        "isDisposable": true,
-                        "postalCode": "12345000",
-                        "city": "Rio de Janeiro",
-                        "state": "ST",
-                        "country": "BRA",
-                        "street": "My street",
-                        "number": "1091",
-                        "neighborhood": "My neighborhood",
-                        "complement": null,
-                        "reference": null,
-                        "geoCoordinates": []
-                      }
-                    ],
-                    "pickupPoints": []
-                  },
-                  "clientProfileData": {
-                    "email": "clark.kent@example.com",
-                    "firstName": "Clark",
-                    "lastName": "Kent",
-                    "document": "12345678900",
-                    "documentType": "cpf",
-                    "phone": "+5521998765432",
-                    "corporateName": null,
-                    "tradeName": null,
-                    "corporateDocument": null,
-                    "stateInscription": null,
-                    "corporatePhone": null,
-                    "isCorporate": false,
-                    "profileCompleteOnLoading": false,
-                    "profileErrorOnLoading": null,
-                    "customerClass": null
-                  },
-                  "paymentData": {
-                    "updateStatus": "updated",
-                    "installmentOptions": [],
-                    "paymentSystems": [],
-                    "payments": [],
-                    "giftCards": [],
-                    "giftCardMessages": [],
-                    "availableAccounts": [],
-                    "availableTokens": []
-                  },
-                  "marketingData": null,
-                  "sellers": [],
-                  "clientPreferencesData": {
-                    "locale": "pt-BR",
-                    "optinNewsLetter": false
-                  },
-                  "commercialConditionData": null,
-                  "storePreferencesData": {
-                    "countryCode": "BRA",
-                    "saveUserData": true,
-                    "timeZone": "E. South America Standard Time",
-                    "currencyCode": "BRL",
-                    "currencyLocale": 1046,
-                    "currencySymbol": "R$",
-                    "currencyFormatInfo": {
-                      "currencyDecimalDigits": 2,
-                      "currencyDecimalSeparator": ",",
-                      "currencyGroupSeparator": ".",
-                      "currencyGroupSize": 3,
-                      "startsWithCurrencySymbol": true
-                    }
-                  },
-                  "giftRegistryData": null,
-                  "openTextField": null,
-                  "invoiceData": null,
-                  "customData": null,
-                  "itemMetadata": null,
-                  "hooksData": null,
-                  "ratesAndBenefitsData": null,
-                  "subscriptionData": null,
-                  "itemsOrdination": null
-                }
-              }
-            }
-          }
-        },
-        "deprecated": false
-      }
-    },
-    "/api/checkout/pub/orderForm/{orderFormId}/attachments/clientPreferencesData": {
-      "post": {
-        "tags": [
-          "Cart attachments"
-        ],
-        "summary": "Add client preferences",
-        "description": "Use this request to include client preferences information to a given shopping cart.\r\n\r\nThe [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.\n\r\n\r> This request has a time out of 12 seconds.",
-        "operationId": "AddClientPreferences",
-        "security": [],
-        "parameters": [
-          {
-            "name": "Content-Type",
-            "in": "header",
-            "description": "Type of the content being sent.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "Accept",
-            "in": "header",
-            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "orderFormId",
-            "in": "path",
-            "description": "ID of the orderForm that will receive client profile information.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string"
-            }
-          }
-        ],
-        "requestBody": {
-          "content": {
-            "application/json": {
-              "schema": {
-                "type": "object",
-                "properties": {
-                  "locale": {
-                    "type": "string",
-                    "description": "Locale chosen by the shopper. Determines website language.",
-                    "default": "EN"
-                  },
-                  "optinNewsLetter": {
-                    "type": "boolean",
-                    "description": "Indicates whether the shopper opted in to receive the store's news letter.",
-                    "default": false
-                  }
-                }
-              }
-            }
-          },
-          "required": true
-        },
-        "responses": {
-          "200": {
-            "description": "OK",
-            "content": {
-              "application/json": {
-                "schema": {},
-                "example": {
-                  "orderFormId": "a7e4702410864239959f9bdcf77e3fba",
-                  "salesChannel": "1",
-                  "loggedIn": false,
-                  "isCheckedIn": false,
-                  "storeId": null,
-                  "checkedInPickupPointId": null,
-                  "allowManualPrice": false,
-                  "canEditData": true,
-                  "userProfileId": null,
-                  "userType": null,
-                  "ignoreProfileData": false,
-                  "value": 0,
-                  "messages": [],
-                  "items": [],
-                  "selectableGifts": [],
-                  "totalizers": [],
-                  "shippingData": null,
-                  "clientProfileData": null,
-                  "paymentData": {
-                    "updateStatus": "updated",
-                    "installmentOptions": [],
-                    "paymentSystems": [],
-                    "payments": [],
-                    "giftCards": [],
-                    "giftCardMessages": [],
-                    "availableAccounts": [],
-                    "availableTokens": []
-                  },
-                  "marketingData": null,
-                  "sellers": [],
-                  "clientPreferencesData": {
-                    "locale": "PT",
-                    "optinNewsLetter": false
-                  },
-                  "commercialConditionData": null,
-                  "storePreferencesData": {
-                    "countryCode": "BRA",
-                    "saveUserData": true,
-                    "timeZone": "E. South America Standard Time",
-                    "currencyCode": "BRL",
-                    "currencyLocale": 1046,
-                    "currencySymbol": "R$",
-                    "currencyFormatInfo": {
-                      "currencyDecimalDigits": 2,
-                      "currencyDecimalSeparator": ",",
-                      "currencyGroupSeparator": ".",
-                      "currencyGroupSize": 3,
-                      "startsWithCurrencySymbol": true
-                    }
-                  },
-                  "giftRegistryData": null,
-                  "openTextField": null,
-                  "invoiceData": null,
-                  "customData": null,
-                  "itemMetadata": null,
-                  "hooksData": null,
-                  "ratesAndBenefitsData": null,
-                  "subscriptionData": null,
-                  "itemsOrdination": null
-                }
-              }
-            }
-          }
-        },
-        "deprecated": false
-      }
-    },
-    "/api/checkout/pub/orderForm/{orderFormId}/attachments/marketingData": {
-      "post": {
-        "tags": [
-          "Cart attachments"
-        ],
-        "summary": "Add marketing data",
-        "description": "Use this request to include marketing information to a given shopping cart.\r\n\r\nThe [orderForm](https://developers.vtex.com/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.\n\r\n\r> This request has a time out of 12 seconds.",
-        "operationId": "AddMarketingData",
-        "security": [],
-        "parameters": [
-          {
-            "name": "Content-Type",
-            "in": "header",
-            "description": "Type of the content being sent.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "Accept",
-            "in": "header",
-            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "orderFormId",
-            "in": "path",
-            "description": "ID of the orderForm that will receive client profile information.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string"
-            }
-          }
-        ],
-        "requestBody": {
-          "content": {
-            "application/json": {
-              "schema": {
-                "type": "object",
-                "properties": {
-                  "coupon": {
-                    "type": "string",
-                    "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.\n\r\n\rTo send more than one coupon code to the same cart, use commas. E.g.`\"sales25, blackfriday30\"`.",
-                    "default": "free-shipping"
-                  },
-                  "marketingTags": {
-                    "type": "array",
-                    "description": "Marketing tags. Limited to a maximum of 50 items.",
-                    "items": {
-                      "type": "string"
-                    },
-                    "default": [
-                      "tag1",
-                      "tag2"
-                    ]
-                  },
-                  "utmSource": {
-                    "type": "string",
-                    "description": "UTM source.",
-                    "default": "Facebook"
-                  },
-                  "utmMedium": {
-                    "type": "string",
-                    "description": "UTM medium.",
-                    "default": "CPC"
-                  },
-                  "utmCampaign": {
-                    "type": "string",
-                    "description": "UTM campaign",
-                    "default": "Black friday"
-                  },
-                  "utmiPage": {
-                    "type": "string",
-                    "description": "utmi_page (internal utm)",
-                    "default": "utmi_page-example"
-                  },
-                  "utmiPart": {
-                    "type": "string",
-                    "description": "utmi_part (internal utm)",
-                    "default": "utmi_part-exmaple"
-                  },
-                  "utmiCampaign": {
-                    "type": "string",
-                    "description": "utmi_campaign (internal utm)",
-                    "default": "utmi_campaign-exmaple"
-                  }
-                }
-              }
-            }
-          },
-          "required": true
-        },
-        "responses": {
-          "200": {
-            "description": "OK",
-            "content": {
-              "application/json": {
-                "example": {
-                  "orderFormId": "7c5b47971fad41b89102c7ab7bb8b08b",
-                  "salesChannel": "1",
-                  "loggedIn": false,
-                  "isCheckedIn": false,
-                  "storeId": null,
-                  "checkedInPickupPointId": null,
-                  "allowManualPrice": false,
-                  "canEditData": true,
-                  "userProfileId": null,
-                  "userType": null,
-                  "ignoreProfileData": false,
-                  "value": 0,
-                  "messages": [],
-                  "items": [],
-                  "selectableGifts": [],
-                  "totalizers": [],
-                  "shippingData": null,
-                  "clientProfileData": null,
-                  "paymentData": {
-                    "updateStatus": "updated",
-                    "installmentOptions": [],
-                    "paymentSystems": [],
-                    "payments": [],
-                    "giftCards": [],
-                    "giftCardMessages": [],
-                    "availableAccounts": [],
-                    "availableTokens": []
-                  },
-                  "marketingData": {
-                    "utmSource": "app",
-                    "utmMedium": "CPC",
-                    "utmCampaign": "Black friday",
-                    "utmipage": null,
-                    "utmiPart": null,
-                    "utmiCampaign": null,
-                    "coupon": "free-shipping",
-                    "marketingTags": [
-                      "tag1",
-                      "tag2"
-                    ]
-                  },
-                  "sellers": [],
-                  "clientPreferencesData": {
-                    "locale": "pt-BR",
-                    "optinNewsLetter": null
-                  },
-                  "commercialConditionData": null,
-                  "storePreferencesData": {
-                    "countryCode": "BRA",
-                    "saveUserData": true,
-                    "timeZone": "E. South America Standard Time",
-                    "currencyCode": "BRL",
-                    "currencyLocale": 1046,
-                    "currencySymbol": "R$",
-                    "currencyFormatInfo": {
-                      "currencyDecimalDigits": 2,
-                      "currencyDecimalSeparator": ",",
-                      "currencyGroupSeparator": ".",
-                      "currencyGroupSize": 3,
-                      "startsWithCurrencySymbol": true
-                    }
-                  },
-                  "giftRegistryData": null,
-                  "openTextField": null,
-                  "invoiceData": null,
-                  "customData": null,
-                  "itemMetadata": null,
-                  "hooksData": null,
-                  "ratesAndBenefitsData": null,
-                  "subscriptionData": null,
-                  "itemsOrdination": null
-                }
-              }
-            }
-          }
-        },
-        "deprecated": false
-      }
-    },
-    "/api/checkout/pub/orderForm/{orderFormId}/attachments/paymentData": {
-      "post": {
-        "tags": [
-          "Cart attachments"
-        ],
-        "summary": "Add payment data",
-        "description": "Use this request to include payment information to a given shopping cart. The payment information attachment in the shopping cart does not determine the final order payment method in itself. However, it allows tha platform to update any relevant information that may be impacted by the payment method.\r\n\r\nThe [orderForm](https://developers.vtex.com/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.\n\r\n\r> This request has a time out of 12 seconds.",
-        "operationId": "AddPaymentData",
-        "security": [],
-        "parameters": [
-          {
-            "name": "Content-Type",
-            "in": "header",
-            "description": "Type of the content being sent.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "Accept",
-            "in": "header",
-            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "orderFormId",
-            "in": "path",
-            "description": "ID of the orderForm that will receive client profile information.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string"
-            }
-          }
-        ],
-        "requestBody": {
-          "content": {
-            "application/json": {
-              "schema": {
-                "type": "object",
-                "properties": {
-                  "payments": {
-                    "type": "array",
-                    "description": "Array with information on each payment chosen by the shopper.",
-                    "items": {
-                      "type": "object",
-                      "properties": {
-                        "paymentSystem": {
-                          "type": "integer",
-                          "description": "Payment system ID.",
-                          "default": 1
-                        },
-                        "paymentSystemName": {
-                          "type": "string",
-                          "description": "Payment system name.",
-                          "default": "Boleto Bancário"
-                        },
-                        "group": {
-                          "type": "string",
-                          "description": "Payment system group.",
-                          "default": "bankInvoicePaymentGroup"
-                        },
-                        "installments": {
-                          "type": "integer",
-                          "description": "Selected number of installments.",
-                          "default": 1
-                        },
-                        "installmentsInterestRate": {
-                          "type": "number",
-                          "description": "Installments' interest rate.",
-                          "default": 0
-                        },
-                        "installmentsValue": {
-                          "type": "integer",
-                          "description": "Value of the installments.",
-                          "default": 1
-                        },
-                        "value": {
-                          "type": "integer",
-                          "description": "Total value assigned to this payment.",
-                          "default": 100
-                        },
-                        "referenceValue": {
-                          "type": "integer",
-                          "description": "Reference value used to calculate total order value with interest.",
-                          "default": 100
-                        },
-                        "hasDefaultBillingAddress": {
-                          "type": "boolean",
-                          "description": "Indicates whether billing address for this payment is the default address.",
-                          "default": false
-                        }
-                      }
-                    }
-                  }
-                }
-              }
-            }
-          },
-          "required": true
-        },
-        "responses": {
-          "200": {
-            "description": "",
-            "headers": {},
-            "content": {
-              "application/json": {
-                "example": {
-                  "orderFormId": "29154e27383145cc8ce1f7a1df0d99c4",
-                  "salesChannel": "1",
-                  "loggedIn": false,
-                  "isCheckedIn": false,
-                  "storeId": null,
-                  "checkedInPickupPointId": null,
-                  "allowManualPrice": false,
-                  "canEditData": true,
-                  "userProfileId": null,
-                  "userType": null,
-                  "ignoreProfileData": false,
-                  "value": 65780,
-                  "messages": [],
-                  "items": [
-                    {
-                      "uniqueId": "3CBFA140CE8F4E208062FC15CE9ED8D3",
-                      "id": "2",
-                      "productId": "2",
-                      "productRefId": "",
-                      "refId": "CBC30L",
-                      "ean": null,
-                      "name": "Chopp Claro 30L",
-                      "skuName": "Chopp Claro 30L",
-                      "modalType": null,
-                      "parentItemIndex": null,
-                      "parentAssemblyBinding": null,
-                      "assemblies": [],
-                      "priceValidUntil": "2022-07-28T22:25:25Z",
-                      "tax": 0,
-                      "price": 32890,
-                      "listPrice": 49900,
-                      "manualPrice": null,
-                      "manualPriceAppliedBy": null,
-                      "sellingPrice": 32890,
-                      "rewardValue": 0,
-                      "isGift": false,
-                      "additionalInfo": {
-                        "dimension": null,
-                        "brandName": "Beershow",
-                        "brandId": "2000000",
-                        "offeringInfo": null,
-                        "offeringType": null,
-                        "offeringTypeId": null
-                      },
-                      "preSaleDate": null,
-                      "productCategoryIds": "/1/",
-                      "productCategories": {
-                        "1": "Bebidas"
-                      },
-                      "quantity": 2,
-                      "seller": "1",
-                      "sellerChain": [
-                        "1"
-                      ],
-                      "imageUrl": "http://myshop.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000",
-                      "detailUrl": "/chopp-claro-30l/p",
-                      "components": [],
-                      "bundleItems": [],
-                      "attachments": [],
-                      "attachmentOfferings": [],
-                      "offerings": [],
-                      "priceTags": [],
-                      "availability": "available",
-                      "measurementUnit": "un",
-                      "unitMultiplier": 1.0,
-                      "manufacturerCode": null,
-                      "priceDefinition": {
-                        "calculatedSellingPrice": 32890,
-                        "total": 65780,
-                        "sellingPrices": [
-                          {
-                            "value": 32890,
-                            "quantity": 2
-                          }
-                        ]
-                      }
-                    }
-                  ],
-                  "selectableGifts": [],
-                  "totalizers": [
-                    {
-                      "id": "Items",
-                      "name": "Total dos Itens",
-                      "value": 65780
-                    }
-                  ],
-                  "shippingData": {
-                    "address": null,
-                    "logisticsInfo": [
-                      {
-                        "itemIndex": 0,
-                        "selectedSla": null,
-                        "selectedDeliveryChannel": null,
-                        "addressId": null,
-                        "slas": [],
-                        "shipsTo": [
-                          "BRA",
-                          "COL",
-                          "USA"
-                        ],
-                        "itemId": "2",
-                        "deliveryChannels": [
-                          {
-                            "id": "delivery"
-                          },
-                          {
-                            "id": "pickup-in-point"
-                          }
-                        ]
-                      }
-                    ],
-                    "selectedAddresses": [],
-                    "availableAddresses": [],
-                    "pickupPoints": []
-                  },
-                  "clientProfileData": null,
-                  "paymentData": {
-                    "updateStatus": "updated",
-                    "installmentOptions": [
-                      {
-                        "paymentSystem": "2",
-                        "bin": null,
-                        "paymentName": null,
-                        "paymentGroupName": null,
-                        "value": 65780,
-                        "installments": [
-                          {
-                            "count": 1,
-                            "hasInterestRate": false,
-                            "interestRate": 0,
-                            "value": 65780,
-                            "total": 65780,
-                            "sellerMerchantInstallments": [
-                              {
-                                "id": "MYSHOP",
-                                "count": 1,
-                                "hasInterestRate": false,
-                                "interestRate": 0,
-                                "value": 65780,
-                                "total": 65780
-                              }
-                            ]
-                          }
-                        ]
-                      },
-                      {
-                        "paymentSystem": "4",
-                        "bin": null,
-                        "paymentName": null,
-                        "paymentGroupName": null,
-                        "value": 65780,
-                        "installments": [
-                          {
-                            "count": 1,
-                            "hasInterestRate": false,
-                            "interestRate": 0,
-                            "value": 65780,
-                            "total": 65780,
-                            "sellerMerchantInstallments": [
-                              {
-                                "id": "MYSHOP",
-                                "count": 1,
-                                "hasInterestRate": false,
-                                "interestRate": 0,
-                                "value": 65780,
-                                "total": 65780
-                              }
-                            ]
-                          }
-                        ]
-                      },
-                      {
-                        "paymentSystem": "6",
-                        "bin": null,
-                        "paymentName": null,
-                        "paymentGroupName": null,
-                        "value": 65780,
-                        "installments": [
-                          {
-                            "count": 1,
-                            "hasInterestRate": false,
-                            "interestRate": 0,
-                            "value": 65780,
-                            "total": 65780,
-                            "sellerMerchantInstallments": [
-                              {
-                                "id": "MYSHOP",
-                                "count": 1,
-                                "hasInterestRate": false,
-                                "interestRate": 0,
-                                "value": 65780,
-                                "total": 65780
-                              }
-                            ]
-                          }
-                        ]
-                      }
-                    ],
-                    "paymentSystems": [
-                      {
-                        "id": 2,
-                        "name": "Visa",
-                        "groupName": "creditCardPaymentGroup",
-                        "validator": {
-                          "regex": "^4[0-9]{15}$",
-                          "mask": "9999 9999 9999 9999",
-                          "cardCodeRegex": "^[0-9]{3}$",
-                          "cardCodeMask": "999",
-                          "weights": [
-                            2,
-                            1,
-                            2,
-                            1,
-                            2,
-                            1,
-                            2,
-                            1,
-                            2,
-                            1,
-                            2,
-                            1,
-                            2,
-                            1,
-                            2,
-                            1,
-                            2,
-                            1,
-                            2
-                          ],
-                          "useCvv": true,
-                          "useExpirationDate": true,
-                          "useCardHolderName": true,
-                          "useBillingAddress": true
-                        },
-                        "stringId": "2",
-                        "template": "creditCardPaymentGroup-template",
-                        "requiresDocument": false,
-                        "isCustom": false,
-                        "description": null,
-                        "requiresAuthentication": false,
-                        "dueDate": "2021-08-04T22:19:04.9948627Z",
-                        "availablePayments": null
-                      },
-                      {
-                        "id": 4,
-                        "name": "Mastercard",
-                        "groupName": "creditCardPaymentGroup",
-                        "validator": {
-                          "regex": "^((5(([1-2]|[4-5])[0-9]{8}|0((1|6)([0-9]{7}))|3(0(4((0|[2-9])[0-9]{5})|([0-3]|[5-9])[0-9]{6})|[1-9][0-9]{7})))|((508116)\\d{4,10})|((502121)\\d{4,10})|((589916)\\d{4,10})|(2[0-9]{15})|(67[0-9]{14})|(506387)\\d{4,10})",
-                          "mask": "9999 9999 9999 9999",
-                          "cardCodeRegex": "^[0-9]{3}$",
-                          "cardCodeMask": "999",
-                          "weights": [
-                            2,
-                            1,
-                            2,
-                            1,
-                            2,
-                            1,
-                            2,
-                            1,
-                            2,
-                            1,
-                            2,
-                            1,
-                            2,
-                            1,
-                            2,
-                            1,
-                            2,
-                            1,
-                            2
-                          ],
-                          "useCvv": true,
-                          "useExpirationDate": true,
-                          "useCardHolderName": true,
-                          "useBillingAddress": true
-                        },
-                        "stringId": "4",
-                        "template": "creditCardPaymentGroup-template",
-                        "requiresDocument": false,
-                        "isCustom": false,
-                        "description": null,
-                        "requiresAuthentication": false,
-                        "dueDate": "2021-08-04T22:19:04.9948627Z",
-                        "availablePayments": null
-                      },
-                      {
-                        "id": 6,
-                        "name": "Boleto Bancário",
-                        "groupName": "bankInvoicePaymentGroup",
-                        "validator": {
-                          "regex": null,
-                          "mask": null,
-                          "cardCodeRegex": null,
-                          "cardCodeMask": null,
-                          "weights": null,
-                          "useCvv": false,
-                          "useExpirationDate": false,
-                          "useCardHolderName": false,
-                          "useBillingAddress": false
-                        },
-                        "stringId": "6",
-                        "template": "bankInvoicePaymentGroup-template",
-                        "requiresDocument": false,
-                        "isCustom": false,
-                        "description": null,
-                        "requiresAuthentication": false,
-                        "dueDate": "2021-08-04T22:19:04.9948627Z",
-                        "availablePayments": null
-                      }
-                    ],
-                    "payments": [
-                      {
-                        "paymentSystem": "6",
-                        "bin": null,
-                        "accountId": null,
-                        "tokenId": null,
-                        "installments": 1,
-                        "referenceValue": 65780,
-                        "value": 65780,
-                        "merchantSellerPayments": [
-                          {
-                            "id": "MYSHOP",
-                            "installments": 1,
-                            "referenceValue": 65780,
-                            "value": 65780,
-                            "interestRate": 0,
-                            "installmentValue": 65780
-                          }
-                        ]
-                      }
-                    ],
-                    "giftCards": [],
-                    "giftCardMessages": [],
-                    "availableAccounts": [],
-                    "availableTokens": []
-                  },
-                  "marketingData": null,
-                  "sellers": [
-                    {
-                      "id": "1",
-                      "name": "My Seller",
-                      "logo": ""
-                    }
-                  ],
-                  "clientPreferencesData": {
-                    "locale": "pt-BR",
-                    "optinNewsLetter": null
-                  },
-                  "commercialConditionData": null,
-                  "storePreferencesData": {
-                    "countryCode": "BRA",
-                    "saveUserData": true,
-                    "timeZone": "E. South America Standard Time",
-                    "currencyCode": "BRL",
-                    "currencyLocale": 1046,
-                    "currencySymbol": "R$",
-                    "currencyFormatInfo": {
-                      "currencyDecimalDigits": 2,
-                      "currencyDecimalSeparator": ",",
-                      "currencyGroupSeparator": ".",
-                      "currencyGroupSize": 3,
-                      "startsWithCurrencySymbol": true
-                    }
-                  },
-                  "giftRegistryData": null,
-                  "openTextField": null,
-                  "invoiceData": null,
-                  "customData": null,
-                  "itemMetadata": {
-                    "items": [
-                      {
-                        "id": "2",
-                        "seller": "1",
-                        "name": "Chopp Claro 30L",
-                        "skuName": "Chopp Claro 30L",
-                        "productId": "2",
-                        "refId": "CBC30L",
-                        "ean": null,
-                        "imageUrl": "http://myshop.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000",
-                        "detailUrl": "/chopp-claro-30l/p",
-                        "assemblyOptions": []
-                      }
-                    ]
-                  },
-                  "hooksData": null,
-                  "ratesAndBenefitsData": {
-                    "rateAndBenefitsIdentifiers": [],
-                    "teaser": []
-                  },
-                  "subscriptionData": null,
-                  "itemsOrdination": null
-                }
-              }
-            }
-          }
-        },
-        "deprecated": false
-      }
-    },
-    "/api/checkout/pub/orderForm/{orderFormId}/attachments/merchantContextData": {
-      "post": {
-        "tags": [
-          "Cart attachments"
-        ],
-        "summary": "Add merchant context data",
-        "description": "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.\r\n\r\nThe [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.\n\r\n\r> This request has a time out of 12 seconds.",
-        "operationId": "AddMerchantContextData",
-        "security": [],
-        "parameters": [
-          {
-            "name": "Content-Type",
-            "in": "header",
-            "description": "Type of the content being sent.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "Accept",
-            "in": "header",
-            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "orderFormId",
-            "in": "path",
-            "description": "ID of the orderForm that will receive the relevant information added by the merchant.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string"
-            },
-            "example": "29154e27383145cc8ce1f7a1df0d99c4"
-          }
-        ],
-        "requestBody": {
-          "content": {
-            "application/json": {
-              "schema": {
-                "type": "object",
-                "required": [
-                  "salesAssociateData"
-                ],
-                "properties": {
-                  "salesAssociateData": {
-                    "type": "object",
-                    "description": "Sales Associate information.",
-                    "properties": {
-                      "salesAssociateId": {
-                        "type": "string",
-                        "description": "Sales Associate (Seller) identification code. All information should be registered by the merchant. Maximum of 100 characters.",
-                        "default": "seller123"
-                      }
-                    }
-                  }
-                }
-              }
-            }
-          },
-          "required": true
-        },
-        "responses": {
-          "200": {
-            "description": "OK",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "object",
-                  "properties": {
-                    "salesAssociateId": {
-                      "type": "string",
-                      "description": "Sales Associate (Seller) identification code."
-                    }
-                  }
-                },
-                "example": {
-                  "salesAssociateData": {
-                    "salesAssociateId": "seller123"
-                  }
-                }
-              }
-            }
-          }
-        },
-        "deprecated": false
-      }
-    },
-    "/api/checkout/pub/orderForm/{orderFormId}/customData/{appId}": {
-      "put": {
-        "tags": [
-          "Custom data"
-        ],
-        "summary": "Set multiple custom field values",
-        "description": "Your account may create `apps`, which contain custom fields, through the [Update orderForm configuration](https://developers.vtex.com/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.\n\r\n\rTo do that, you need to inform the ID of the app you created with the configuration API (`appId`).\n\r\n\rIn the body of the request, for each field created in this app (`appFieldName`) you will inform a value (`appFieldValue`).\r\n\r\nThe [orderForm](https://developers.vtex.com/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.",
-        "operationId": "SetMultipleCustomFieldValues",
-        "security": [],
-        "parameters": [
-          {
-            "name": "orderFormId",
-            "in": "path",
-            "description": "ID of the orderForm that will receive the new custom field values.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string"
-            }
-          },
-          {
-            "name": "Content-Type",
-            "in": "header",
-            "description": "Type of the content being sent.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "Accept",
-            "in": "header",
-            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "appId",
-            "in": "path",
-            "description": "ID of the app created with the configuration API.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string"
-            }
-          }
-        ],
-        "requestBody": {
-          "content": {
-            "application/json": {
-              "schema": {
-                "description": "Here you must add the pairs of Field Name and Field Value.",
-                "type": "object",
-                "additionalProperties": true
-              }
-            }
-          },
-          "required": true
-        },
-        "responses": {
-          "200": {
-            "description": "OK",
-            "content": {
-              "application/json": {
-                "schema": {},
-                "example": {
-                  "orderFormId": "ede846222cd44046ba6c638442c3505a",
-                  "salesChannel": "1",
-                  "loggedIn": false,
-                  "isCheckedIn": false,
-                  "storeId": null,
-                  "checkedInPickupPointId": null,
-                  "allowManualPrice": false,
-                  "canEditData": true,
-                  "userProfileId": null,
-                  "userType": null,
-                  "ignoreProfileData": false,
-                  "value": 10000,
-                  "messages": [],
-                  "items": [
-                    {
-                      "uniqueId": "E0F2B7AF5CD74D668F1E27537206912C",
-                      "id": "1",
-                      "productId": "1",
-                      "productRefId": "",
-                      "refId": "0001",
-                      "ean": "123456789",
-                      "name": "Ração Royal Canin Feline Urinary 500g",
-                      "skuName": "Ração Royal Canin Feline Urinary 500g",
-                      "modalType": null,
-                      "parentItemIndex": null,
-                      "parentAssemblyBinding": null,
-                      "assemblies": [],
-                      "priceValidUntil": "2021-02-27T14:59:00.8288784Z",
-                      "tax": 0,
-                      "price": 15000,
-                      "listPrice": 30000,
-                      "manualPrice": 10000,
-                      "sellingPrice": 10000,
-                      "rewardValue": 0,
-                      "isGift": false,
-                      "additionalInfo": {
-                        "brandName": "Royal Canin",
-                        "brandId": "2000000",
-                        "offeringInfo": null,
-                        "offeringType": null,
-                        "offeringTypeId": null
-                      },
-                      "preSaleDate": null,
-                      "productCategoryIds": "/1/10/",
-                      "productCategories": {
-                        "10": "Ração Seca",
-                        "1": "Alimentação"
-                      },
-                      "quantity": 1,
-                      "seller": "1",
-                      "sellerChain": [
-                        "1"
-                      ],
-                      "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
-                      "detailUrl": "/racao-royal-canin-feline-urinary/p",
-                      "components": [],
-                      "bundleItems": [],
-                      "attachments": [],
-                      "attachmentOfferings": [],
-                      "offerings": [],
-                      "priceTags": [
-                        {
-                          "name": "DISCOUNT@MANUALPRICE",
-                          "value": -5000,
-                          "rawValue": -50.0,
-                          "isPercentual": false,
-                          "identifier": null
-                        }
-                      ],
-                      "availability": "available",
-                      "measurementUnit": "un",
-                      "unitMultiplier": 1.0,
-                      "manufacturerCode": null
-                    }
-                  ],
-                  "selectableGifts": [],
-                  "totalizers": [
-                    {
-                      "id": "Items",
-                      "name": "Total dos Itens",
-                      "value": 15000
-                    },
-                    {
-                      "id": "Discounts",
-                      "name": "Total dos Descontos",
-                      "value": -5000
-                    }
-                  ],
-                  "shippingData": {
-                    "address": null,
-                    "logisticsInfo": [
-                      {
-                        "itemIndex": 0,
-                        "selectedSla": null,
-                        "selectedDeliveryChannel": "delivery",
-                        "addressId": null,
-                        "slas": [],
-                        "shipsTo": [
-                          "BRA"
-                        ],
-                        "itemId": "1",
-                        "deliveryChannels": [
-                          {
-                            "id": "pickup-in-point"
-                          },
-                          {
-                            "id": "delivery"
-                          }
-                        ]
-                      }
-                    ],
-                    "selectedAddresses": [],
-                    "availableAddresses": [],
-                    "pickupPoints": []
-                  },
-                  "clientProfileData": null,
-                  "paymentData": {
-                    "installmentOptions": [
-                      {
-                        "paymentSystem": "2",
-                        "bin": null,
-                        "paymentName": null,
-                        "paymentGroupName": null,
-                        "value": 10000,
-                        "installments": [
-                          {
-                            "count": 1,
-                            "hasInterestRate": false,
-                            "interestRate": 0,
-                            "value": 10000,
-                            "total": 10000,
-                            "sellerMerchantInstallments": [
-                              {
-                                "id": "LOJADOBRENO",
-                                "count": 1,
-                                "hasInterestRate": false,
-                                "interestRate": 0,
-                                "value": 10000,
-                                "total": 10000
-                              }
-                            ]
-                          },
-                          {
-                            "count": 2,
-                            "hasInterestRate": false,
-                            "interestRate": 0,
-                            "value": 5000,
-                            "total": 10000,
-                            "sellerMerchantInstallments": [
-                              {
-                                "id": "LOJADOBRENO",
-                                "count": 2,
-                                "hasInterestRate": false,
-                                "interestRate": 0,
-                                "value": 5000,
-                                "total": 10000
-                              }
-                            ]
-                          }
-                        ]
-                      }
-                    ],
-                    "paymentSystems": [
-                      {
-                        "id": 2,
-                        "name": "Visa",
-                        "groupName": "creditCardPaymentGroup",
-                        "validator": {
-                          "regex": "^4[0-9]{15}$",
-                          "mask": "9999 9999 9999 9999",
-                          "cardCodeRegex": "^[0-9]{3}$",
-                          "cardCodeMask": "999",
-                          "weights": [
-                            2,
-                            1,
-                            2,
-                            1
-                          ],
-                          "useCvv": true,
-                          "useExpirationDate": true,
-                          "useCardHolderName": true,
-                          "useBillingAddress": true
-                        },
-                        "stringId": "2",
-                        "template": "creditCardPaymentGroup-template",
-                        "requiresDocument": false,
-                        "isCustom": false,
-                        "description": null,
-                        "requiresAuthentication": false,
-                        "dueDate": "2020-03-05T16:42:31.7836281Z",
-                        "availablePayments": null
-                      }
-                    ],
-                    "payments": [],
-                    "giftCards": [],
-                    "giftCardMessages": [],
-                    "availableAccounts": [],
-                    "availableTokens": []
-                  },
-                  "marketingData": null,
-                  "sellers": [
-                    {
-                      "id": "1",
-                      "name": "lojadobreno",
-                      "logo": ""
-                    }
-                  ],
-                  "clientPreferencesData": {
-                    "locale": "pt-BR",
-                    "optinNewsLetter": null
-                  },
-                  "commercialConditionData": null,
-                  "storePreferencesData": {
-                    "countryCode": "BRA",
-                    "saveUserData": true,
-                    "timeZone": "E. South America Standard Time",
-                    "currencyCode": "BRL",
-                    "currencyLocale": 1046,
-                    "currencySymbol": "R$",
-                    "currencyFormatInfo": {
-                      "currencyDecimalDigits": 2,
-                      "currencyDecimalSeparator": ",",
-                      "currencyGroupSeparator": ".",
-                      "currencyGroupSize": 3,
-                      "startsWithCurrencySymbol": true
-                    }
-                  },
-                  "giftRegistryData": null,
-                  "openTextField": null,
-                  "invoiceData": null,
-                  "customData": {
-                    "customApps": [
-                      {
-                        "fields": {
-                          "testField1": "testValue1",
-                          "testField2": "testValue2"
-                        },
-                        "id": "abcd",
-                        "major": 1
-                      }
-                    ]
-                  },
-                  "itemMetadata": {
-                    "items": [
-                      {
-                        "id": "1",
-                        "seller": "1",
-                        "name": "Ração Royal Canin Feline Urinary 500g",
-                        "skuName": "Ração Royal Canin Feline Urinary 500g",
-                        "productId": "1",
-                        "refId": "0001",
-                        "ean": "123456789",
-                        "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
-                        "detailUrl": "/racao-royal-canin-feline-urinary/p",
-                        "assemblyOptions": []
-                      }
-                    ]
-                  },
-                  "hooksData": null,
-                  "ratesAndBenefitsData": {
-                    "rateAndBenefitsIdentifiers": [],
-                    "teaser": []
-                  },
-                  "subscriptionData": null,
-                  "itemsOrdination": null
-                }
-              }
-            }
-          }
-        },
-        "deprecated": false
-      }
-    },
-    "/api/checkout/pub/orderForm/{orderFormId}/customData/{appId}/{appFieldName}": {
-      "put": {
-        "tags": [
-          "Custom data"
-        ],
-        "summary": "Set single custom field value",
-        "description": "Your account may create `apps`, which contain custom fields, through the [Update orderForm configuration](https://developers.vtex.com/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.\n\r\n\rTo do that, you need to inform in the URL the ID of the app you created with the configuration API (`appId`).\n\r\n\rIn the body of the request, you will inform the new value (`appFieldValue`, passed through the body) of the specific field created in this app (identified by the `appFieldName` parameter, passed through the URL).\r\n\r\nThe [orderForm](https://developers.vtex.com/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.",
-        "operationId": "SetSingleCustomFieldValue",
-        "security": [],
-        "parameters": [
-          {
-            "name": "orderFormId",
-            "in": "path",
-            "description": "The ID of the orderForm whose custom field's value you want to change.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string"
-            }
-          },
-          {
-            "name": "appId",
-            "in": "path",
-            "description": "ID of the app created through the Update orderForm Configuration endpoint.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string"
-            }
-          },
-          {
-            "name": "appFieldName",
-            "in": "path",
-            "description": "Name of the app's field created through the Update orderForm Configuration endpoint.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string"
-            }
-          },
-          {
-            "name": "Content-Type",
-            "in": "header",
-            "description": "Type of the content being sent.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "Accept",
-            "in": "header",
-            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          }
-        ],
-        "requestBody": {
-          "description": "",
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/SetsinglecustomfieldvalueRequest"
-              },
-              "example": {
-                "value": "{{appFieldValue}}"
-              }
-            }
-          },
-          "required": true
-        },
-        "responses": {
-          "200": {
-            "description": "",
-            "headers": {},
-            "content": {
-              "application/json": {
-                "example": {
-                  "orderFormId": "ede846222cd44046ba6c638442c3505a",
-                  "salesChannel": "1",
-                  "loggedIn": false,
-                  "isCheckedIn": false,
-                  "storeId": null,
-                  "checkedInPickupPointId": null,
-                  "allowManualPrice": false,
-                  "canEditData": true,
-                  "userProfileId": null,
-                  "userType": null,
-                  "ignoreProfileData": false,
-                  "value": 10000,
-                  "messages": [],
-                  "items": [
-                    {
-                      "uniqueId": "E0F2B7AF5CD74D668F1E27537206912C",
-                      "id": "1",
-                      "productId": "1",
-                      "productRefId": "",
-                      "refId": "0001",
-                      "ean": "123456789",
-                      "name": "Ração Royal Canin Feline Urinary 500g",
-                      "skuName": "Ração Royal Canin Feline Urinary 500g",
-                      "modalType": null,
-                      "parentItemIndex": null,
-                      "parentAssemblyBinding": null,
-                      "assemblies": [],
-                      "priceValidUntil": "2021-02-27T14:59:00.8288784Z",
-                      "tax": 0,
-                      "price": 15000,
-                      "listPrice": 30000,
-                      "manualPrice": 10000,
-                      "sellingPrice": 10000,
-                      "rewardValue": 0,
-                      "isGift": false,
-                      "additionalInfo": {
-                        "brandName": "Royal Canin",
-                        "brandId": "2000000",
-                        "offeringInfo": null,
-                        "offeringType": null,
-                        "offeringTypeId": null
-                      },
-                      "preSaleDate": null,
-                      "productCategoryIds": "/1/10/",
-                      "productCategories": {
-                        "10": "Ração Seca",
-                        "1": "Alimentação"
-                      },
-                      "quantity": 1,
-                      "seller": "1",
-                      "sellerChain": [
-                        "1"
-                      ],
-                      "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
-                      "detailUrl": "/racao-royal-canin-feline-urinary/p",
-                      "components": [],
-                      "bundleItems": [],
-                      "attachments": [],
-                      "attachmentOfferings": [],
-                      "offerings": [],
-                      "priceTags": [
-                        {
-                          "name": "DISCOUNT@MANUALPRICE",
-                          "value": -5000,
-                          "rawValue": -50.0,
-                          "isPercentual": false,
-                          "identifier": null
-                        }
-                      ],
-                      "availability": "available",
-                      "measurementUnit": "un",
-                      "unitMultiplier": 1.0,
-                      "manufacturerCode": null
-                    }
-                  ],
-                  "selectableGifts": [],
-                  "totalizers": [
-                    {
-                      "id": "Items",
-                      "name": "Total dos Itens",
-                      "value": 15000
-                    },
-                    {
-                      "id": "Discounts",
-                      "name": "Total dos Descontos",
-                      "value": -5000
-                    }
-                  ],
-                  "shippingData": {
-                    "address": null,
-                    "logisticsInfo": [
-                      {
-                        "itemIndex": 0,
-                        "selectedSla": null,
-                        "selectedDeliveryChannel": "delivery",
-                        "addressId": null,
-                        "slas": [],
-                        "shipsTo": [
-                          "BRA"
-                        ],
-                        "itemId": "1",
-                        "deliveryChannels": [
-                          {
-                            "id": "pickup-in-point"
-                          },
-                          {
-                            "id": "delivery"
-                          }
-                        ]
-                      }
-                    ],
-                    "selectedAddresses": [],
-                    "availableAddresses": [],
-                    "pickupPoints": []
-                  },
-                  "clientProfileData": null,
-                  "paymentData": {
-                    "installmentOptions": [
-                      {
-                        "paymentSystem": "2",
-                        "bin": null,
-                        "paymentName": null,
-                        "paymentGroupName": null,
-                        "value": 10000,
-                        "installments": [
-                          {
-                            "count": 1,
-                            "hasInterestRate": false,
-                            "interestRate": 0,
-                            "value": 10000,
-                            "total": 10000,
-                            "sellerMerchantInstallments": [
-                              {
-                                "id": "LOJADOBRENO",
-                                "count": 1,
-                                "hasInterestRate": false,
-                                "interestRate": 0,
-                                "value": 10000,
-                                "total": 10000
-                              }
-                            ]
-                          },
-                          {
-                            "count": 2,
-                            "hasInterestRate": false,
-                            "interestRate": 0,
-                            "value": 5000,
-                            "total": 10000,
-                            "sellerMerchantInstallments": [
-                              {
-                                "id": "LOJADOBRENO",
-                                "count": 2,
-                                "hasInterestRate": false,
-                                "interestRate": 0,
-                                "value": 5000,
-                                "total": 10000
-                              }
-                            ]
-                          }
-                        ]
-                      }
-                    ],
-                    "paymentSystems": [
-                      {
-                        "id": 2,
-                        "name": "Visa",
-                        "groupName": "creditCardPaymentGroup",
-                        "validator": {
-                          "regex": "^4[0-9]{15}$",
-                          "mask": "9999 9999 9999 9999",
-                          "cardCodeRegex": "^[0-9]{3}$",
-                          "cardCodeMask": "999",
-                          "weights": [
-                            2,
-                            1,
-                            2,
-                            1,
-                            2
-                          ],
-                          "useCvv": true,
-                          "useExpirationDate": true,
-                          "useCardHolderName": true,
-                          "useBillingAddress": true
-                        },
-                        "stringId": "2",
-                        "template": "creditCardPaymentGroup-template",
-                        "requiresDocument": false,
-                        "isCustom": false,
-                        "description": null,
-                        "requiresAuthentication": false,
-                        "dueDate": "2020-03-05T16:42:31.7836281Z",
-                        "availablePayments": null
-                      }
-                    ],
-                    "payments": [],
-                    "giftCards": [],
-                    "giftCardMessages": [],
-                    "availableAccounts": [],
-                    "availableTokens": []
-                  },
-                  "marketingData": null,
-                  "sellers": [
-                    {
-                      "id": "1",
-                      "name": "lojadobreno",
-                      "logo": ""
-                    }
-                  ],
-                  "clientPreferencesData": {
-                    "locale": "pt-BR",
-                    "optinNewsLetter": null
-                  },
-                  "commercialConditionData": null,
-                  "storePreferencesData": {
-                    "countryCode": "BRA",
-                    "saveUserData": true,
-                    "timeZone": "E. South America Standard Time",
-                    "currencyCode": "BRL",
-                    "currencyLocale": 1046,
-                    "currencySymbol": "R$",
-                    "currencyFormatInfo": {
-                      "currencyDecimalDigits": 2,
-                      "currencyDecimalSeparator": ",",
-                      "currencyGroupSeparator": ".",
-                      "currencyGroupSize": 3,
-                      "startsWithCurrencySymbol": true
-                    }
-                  },
-                  "giftRegistryData": null,
-                  "openTextField": null,
-                  "invoiceData": null,
-                  "customData": {
-                    "customApps": [
-                      {
-                        "fields": {
-                          "testField1": "Hello World",
-                          "testField2": "testValue2"
-                        },
-                        "id": "abcd",
-                        "major": 1
-                      }
-                    ]
-                  },
-                  "itemMetadata": {
-                    "items": [
-                      {
-                        "id": "1",
-                        "seller": "1",
-                        "name": "Ração Royal Canin Feline Urinary 500g",
-                        "skuName": "Ração Royal Canin Feline Urinary 500g",
-                        "productId": "1",
-                        "refId": "0001",
-                        "ean": "123456789",
-                        "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
-                        "detailUrl": "/racao-royal-canin-feline-urinary/p",
-                        "assemblyOptions": []
-                      }
-                    ]
-                  },
-                  "hooksData": null,
-                  "ratesAndBenefitsData": {
-                    "rateAndBenefitsIdentifiers": [],
-                    "teaser": []
-                  },
-                  "subscriptionData": null,
-                  "itemsOrdination": null
-                }
-              }
-            }
-          }
-        },
-        "deprecated": false
-      },
-      "delete": {
-        "tags": [
-          "Custom data"
-        ],
-        "summary": "Remove single custom field value",
-        "description": "Your account may create `apps`, which contain custom fields, through the [Update orderForm configuration](https://developers.vtex.com/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.\n\r\n\rTo do that, you need to inform in the URL the ID of the app you created with the configuration API (`appId`).\n\r\n\rYou also need to iform the specific field created in this app (identified by the `appFieldName` parameter, also passed through the URL) whose value you want to remove.",
-        "operationId": "Removesinglecustomfieldvalue",
-        "security": [],
-        "parameters": [
-          {
-            "name": "Content-Type",
-            "in": "header",
-            "description": "Type of the content being sent.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "Accept",
-            "in": "header",
-            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "orderFormId",
-            "in": "path",
-            "description": "The ID of the orderForm from which you want to remove the custom field value.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string"
-            }
-          },
-          {
-            "name": "appId",
-            "in": "path",
-            "description": "ID of the app created through the Update orderForm Configuration endpoint.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string"
-            }
-          },
-          {
-            "name": "appFieldName",
-            "in": "path",
-            "description": "Name of the app's field created through the Update orderForm Configuration endpoint and which will be deleted.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string"
-            }
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "OK",
-            "content": {
-              "application/json": {
-                "example": {
-                  "orderFormId": "ede846222cd44046ba6c638442c3505a",
-                  "salesChannel": "1",
-                  "loggedIn": false,
-                  "isCheckedIn": false,
-                  "storeId": null,
-                  "checkedInPickupPointId": null,
-                  "allowManualPrice": false,
-                  "canEditData": true,
-                  "userProfileId": null,
-                  "userType": null,
-                  "ignoreProfileData": false,
-                  "value": 10000,
-                  "messages": [],
-                  "items": [
-                    {
-                      "uniqueId": "E0F2B7AF5CD74D668F1E27537206912C",
-                      "id": "1",
-                      "productId": "1",
-                      "productRefId": "",
-                      "refId": "0001",
-                      "ean": "123456789",
-                      "name": "Ração Royal Canin Feline Urinary 500g",
-                      "skuName": "Ração Royal Canin Feline Urinary 500g",
-                      "modalType": null,
-                      "parentItemIndex": null,
-                      "parentAssemblyBinding": null,
-                      "assemblies": [],
-                      "priceValidUntil": "2021-02-27T14:59:00.8288784Z",
-                      "tax": 0,
-                      "price": 15000,
-                      "listPrice": 30000,
-                      "manualPrice": 10000,
-                      "sellingPrice": 10000,
-                      "rewardValue": 0,
-                      "isGift": false,
-                      "additionalInfo": {
-                        "brandName": "Royal Canin",
-                        "brandId": "2000000",
-                        "offeringInfo": null,
-                        "offeringType": null,
-                        "offeringTypeId": null
-                      },
-                      "preSaleDate": null,
-                      "productCategoryIds": "/1/10/",
-                      "productCategories": {
-                        "10": "Ração Seca",
-                        "1": "Alimentação"
-                      },
-                      "quantity": 1,
-                      "seller": "1",
-                      "sellerChain": [
-                        "1"
-                      ],
-                      "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
-                      "detailUrl": "/racao-royal-canin-feline-urinary/p",
-                      "components": [],
-                      "bundleItems": [],
-                      "attachments": [],
-                      "attachmentOfferings": [],
-                      "offerings": [],
-                      "priceTags": [
-                        {
-                          "name": "DISCOUNT@MANUALPRICE",
-                          "value": -5000,
-                          "rawValue": -50.0,
-                          "isPercentual": false,
-                          "identifier": null
-                        }
-                      ],
-                      "availability": "available",
-                      "measurementUnit": "un",
-                      "unitMultiplier": 1.0,
-                      "manufacturerCode": null
-                    }
-                  ],
-                  "selectableGifts": [],
-                  "totalizers": [
-                    {
-                      "id": "Items",
-                      "name": "Total dos Itens",
-                      "value": 15000
-                    },
-                    {
-                      "id": "Discounts",
-                      "name": "Total dos Descontos",
-                      "value": -5000
-                    }
-                  ],
-                  "shippingData": {
-                    "address": null,
-                    "logisticsInfo": [
-                      {
-                        "itemIndex": 0,
-                        "selectedSla": null,
-                        "selectedDeliveryChannel": "delivery",
-                        "addressId": null,
-                        "slas": [],
-                        "shipsTo": [
-                          "BRA"
-                        ],
-                        "itemId": "1",
-                        "deliveryChannels": [
-                          {
-                            "id": "pickup-in-point"
-                          },
-                          {
-                            "id": "delivery"
-                          }
-                        ]
-                      }
-                    ],
-                    "selectedAddresses": [],
-                    "availableAddresses": [],
-                    "pickupPoints": []
-                  },
-                  "clientProfileData": null,
-                  "paymentData": {
-                    "installmentOptions": [
-                      {
-                        "paymentSystem": "2",
-                        "bin": null,
-                        "paymentName": null,
-                        "paymentGroupName": null,
-                        "value": 10000,
-                        "installments": [
-                          {
-                            "count": 1,
-                            "hasInterestRate": false,
-                            "interestRate": 0,
-                            "value": 10000,
-                            "total": 10000,
-                            "sellerMerchantInstallments": [
-                              {
-                                "id": "LOJADOBRENO",
-                                "count": 1,
-                                "hasInterestRate": false,
-                                "interestRate": 0,
-                                "value": 10000,
-                                "total": 10000
-                              }
-                            ]
-                          },
-                          {
-                            "count": 2,
-                            "hasInterestRate": false,
-                            "interestRate": 0,
-                            "value": 5000,
-                            "total": 10000,
-                            "sellerMerchantInstallments": [
-                              {
-                                "id": "LOJADOBRENO",
-                                "count": 2,
-                                "hasInterestRate": false,
-                                "interestRate": 0,
-                                "value": 5000,
-                                "total": 10000
-                              }
-                            ]
-                          }
-                        ]
-                      }
-                    ],
-                    "paymentSystems": [
-                      {
-                        "id": 2,
-                        "name": "Visa",
-                        "groupName": "creditCardPaymentGroup",
-                        "validator": {
-                          "regex": "^4[0-9]{15}$",
-                          "mask": "9999 9999 9999 9999",
-                          "cardCodeRegex": "^[0-9]{3}$",
-                          "cardCodeMask": "999",
-                          "weights": [
-                            2,
-                            1,
-                            2,
-                            1,
-                            2
-                          ],
-                          "useCvv": true,
-                          "useExpirationDate": true,
-                          "useCardHolderName": true,
-                          "useBillingAddress": true
-                        },
-                        "stringId": "2",
-                        "template": "creditCardPaymentGroup-template",
-                        "requiresDocument": false,
-                        "isCustom": false,
-                        "description": null,
-                        "requiresAuthentication": false,
-                        "dueDate": "2020-03-05T16:42:31.7836281Z",
-                        "availablePayments": null
-                      }
-                    ],
-                    "payments": [],
-                    "giftCards": [],
-                    "giftCardMessages": [],
-                    "availableAccounts": [],
-                    "availableTokens": []
-                  },
-                  "marketingData": null,
-                  "sellers": [
-                    {
-                      "id": "1",
-                      "name": "lojadobreno",
-                      "logo": ""
-                    }
-                  ],
-                  "clientPreferencesData": {
-                    "locale": "pt-BR",
-                    "optinNewsLetter": null
-                  },
-                  "commercialConditionData": null,
-                  "storePreferencesData": {
-                    "countryCode": "BRA",
-                    "saveUserData": true,
-                    "timeZone": "E. South America Standard Time",
-                    "currencyCode": "BRL",
-                    "currencyLocale": 1046,
-                    "currencySymbol": "R$",
-                    "currencyFormatInfo": {
-                      "currencyDecimalDigits": 2,
-                      "currencyDecimalSeparator": ",",
-                      "currencyGroupSeparator": ".",
-                      "currencyGroupSize": 3,
-                      "startsWithCurrencySymbol": true
-                    }
-                  },
-                  "giftRegistryData": null,
-                  "openTextField": null,
-                  "invoiceData": null,
-                  "customData": {
-                    "customApps": [
-                      {
-                        "fields": {
-                          "testField2": "testValue2"
-                        },
-                        "id": "abcd",
-                        "major": 1
-                      }
-                    ]
-                  },
-                  "itemMetadata": {
-                    "items": [
-                      {
-                        "id": "1",
-                        "seller": "1",
-                        "name": "Ração Royal Canin Feline Urinary 500g",
-                        "skuName": "Ração Royal Canin Feline Urinary 500g",
-                        "productId": "1",
-                        "refId": "0001",
-                        "ean": "123456789",
-                        "imageUrl": "http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000",
-                        "detailUrl": "/racao-royal-canin-feline-urinary/p",
-                        "assemblyOptions": []
-                      }
-                    ]
-                  },
-                  "hooksData": null,
-                  "ratesAndBenefitsData": {
-                    "rateAndBenefitsIdentifiers": [],
-                    "teaser": []
-                  },
-                  "subscriptionData": null,
-                  "itemsOrdination": null
-                }
-              }
-            }
-          }
-        },
-        "deprecated": false
-      }
-    },
-    "/api/checkout/pvt/configuration/orderForm": {
-      "get": {
-        "tags": [
-          "Configuration"
-        ],
-        "summary": "Get orderForm configuration",
-        "description": "Retrieves the settings that are currently applied to every orderForm in the account.\n\r\n\rThese settings are defined by the request [Update orderForm configuration](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pvt/configuration/orderForm).\n\r\n\rAlways use this request to retrieve the current configuration before performing an update. By doing so you ensure that you are modifying only the properties you want.",
-        "operationId": "GetorderFormconfiguration",
-        "parameters": [
-          {
-            "name": "Content-Type",
-            "in": "header",
-            "description": "Type of the content being sent.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "Accept",
-            "in": "header",
-            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "",
-            "headers": {},
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "object",
-                  "properties": {
-                    "paymentConfiguration": {
-                      "type": "object",
-                      "description": "Payment configuration information.",
-                      "properties": {
-                        "requiresAuthenticationForPreAuthorizedPaymentOption": {
-                          "type": "boolean",
-                          "description": "Determines whether pre-authorized payments require authentication."
-                        },
-                        "allowInstallmentsMerge": {
-                          "type": "boolean",
-                          "description": "By default (when `false`), on a multi-seller purchase is on the run, a simple intersection with installment options configured by every seller will be available. When indicated as `true`, this option allows a more complex but flexible installment option, since it considers max installments of every seller configuration, even if those do not match. Installment values may not be equal in this case."
-                        }
-                      }
-                    },
-                    "taxConfiguration": {
-                      "type": "object",
-                      "description": "External tax service configuration information.",
-                      "nullable": true,
-                      "properties": {
-                        "url": {
-                          "type": "string",
-                          "description": "Endpoint URL.",
-                          "nullable": true
-                        },
-                        "authorizationHeader": {
-                          "type": "string",
-                          "description": "Authorization header.",
-                          "nullable": true
-                        },
-                        "appId": {
-                          "type": "string",
-                          "description": "Custom data ID sent to the tax system."
-                        }
-                      }
-                    },
-                    "minimumQuantityAccumulatedForItems": {
-                      "type": "integer",
-                      "description": "Minimum SKU quantity by cart."
-                    },
-                    "decimalDigitsPrecision": {
-                      "type": "integer",
-                      "description": "Number of price digits."
-                    },
-                    "minimumValueAccumulated": {
-                      "type": "integer",
-                      "description": "Minimum cart value.",
-                      "nullable": true
-                    },
-                    "apps": {
-                      "type": "array",
-                      "nullable": true,
-                      "description": "Array of objects containing Apps configuration information.",
-                      "items": {
-                        "type": "object",
-                        "properties": {
-                          "id": {
-                            "type": "string",
-                            "description": "App ID."
-                          },
-                          "fields": {
-                            "type": "array",
-                            "description": "Array of fields available to the app.",
-                            "items": {
-                              "type": "string"
-                            }
-                          },
-                          "major": {
-                            "type": "integer",
-                            "description": "App major version."
-                          }
-                        }
-                      }
-                    },
-                    "allowMultipleDeliveries": {
-                      "type": "boolean",
-                      "description": "On the same purchase, allows the selection of items from multiple delivery channels.",
-                      "nullable": true
-                    },
-                    "allowManualPrice": {
-                      "type": "boolean",
-                      "description": "Allows the editing of SKU prices right in the cart.",
-                      "nullable": true
-                    },
-                    "savePersonalDataAsOptIn": {
-                      "type": "boolean",
-                      "description": "Allows users to select whether they want the store to keep their personal and payment data saved.",
-                      "nullable": true
-                    },
-                    "maxNumberOfWhiteLabelSellers": {
-                      "type": "integer",
-                      "description": "Allows the input of a limit of white label sellers involved on the cart.",
-                      "nullable": true
-                    },
-                    "maskFirstPurchaseData": {
-                      "type": "boolean",
-                      "description": "Allows, on a first purchase, masking client's data. It could be useful when a shared cart is used and the client does not want to share its data.",
-                      "nullable": true
-                    },
-                    "recaptchaValidation": {
-                      "type": "string",
-                      "description": "Configures reCAPTCHA validation for the account, defining in which situations the shopper will be prompted to validate a purchase with reCAPTCHA. Learn more about [reCAPTCHA validation for VTEX stores](https://help.vtex.com/en/tutorial/using-recaptcha-at-checkout--18Te3oDd7f4qcjKu9jhNzP)\n\r\n\rPossible values are:\n\r- `\"never\"`: no purchases are validated with reCAPTCHA.\n\r- `\"always\"`: every purchase is validated with reCAPTCHA.\n\r- `\"vtexCriteria\"`: only some purchases are validated with reCAPTCHA in order to minimize friction and improve shopping experience. VTEX's algorithm determines which sessions are trustworthy and which should be validated with reCAPTCHA. This is the recommended option.",
-                      "default": "vtexCriteria"
-                    },
-                    "requiresLoginToPlaceOrder": {
-                      "type": "boolean",
-                      "description": "Indicates whether authentication is required for completing purchases.",
-                      "example": true
-                    },
-                    "minimumPurchaseDowntimeSeconds": {
-                      "type": "integer",
-                      "description": "Minimum interval (in seconds) between successive purchases.",
-                      "example": 90
-                    },
-                    "cartAgeToUseNewCardSeconds": {
-                      "type": "integer",
-                      "description": "Minimum cart existence period (in seconds) before allowing the use of a new credit card.",
-                      "example": 30
-                    }
-                  }
-                },
-                "example": {
-                  "paymentConfiguration": {
-                    "requiresAuthenticationForPreAuthorizedPaymentOption": false,
-                    "allowInstallmentsMerge": false,
-                    "blockPaymentSession": null
-                  },
-                  "taxConfiguration": null,
-                  "minimumQuantityAccumulatedForItems": 1,
-                  "decimalDigitsPrecision": 2,
-                  "minimumValueAccumulated": null,
-                  "apps": [
-                    {
-                      "fields": [
-                        "name",
-                        "age"
-                      ],
-                      "id": "abcd",
-                      "major": 1
-                    }
-                  ],
-                  "allowMultipleDeliveries": false,
-                  "allowManualPrice": true,
-                  "savePersonalDataAsOptIn": false,
-                  "maxNumberOfWhiteLabelSellers": null,
-                  "maskFirstPurchaseData": null,
-                  "recaptchaValidation": "vtexCriteria",
-                  "requiresLoginToPlaceOrder": true,
-                  "minimumPurchaseDowntimeSeconds": 90,
-                  "cartAgeToUseNewCardSeconds": 30
-                }
-              }
-            }
-          }
-        },
-        "deprecated": false
-      },
-      "post": {
-        "tags": [
-          "Configuration"
-        ],
-        "summary": "Update orderForm configuration",
-        "description": "Determines settings that will apply to every orderForm in the account.\n\r\n\rFor example, if you create an app using this request, every orderForm of this account will have the custom fields created though it.\n\r\n\r>ℹ️ 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).",
-        "operationId": "UpdateorderFormconfiguration",
-        "parameters": [
-          {
-            "name": "Content-Type",
-            "in": "header",
-            "description": "Type of the content being sent.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "Accept",
-            "in": "header",
-            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          }
-        ],
-        "requestBody": {
-          "description": "",
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/UpdateorderFormconfigurationRequest"
-              },
-              "example": {
-                "paymentConfiguration": {
-                  "requiresAuthenticationForPreAuthorizedPaymentOption": false
-                },
-                "taxConfiguration": null,
-                "minimumQuantityAccumulatedForItems": 1,
-                "decimalDigitsPrecision": 2,
-                "minimumValueAccumulated": null,
-                "apps": null,
-                "allowMultipleDeliveries": null,
-                "allowManualPrice": null,
-                "requiresLoginToPlaceOrder": true,
-                "minimumPurchaseDowntimeSeconds": 90,
-                "cartAgeToUseNewCardSeconds": 30
-              }
-            }
-          },
-          "required": true
-        },
-        "responses": {
-          "204": {
-            "description": "",
-            "headers": {}
-          }
-        },
-        "deprecated": false
-      }
-    },
-    "/api/checkout/pvt/configuration/window-to-change-seller": {
-      "get": {
-        "tags": [
-          "Configuration"
-        ],
-        "summary": "Get window to change seller",
-        "description": "Retrieves a marketplace’s window to change seller, that is, the period when it is possible to choose another seller to fulfill a given order after the original seller has canceled it.\n\r\n\rThe default period for this window is of 2 days, but it can be configured by the request Update window to change seller.",
-        "operationId": "GetWindowToChangeSeller",
-        "parameters": [
-          {
-            "name": "Content-Type",
-            "in": "header",
-            "description": "Type of the content being sent.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "Accept",
-            "in": "header",
-            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "OK",
-            "content": {
-              "text/plain": {
-                "example": "2"
-              }
-            }
-          }
-        },
-        "deprecated": false
-      },
-      "post": {
-        "tags": [
-          "Configuration"
-        ],
-        "summary": "Update window to change seller",
-        "description": "Updates a marketplace’s window to change seller, that is, the period when it is possible to choose another seller to fulfill a given order after the original seller has canceled it.\n\r\n\rIt is possible to check the current window using the request Get window to change seller.",
-        "operationId": "UpdateWindowToChangeSeller",
-        "parameters": [
-          {
-            "name": "Content-Type",
-            "in": "header",
-            "description": "Type of the content being sent.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "Accept",
-            "in": "header",
-            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          }
-        ],
-        "requestBody": {
-          "description": "",
-          "content": {
-            "application/json": {
-              "schema": {
-                "$ref": "#/components/schemas/WaitingTime"
-              },
-              "example": {
-                "waitingTime": 4
-              }
-            }
-          },
-          "required": true
-        },
-        "responses": {
-          "201": {
-            "description": "Created",
-            "headers": {}
-          }
-        },
-        "deprecated": false
-      }
-    },
-    "/api/checkout/pub/orderForm/{orderFormId}/messages/clear": {
-      "post": {
-        "tags": [
-          "Configuration"
-        ],
-        "summary": "Clear orderForm messages",
-        "description": "This request removes all messages from the `messages` field of the orderForm , leaving it empty.\r\n\r\nYou must send an empty JSON in the body of the request.\r\n\r\nThe [orderForm](https://developers.vtex.com/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.\r\n\r\n**Important**: **Request Body** must always be sent with empty value \"{ }\" in this endpoint.",
-        "operationId": "ClearorderFormMessages",
-        "security": [],
-        "parameters": [
-          {
-            "name": "orderFormId",
-            "in": "path",
-            "description": "ID of the orderForm corresponding to the cart whose messages you want to remove.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "ede846222cd44046ba6c638442c3505a"
-            }
-          },
-          {
-            "name": "Content-Type",
-            "in": "header",
-            "description": "Type of the content being sent.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "Accept",
-            "in": "header",
-            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          }
-        ],
-        "requestBody": {
-          "description": "",
-          "content": {
-            "application/json": {
-              "schema": {
-                "type": "object",
-                "description": "This object must be empty.",
-                "title": "",
-                "properties": {},
-                "default": {}
-              }
-            }
-          }
-        },
-        "responses": {
-          "200": {
-            "description": "OK",
-            "headers": {},
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "object",
-                  "properties": {
-                    "orderFormId": {
-                      "type": "string",
-                      "description": "ID of the orderForm corresponding to a specific cart."
-                    },
-                    "salesChannel": {
-                      "type": "string",
-                      "description": "Attribute created by the seller, in their VTEX store configuration."
-                    },
-                    "loggedIn": {
-                      "type": "boolean",
-                      "description": "Indicates whether the user is logged into the store."
-                    },
-                    "isCheckedIn": {
-                      "type": "boolean",
-                      "description": "Indicates whether order is checked in."
-                    },
-                    "storeId": {
-                      "type": "string",
-                      "description": "ID of the store.",
-                      "nullable": true
-                    },
-                    "allowManualPrice": {
-                      "type": "boolean",
-                      "description": "Permission to modify item price manually."
-                    },
-                    "canEditData": {
-                      "type": "boolean",
-                      "description": "Data can be edited."
-                    },
-                    "userProfileId": {
-                      "type": "string",
-                      "description": "Unique ID associated with the customer profile."
-                    },
-                    "profileProvider": {
-                      "type": "string",
-                      "description": "Profile provider."
-                    },
-                    "availableAccounts": {
-                      "type": "array",
-                      "description": "Available accounts.",
-                      "items": {
-                        "type": "string"
-                      }
-                    },
-                    "availableAddresses": {
-                      "type": "array",
-                      "description": "Information on each available address.",
-                      "items": {
-                        "type": "object",
-                        "properties": {
-                          "addressType": {
-                            "type": "string",
-                            "description": "Address type."
-                          },
-                          "receiverName": {
-                            "type": "string",
-                            "description": "Name of the receiver."
-                          },
-                          "addressId": {
-                            "type": "string",
-                            "description": "Address ID."
-                          },
-                          "isDisposable": {
-                            "type": "boolean",
-                            "description": "Indicates whether address is disposable."
-                          },
-                          "city": {
-                            "type": "string",
-                            "description": "City of the address."
-                          },
-                          "state": {
-                            "type": "string",
-                            "description": "State of the address."
-                          },
-                          "country": {
-                            "type": "string",
-                            "description": "Country of the address. ISO three-letter code."
-                          },
-                          "street": {
-                            "type": "string",
-                            "description": "Street of the address."
-                          },
-                          "number": {
-                            "type": "string",
-                            "description": "Number of the address."
-                          },
-                          "neighborhood": {
-                            "type": "string",
-                            "description": "Neighborhood of the address."
-                          },
-                          "complement": {
-                            "type": "string",
-                            "description": "Complement to the address.",
-                            "nullable": true
-                          },
-                          "reference": {
-                            "type": "string",
-                            "description": "Reference that may help in the location of the address.",
-                            "nullable": true
-                          },
-                          "geoCoordinates": {
-                            "type": "array",
-                            "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
-                            "items": {
-                              "type": "number"
-                            }
-                          }
-                        }
-                      }
-                    },
-                    "userType": {
-                      "type": "string",
-                      "description": "User type.",
-                      "nullable": true
-                    },
-                    "ignoreProfileData": {
-                      "type": "boolean",
-                      "description": "Ignore customer profile data."
-                    },
-                    "value": {
-                      "type": "integer",
-                      "description": "Total value of the order without separating cents. For example, $24.99 is represented `2499`."
-                    },
-                    "messages": {
-                      "type": "array",
-                      "description": "Array containing an object for each message generated by our servers while processing the request."
-                    },
-                    "items": {
-                      "type": "array",
-                      "description": "Information on each item in the order.",
-                      "items": {
-                        "type": "object",
-                        "properties": {
-                          "uniqueId": {
-                            "type": "string",
-                            "description": "Unique ID."
-                          },
-                          "id": {
-                            "type": "string",
-                            "description": "ID of the item."
-                          },
-                          "productId": {
-                            "type": "string",
-                            "description": "Product ID."
-                          },
-                          "productRefId": {
-                            "type": "string",
-                            "description": "Product Ref ID."
-                          },
-                          "refId": {
-                            "type": "string",
-                            "description": "Ref ID."
-                          },
-                          "ean": {
-                            "type": "string",
-                            "description": "European Article Number.",
-                            "nullable": true
-                          },
-                          "name": {
-                            "type": "string",
-                            "description": "Product name."
-                          },
-                          "skuName": {
-                            "type": "string",
-                            "description": "SKU name."
-                          },
-                          "modalType": {
-                            "type": "string",
-                            "description": "Modal type.",
-                            "nullable": true
-                          },
-                          "parentItemIndex": {
-                            "type": "integer",
-                            "description": "Parent item index.",
-                            "nullable": true
-                          },
-                          "parentAssemblyBinding": {
-                            "type": "string",
-                            "description": "Parent assembly binding.",
-                            "nullable": true
-                          },
-                          "priceValidUntil": {
-                            "type": "string",
-                            "description": "Price expiration date and time."
-                          },
-                          "tax": {
-                            "type": "integer",
-                            "description": "Tax value in cents."
-                          },
-                          "price": {
-                            "type": "integer",
-                            "description": "Price in cents."
-                          },
-                          "listPrice": {
-                            "type": "integer",
-                            "description": "List price in cents."
-                          },
-                          "manualPrice": {
-                            "type": "integer",
-                            "description": "Manual price in cents.",
-                            "nullable": true
-                          },
-                          "manualPriceAppliedBy": {
-                            "type": "string",
-                            "description": "User that applied the manual price, if that is the case.",
-                            "nullable": true
-                          },
-                          "sellingPrice": {
-                            "type": "integer",
-                            "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
-                          },
-                          "rewardValue": {
-                            "type": "integer",
-                            "description": "Reward value in cents."
-                          },
-                          "isGift": {
-                            "type": "boolean",
-                            "description": "Indicates whether item is a gift."
-                          },
-                          "additionalInfo": {
-                            "type": "object",
-                            "description": "Additional information.",
-                            "properties": {
-                              "dimension": {
-                                "type": "string",
-                                "description": "Dimension.",
-                                "nullable": true
-                              },
-                              "brandName": {
-                                "type": "string",
-                                "description": "Brand name."
-                              },
-                              "brandId": {
-                                "type": "string",
-                                "description": "Brand ID."
-                              },
-                              "offeringInfo": {
-                                "type": "string",
-                                "description": "Offering information.",
-                                "nullable": true
-                              },
-                              "offeringType": {
-                                "type": "string",
-                                "description": "Offering type.",
-                                "nullable": true
-                              },
-                              "offeringTypeId": {
-                                "type": "string",
-                                "description": "Offering type ID.",
-                                "nullable": true
-                              }
-                            }
-                          },
-                          "preSaleDate": {
-                            "type": "string",
-                            "description": "Presale date.",
-                            "nullable": true
-                          },
-                          "productCategoryIds": {
-                            "type": "string",
-                            "description": "Product category IDs."
-                          },
-                          "productCategories": {
-                            "type": "object",
-                            "description": "Object, where each field is an ID from `productCategoryIds`.",
-                            "properties": {
-                              "{ID}": {
-                                "type": "string",
-                                "description": "Product category corresponding to the ID in the field key."
-                              }
-                            }
-                          },
-                          "quantity": {
-                            "type": "integer",
-                            "description": "Quantity."
-                          },
-                          "seller": {
-                            "type": "string",
-                            "description": "Seller."
-                          },
-                          "sellerChain": {
-                            "type": "array",
-                            "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
-                            "items": {
-                              "type": "string",
-                              "description": "Seller."
-                            }
-                          },
-                          "imageUrl": {
-                            "type": "string",
-                            "description": "Image URL."
-                          },
-                          "detailUrl": {
-                            "type": "string",
-                            "description": "Detail URL."
-                          },
-                          "bundleItems": {
-                            "type": "array",
-                            "description": "Information on services sold along with the SKU. Example: a gift package.",
-                            "items": {
-                              "type": "object",
-                              "properties": {
-                                "type": {
-                                  "type": "string",
-                                  "description": "Service type."
-                                },
-                                "id": {
-                                  "type": "integer",
-                                  "description": "Service identifier."
-                                },
-                                "name": {
-                                  "type": "string",
-                                  "description": "Service name."
-                                },
-                                "price": {
-                                  "type": "integer",
-                                  "description": "Service price in cents."
-                                }
-                              }
-                            }
-                          },
-                          "attachments": {
-                            "type": "array",
-                            "description": "Array containing information on attachments.",
-                            "items": {
-                              "type": "string"
-                            }
-                          },
-                          "priceTags": {
-                            "type": "array",
-                            "description": "Array of price tags, each of which, modifies the price in some way, like discounts or rates that apply to the item in the context of the order.",
-                            "items": {
-                              "type": "object",
-                              "properties": {
-                                "identifier": {
-                                  "type": "string",
-                                  "description": "Price tag identifier."
-                                },
-                                "isPercentual": {
-                                  "type": "boolean",
-                                  "description": "Indicates whether price tag value is applied through a percentage."
-                                },
-                                "name": {
-                                  "type": "string",
-                                  "description": "Price tag name."
-                                },
-                                "rawValue": {
-                                  "type": "integer",
-                                  "description": "Price tag raw value."
-                                },
-                                "value": {
-                                  "type": "integer",
-                                  "description": "Price tag value."
-                                }
-                              }
-                            }
-                          },
-                          "availability": {
-                            "type": "string",
-                            "description": "Availability."
-                          },
-                          "measurementUnit": {
-                            "type": "string",
-                            "description": "Measurement unit."
-                          },
-                          "unitMultiplier": {
-                            "type": "integer",
-                            "description": "Unit multiplier."
-                          },
-                          "manufacturerCode": {
-                            "type": "string",
-                            "description": "Manufacturer code.",
-                            "nullable": true
-                          },
-                          "priceDefinition": {
-                            "type": "object",
-                            "description": "Price information for all units of a specific item.",
-                            "properties": {
-                              "calculatedSellingPrice": {
-                                "type": "integer",
-                                "description": "Item's calculated unitary selling price in cents."
-                              },
-                              "total": {
-                                "type": "integer",
-                                "description": "Total value for all units of the item in cents."
-                              },
-                              "sellingPrices": {
-                                "type": "array",
-                                "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
-                                "items": {
-                                  "type": "object",
-                                  "properties": {
-                                    "value": {
-                                      "type": "integer",
-                                      "description": "Value in cents for that specific rounding."
-                                    },
-                                    "quantity": {
-                                      "type": "integer",
-                                      "description": "Rounding quantity, meaning how many items are rounded to this value."
-                                    }
-                                  }
-                                }
-                              }
-                            }
-                          }
-                        }
-                      }
-                    },
-                    "selectableGifts": {
-                      "type": "array",
-                      "description": "Array containing the data of the item selected as a gift."
-                    },
-                    "totalizers": {
-                      "type": "array",
-                      "description": "Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value)."
-                    },
-                    "shippingData": {
-                      "type": "object",
-                      "description": "Shipping information pertinent to the order.",
-                      "properties": {
-                        "address": {
-                          "type": "object",
-                          "description": "Address information.",
-                          "properties": {
-                            "addressType": {
-                              "type": "string",
-                              "description": "Type of address. For example, `Residential` or `Pickup`."
-                            },
-                            "receiverName": {
-                              "type": "string",
-                              "description": "Name of the person who is going to receive the order."
-                            },
-                            "addressId": {
-                              "type": "string",
-                              "description": "Address ID."
-                            },
-                            "isDisposable": {
-                              "type": "boolean",
-                              "description": "Indicates whether address is disposable."
-                            },
-                            "postalCode": {
-                              "type": "string",
-                              "description": "Postal code."
-                            },
-                            "city": {
-                              "type": "string",
-                              "description": "City of the shipping address."
-                            },
-                            "state": {
-                              "type": "string",
-                              "description": "State of the shipping address."
-                            },
-                            "country": {
-                              "type": "string",
-                              "description": "Three letter ISO code of the country of the shipping address."
-                            },
-                            "street": {
-                              "type": "string",
-                              "description": "Street of the shipping address."
-                            },
-                            "number": {
-                              "type": "string",
-                              "description": "Number of the building, house or apartment in the shipping address."
-                            },
-                            "neighborhood": {
-                              "type": "string",
-                              "description": "Neighborhood of the shipping address."
-                            },
-                            "complement": {
-                              "type": "string",
-                              "description": "Complement to the shipping address, in case it applies.",
-                              "nullable": true
-                            },
-                            "reference": {
-                              "type": "string",
-                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
-                              "nullable": true
-                            },
-                            "geoCoordinates": {
-                              "type": "array",
-                              "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
-                              "items": {
-                                "type": "number"
-                              }
-                            }
-                          }
-                        },
-                        "logisticsInfo": {
-                          "type": "array",
-                          "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "itemIndex": {
-                                "type": "integer",
-                                "description": "Index corresponding to the position of the object in the `items` array."
-                              },
-                              "selectedSla": {
-                                "type": "string",
-                                "description": "SLA selected by the customer."
-                              },
-                              "selectedDeliveryChannel": {
-                                "type": "string",
-                                "description": "Delivery channel selected by the customer."
-                              },
-                              "addressId": {
-                                "type": "string",
-                                "description": "Address ID."
-                              },
-                              "slas": {
-                                "type": "array",
-                                "description": "Information on available SLAs.",
-                                "items": {
-                                  "type": "object",
-                                  "properties": {
-                                    "id": {
-                                      "type": "string",
-                                      "description": "SLA ID."
-                                    },
-                                    "deliveryChannel": {
-                                      "type": "string",
-                                      "description": "Delivery channel."
-                                    },
-                                    "name": {
-                                      "type": "string",
-                                      "description": "SLA name."
-                                    },
-                                    "deliveryIds": {
-                                      "type": "array",
-                                      "description": "Information on each delivery ID.",
-                                      "items": {
-                                        "type": "object",
-                                        "properties": {
-                                          "courierId": {
-                                            "type": "string",
-                                            "description": "Courier ID."
-                                          },
-                                          "warehouseId": {
-                                            "type": "string",
-                                            "description": "Warehouse ID."
-                                          },
-                                          "dockId": {
-                                            "type": "string",
-                                            "description": "Warehouse ID."
-                                          },
-                                          "courierName": {
-                                            "type": "string",
-                                            "description": "Courier name."
-                                          },
-                                          "quantity": {
-                                            "type": "integer",
-                                            "description": "Quantity."
-                                          }
-                                        }
-                                      }
-                                    },
-                                    "shippingEstimate": {
-                                      "type": "string",
-                                      "description": "Shipping estimate. For instance, Three business days will be represented `3bd`."
-                                    },
-                                    "shippingEstimateDate": {
-                                      "type": "string",
-                                      "description": "Shipping estimate date.",
-                                      "nullable": true
-                                    },
-                                    "lockTTL": {
-                                      "type": "string",
-                                      "description": "Estimate date of delivery."
-                                    },
-                                    "price": {
-                                      "type": "integer",
-                                      "description": "Price in cents."
-                                    },
-                                    "listPrice": {
-                                      "type": "integer",
-                                      "description": "List price in cents."
-                                    },
-                                    "tax": {
-                                      "type": "integer",
-                                      "description": "Tax in cents."
-                                    },
-                                    "pickupStoreInfo": {
-                                      "type": "object",
-                                      "description": "Information on the pickup store.",
-                                      "properties": {
-                                        "isPickupStore": {
-                                          "type": "boolean",
-                                          "description": "Indicates whether it is the pickup store."
-                                        },
-                                        "friendlyName": {
-                                          "type": "string",
-                                          "description": "Friendly name.",
-                                          "nullable": true
-                                        },
-                                        "address": {
-                                          "type": "object",
-                                          "description": "Address information.",
-                                          "nullable": true,
-                                          "properties": {
-                                            "addressType": {
-                                              "type": "string",
-                                              "description": "Type of address. For example, `Residential` or `Pickup`."
-                                            },
-                                            "postalCode": {
-                                              "type": "string",
-                                              "description": "Postal code."
-                                            },
-                                            "city": {
-                                              "type": "string",
-                                              "description": "City of the shipping address."
-                                            },
-                                            "state": {
-                                              "type": "string",
-                                              "description": "State of the shipping address."
-                                            },
-                                            "country": {
-                                              "type": "string",
-                                              "description": "Three letter ISO code of the country of the shipping address."
-                                            },
-                                            "street": {
-                                              "type": "string",
-                                              "description": "Street of the shipping address."
-                                            },
-                                            "number": {
-                                              "type": "string",
-                                              "description": "Number of the building, house or apartment in the shipping address."
-                                            },
-                                            "neighborhood": {
-                                              "type": "string",
-                                              "description": "Neighborhood of the shipping address."
-                                            },
-                                            "complement": {
-                                              "type": "string",
-                                              "description": "Complement to the shipping address, in case it applies.",
-                                              "nullable": true
-                                            },
-                                            "reference": {
-                                              "type": "string",
-                                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
-                                              "nullable": true
-                                            },
-                                            "geoCoordinates": {
-                                              "type": "array",
-                                              "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
-                                              "items": {
-                                                "type": "number"
-                                              }
-                                            }
-                                          }
-                                        },
-                                        "additionalInfo": {
-                                          "type": "string",
-                                          "description": "Additional information.",
-                                          "nullable": true
-                                        },
-                                        "dockId": {
-                                          "type": "string",
-                                          "description": "Corresponding dock ID.",
-                                          "nullable": true
-                                        }
-                                      }
-                                    },
-                                    "pickupPointId": {
-                                      "type": "string",
-                                      "description": "Pickup point ID.",
-                                      "nullable": true
-                                    },
-                                    "pickupDistance": {
-                                      "type": "integer",
-                                      "description": "Pickup point distance."
-                                    },
-                                    "polygonName": {
-                                      "type": "string",
-                                      "description": "Polygon name.",
-                                      "nullable": true
-                                    },
-                                    "transitTime": {
-                                      "type": "string",
-                                      "description": "Transit time. For instance, \"three business days\" is represented `3bd`."
-                                    }
-                                  }
-                                }
-                              },
-                              "shipsTo": {
-                                "type": "array",
-                                "description": "List of countries that the item may be shipped to.",
-                                "items": {
-                                  "type": "string",
-                                  "description": "Three letter country code."
-                                }
-                              },
-                              "itemId": {
-                                "type": "string",
-                                "description": "Item ID."
-                              },
-                              "deliveryChannels": {
-                                "type": "array",
-                                "description": "List of available delivery channels.",
-                                "items": {
-                                  "type": "object",
-                                  "properties": {
-                                    "id": {
-                                      "type": "string",
-                                      "description": "Delivery channel ID."
-                                    }
-                                  }
-                                }
-                              }
-                            }
-                          }
-                        },
-                        "selectedAddresses": {
-                          "type": "array",
-                          "description": "Array with information on the selected addresses for the order.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "addressType": {
-                                "type": "string",
-                                "description": "Type of address. For example, `Residential` or `Pickup`."
-                              },
-                              "receiverName": {
-                                "type": "string",
-                                "description": "Name of the person who is going to receive the order."
-                              },
-                              "addressId": {
-                                "type": "string",
-                                "description": "Address ID."
-                              },
-                              "isDisposable": {
-                                "type": "boolean",
-                                "description": "Indicates whether address is disposable."
-                              },
-                              "postalCode": {
-                                "type": "string",
-                                "description": "Postal code."
-                              },
-                              "city": {
-                                "type": "string",
-                                "description": "City of the shipping address."
-                              },
-                              "state": {
-                                "type": "string",
-                                "description": "State of the shipping address."
-                              },
-                              "country": {
-                                "type": "string",
-                                "description": "Three letter ISO code of the country of the shipping address."
-                              },
-                              "street": {
-                                "type": "string",
-                                "description": "Street of the shipping address."
-                              },
-                              "number": {
-                                "type": "string",
-                                "description": "Number of the building, house or apartment in the shipping address."
-                              },
-                              "neighborhood": {
-                                "type": "string",
-                                "description": "Neighborhood of the shipping address."
-                              },
-                              "complement": {
-                                "type": "string",
-                                "description": "Complement to the shipping address, in case it applies."
-                              },
-                              "reference": {
-                                "type": "string",
-                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
-                                "nullable": true
-                              },
-                              "geoCoordinates": {
-                                "type": "array",
-                                "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
-                                "items": {
-                                  "type": "number"
-                                }
-                              }
-                            }
-                          }
-                        },
-                        "availableAddresses": {
-                          "type": "array",
-                          "description": "Array with information on the available addresses for the order.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "addressType": {
-                                "type": "string",
-                                "description": "Type of address. For example, `Residential` or `Pickup`."
-                              },
-                              "receiverName": {
-                                "type": "string",
-                                "description": "Name of the person who is going to receive the order."
-                              },
-                              "addressId": {
-                                "type": "string",
-                                "description": "Address ID."
-                              },
-                              "isDisposable": {
-                                "type": "boolean",
-                                "description": "Indicates whether address is disposable."
-                              },
-                              "postalCode": {
-                                "type": "string",
-                                "description": "Postal code."
-                              },
-                              "city": {
-                                "type": "string",
-                                "description": "City of the shipping address."
-                              },
-                              "state": {
-                                "type": "string",
-                                "description": "State of the shipping address."
-                              },
-                              "country": {
-                                "type": "string",
-                                "description": "Three letter ISO code of the country of the shipping address."
-                              },
-                              "street": {
-                                "type": "string",
-                                "description": "Street of the shipping address."
-                              },
-                              "number": {
-                                "type": "string",
-                                "description": "Number of the building, house or apartment in the shipping address."
-                              },
-                              "neighborhood": {
-                                "type": "string",
-                                "description": "Neighborhood of the shipping address."
-                              },
-                              "complement": {
-                                "type": "string",
-                                "description": "Complement to the shipping address, in case it applies."
-                              },
-                              "reference": {
-                                "type": "string",
-                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
-                                "nullable": true
-                              },
-                              "geoCoordinates": {
-                                "type": "array",
-                                "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
-                                "items": {
-                                  "type": "number"
-                                }
-                              }
-                            }
-                          }
-                        }
-                      }
-                    },
-                    "clientProfileData": {
-                      "type": "object",
-                      "description": "Customer's profile information.",
-                      "properties": {
-                        "email": {
-                          "type": "string",
-                          "description": "Email address."
-                        },
-                        "firstName": {
-                          "type": "string",
-                          "description": "First name."
-                        },
-                        "lastName": {
-                          "type": "string",
-                          "description": "Last name."
-                        },
-                        "documentType": {
-                          "type": "string",
-                          "description": "Type of the document informed by the customer."
-                        },
-                        "document": {
-                          "type": "string",
-                          "description": "Document informed by the customer."
-                        },
-                        "phone": {
-                          "type": "string",
-                          "description": "Phone number."
-                        },
-                        "corporateName": {
-                          "type": "string",
-                          "description": "Company name, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "tradeName": {
-                          "type": "string",
-                          "description": "Trade name, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "corporateDocument": {
-                          "type": "string",
-                          "description": "Corporate document, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "stateInscription": {
-                          "type": "string",
-                          "description": "State inscription, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "corporatePhone": {
-                          "type": "string",
-                          "description": "Corporate phone number, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "isCorporate": {
-                          "type": "boolean",
-                          "description": "Indicates whether the customer is a legal entity."
-                        },
-                        "profileCompleteOnLoading": {
-                          "type": "boolean",
-                          "description": "Indicates whether profile is complete on loading."
-                        },
-                        "profileErrorOnLoading": {
-                          "type": "boolean",
-                          "description": "Indicates whether profile presents error on loading.",
-                          "nullable": true
-                        },
-                        "customerClass": {
-                          "type": "string",
-                          "description": "Customer class.",
-                          "nullable": true
-                        }
-                      }
-                    },
-                    "paymentData": {
-                      "type": "object",
-                      "description": "Information on the order's payment.",
-                      "properties": {
-                        "giftCards": {
-                          "type": "array",
-                          "description": "Gift card information, if it applies to the order.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "redemptionCode": {
-                                "type": "string",
-                                "description": "Gift card redemption code."
-                              },
-                              "value": {
-                                "type": "integer",
-                                "description": "Gift card value in cents."
-                              },
-                              "balance": {
-                                "type": "integer",
-                                "description": "Gift card balance in cents."
-                              },
-                              "name": {
-                                "type": "string",
-                                "description": "Gift card name."
-                              },
-                              "id": {
-                                "type": "string",
-                                "description": "Gift card ID."
-                              },
-                              "inUse": {
-                                "type": "boolean",
-                                "description": "Indicates whether gift card is in use."
-                              },
-                              "isSpecialCard": {
-                                "type": "boolean",
-                                "description": "Indicates whether gift card is special."
-                              }
-                            }
-                          }
-                        },
-                        "transactions": {
-                          "type": "array",
-                          "description": "Information on each transaction pertinent to the order.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "isActive": {
-                                "type": "boolean",
-                                "description": "Indicates whether transaction is active."
-                              },
-                              "transactionId": {
-                                "type": "string",
-                                "description": "Transaction ID."
-                              },
-                              "merchantName": {
-                                "type": "string",
-                                "description": "Merchant name."
-                              },
-                              "payments": {
-                                "type": "array",
-                                "description": "Information on each payment.",
-                                "items": {
-                                  "type": "object",
-                                  "properties": {
-                                    "accountId": {
-                                      "type": "string",
-                                      "description": "Account ID."
-                                    },
-                                    "bin": {
-                                      "type": "string",
-                                      "description": "Bin."
-                                    },
-                                    "installments": {
-                                      "type": "integer",
-                                      "description": "Number of installments."
-                                    },
-                                    "paymentSystem": {
-                                      "type": "string",
-                                      "description": "Payment system."
-                                    },
-                                    "referenceValue": {
-                                      "type": "integer",
-                                      "description": "Reference value for calculating interest rates, in case it applies. Displayed in cents."
-                                    },
-                                    "value": {
-                                      "type": "integer",
-                                      "description": "Value including interest, in case it applies. Displayed in cents."
-                                    }
-                                  }
-                                }
-                              },
-                              "sharedTransaction": {
-                                "type": "boolean",
-                                "description": "Indicates whather transaction is shared."
-                              }
-                            }
-                          }
-                        }
-                      }
-                    },
-                    "marketingData": {
-                      "type": "object",
-                      "description": "Object containing promotion data such as coupon tracking information and internal or external UTMs.",
-                      "properties": {
-                        "coupon": {
-                          "type": "string",
-                          "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.",
-                          "default": "free-shipping"
-                        },
-                        "utmSource": {
-                          "type": "string",
-                          "description": "UTM source.",
-                          "default": "Facebook"
-                        },
-                        "utmMedium": {
-                          "type": "string",
-                          "description": "UTM medium.",
-                          "default": "CPC"
-                        },
-                        "utmCampaign": {
-                          "type": "string",
-                          "description": "UTM campaign",
-                          "default": "Black friday"
-                        },
-                        "utmiPage": {
-                          "type": "string",
-                          "description": "utmi_page (internal utm)",
-                          "default": "utmi_page-example",
-                          "nullable": true
-                        },
-                        "utmiPart": {
-                          "type": "string",
-                          "description": "utmi_part (internal utm).",
-                          "default": "utmi_part-example",
-                          "nullable": true
-                        },
-                        "utmiCampaign": {
-                          "type": "string",
-                          "description": "utmi_campaign (internal utm).",
-                          "default": "utmi_campaign-example",
-                          "nullable": true
-                        }
-                      }
-                    },
-                    "sellers": {
-                      "type": "array",
-                      "description": "Information on each seller.",
-                      "items": {
-                        "type": "object",
-                        "properties": {
-                          "id": {
-                            "type": "string",
-                            "description": "Seller ID."
-                          },
-                          "name": {
-                            "type": "string",
-                            "description": "Seller name."
-                          },
-                          "logo": {
-                            "type": "string",
-                            "description": "Seller logo.",
-                            "nullable": true
-                          }
-                        }
-                      }
-                    },
-                    "clientPreferencesData": {
-                      "type": "object",
-                      "description": "Object containing preferences from the client who placed the order.",
-                      "properties": {
-                        "locale": {
-                          "type": "string",
-                          "description": "Client's locale. Examples: `pt-BR` and `en-US`."
-                        },
-                        "optinNewsLetter": {
-                          "type": "boolean",
-                          "description": "`true` if the client opted to receive newsletter from the store.",
-                          "default": false
-                        }
-                      }
-                    },
-                    "commercialConditionData": {
-                      "type": "object",
-                      "description": "Object containing commercial condition information.",
-                      "nullable": true
-                    },
-                    "storePreferencesData": {
-                      "type": "object",
-                      "description": "Object containing data from the store's configuration (stored in VTEX's License Manager)."
-                    },
-                    "giftRegistryData": {
-                      "type": "object",
-                      "description": "Gift registry list information.",
-                      "nullable": true
-                    },
-                    "openTextField": {
-                      "type": "string",
-                      "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1).",
-                      "default": "open-text-example",
-                      "nullable": true
-                    },
-                    "invoiceData": {
-                      "type": "object",
-                      "description": "Object containing information pertinent to the order's invoice.",
-                      "nullable": true
-                    },
-                    "customData": {
-                      "type": "object",
-                      "description": "Customer additional information.",
-                      "nullable": true
-                    },
-                    "itemMetadata": {
-                      "type": "object",
-                      "description": "Item metadata.",
-                      "properties": {
-                        "items": {
-                          "type": "array",
-                          "description": "List of objects containing metadata on each item in the order.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "id": {
-                                "type": "string",
-                                "description": "Item ID."
-                              },
-                              "seller": {
-                                "type": "string",
-                                "description": "Seller."
-                              },
-                              "name": {
-                                "type": "string",
-                                "description": "Product name."
-                              },
-                              "skuName": {
-                                "type": "string",
-                                "description": "SKU name."
-                              },
-                              "productId": {
-                                "type": "string",
-                                "description": "Product ID."
-                              },
-                              "refId": {
-                                "type": "string",
-                                "description": "Ref ID."
-                              },
-                              "ean": {
-                                "type": "string",
-                                "description": "European Article Number.",
-                                "nullable": true
-                              },
-                              "imageUrl": {
-                                "type": "string",
-                                "description": "Image URL."
-                              },
-                              "detailUrl": {
-                                "type": "string",
-                                "description": "Detail URL."
-                              }
-                            }
-                          }
-                        }
-                      }
-                    },
-                    "hooksData": {
-                      "type": "object",
-                      "description": "Hooks information.",
-                      "nullable": true
-                    },
-                    "ratesAndBenefitsData": {
-                      "type": "object",
-                      "description": "Information on rates and benefits that apply to the order.",
-                      "properties": {
-                        "rateAndBenefitsIdentifiers": {
-                          "type": "array",
-                          "description": "List with rates and benefits identifiers.",
-                          "items": {
-                            "type": "string"
-                          }
-                        },
-                        "teaser": {
-                          "type": "array",
-                          "description": "List with rates and benefits teasers.",
-                          "items": {
-                            "type": "string"
-                          }
-                        }
-                      }
-                    },
-                    "subscriptionData": {
-                      "type": "object",
-                      "description": "Subscription information.",
-                      "nullable": true
-                    },
-                    "itemsOrdination": {
-                      "type": "object",
-                      "description": "Object containing information about the ordering of items within the orderForm.",
-                      "properties": {
-                        "criteria": {
-                          "type": "string",
-                          "description": "Criteria adopted to order the items in the list."
-                        },
-                        "ascending": {
-                          "type": "boolean",
-                          "description": "Indicates whether the ordering is ascending."
-                        }
-                      }
-                    }
-                  }
-                },
-                "examples": {
-                  "response": {
-                    "value": {
-                      "orderFormId": "ede846222cd44046ba6c638442c3505a",
-                      "salesChannel": "1",
-                      "loggedIn": false,
-                      "isCheckedIn": false,
-                      "storeId": null,
-                      "allowManualPrice": false,
-                      "canEditData": true,
-                      "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
-                      "profileProvider": "VTEX",
-                      "availableAccounts": [],
-                      "availableAddresses": [
-                        {
-                          "addressType": "residential",
-                          "receiverName": "Clark Kent",
-                          "addressId": "666c2e830bd9474ab6f6cc53fb6dd2d2",
-                          "isDisposable": true,
-                          "postalCode": "70386000",
-                          "city": "Brasília",
-                          "state": "DF",
-                          "country": "BRA",
-                          "street": "Rua da minha casa",
-                          "number": "123",
-                          "neighborhood": "Copacabana",
-                          "complement": "15º andar",
-                          "reference": null,
-                          "geoCoordinates": [
-                            -47.924747467041016,
-                            -15.832582473754883
-                          ]
-                        }
-                      ],
-                      "userType": null,
-                      "ignoreProfileData": false,
-                      "value": 34390,
-                      "messages": [],
-                      "items": [
-                        {
-                          "uniqueId": "9D6E447B3FF64CEDA33B17C01379C119",
-                          "id": "2",
-                          "productId": "2",
-                          "productRefId": "",
-                          "refId": "CBC30L",
-                          "ean": null,
-                          "name": "Chopp Brahma Claro 30L",
-                          "skuName": "Chopp Brahma Claro 30L",
-                          "modalType": null,
-                          "parentItemIndex": null,
-                          "parentAssemblyBinding": null,
-                          "assemblies": [],
-                          "priceValidUntil": "2022-07-13T18:30:46Z",
-                          "tax": 0,
-                          "price": 32890,
-                          "listPrice": 49900,
-                          "manualPrice": null,
-                          "manualPriceAppliedBy": null,
-                          "sellingPrice": 32890,
-                          "rewardValue": 0,
-                          "isGift": false,
-                          "additionalInfo": {
-                            "dimension": null,
-                            "brandName": "Brahma",
-                            "brandId": "2000000",
-                            "offeringInfo": null,
-                            "offeringType": null,
-                            "offeringTypeId": null
-                          },
-                          "preSaleDate": null,
-                          "productCategoryIds": "/1/",
-                          "productCategories": {
-                            "1": "Bebidas"
-                          },
-                          "quantity": 1,
-                          "seller": "1",
-                          "sellerChain": [
-                            "1"
-                          ],
-                          "imageUrl": "http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000",
-                          "detailUrl": "/chopp-brahma-claro-30l/p",
-                          "components": [],
-                          "bundleItems": [],
-                          "attachments": [],
-                          "attachmentOfferings": [],
-                          "offerings": [],
-                          "priceTags": [],
-                          "availability": "available",
-                          "measurementUnit": "un",
-                          "unitMultiplier": 1,
-                          "manufacturerCode": null,
-                          "priceDefinition": {
-                            "calculatedSellingPrice": 32890,
-                            "total": 32890,
-                            "sellingPrices": [
-                              {
-                                "value": 32890,
-                                "quantity": 1
-                              }
-                            ]
-                          }
-                        }
-                      ],
-                      "selectableGifts": [],
-                      "totalizers": [
-                        {
-                          "id": "Items",
-                          "name": "Total Items",
-                          "value": 32890
-                        }
-                      ],
-                      "shippingData": {
-                        "address": {
-                          "addressType": "residential",
-                          "receiverName": "Clark Kent",
-                          "addressId": "teste",
-                          "isDisposable": true,
-                          "postalCode": "70386000",
-                          "city": "Brasília",
-                          "state": "DF",
-                          "country": "BRA",
-                          "street": "Rua da minha casa",
-                          "number": "123",
-                          "neighborhood": "Copacabana",
-                          "complement": "15º andar",
-                          "reference": null,
-                          "geoCoordinates": [
-                            -47.924747467041016,
-                            -15.832582473754883
-                          ]
-                        },
-                        "logisticsInfo": [
-                          {
-                            "itemIndex": 0,
-                            "selectedSla": "Normal",
-                            "selectedDeliveryChannel": "delivery",
-                            "addressId": "teste",
-                            "slas": [
-                              {
-                                "id": "Normal",
-                                "deliveryChannel": "delivery",
-                                "name": "Normal",
-                                "deliveryIds": [
-                                  {
-                                    "courierId": "1",
-                                    "warehouseId": "1_1",
-                                    "dockId": "1",
-                                    "courierName": "Transportadora",
-                                    "quantity": 1,
-                                    "kitItemDetails": []
-                                  }
-                                ],
-                                "shippingEstimate": "3bd",
-                                "shippingEstimateDate": null,
-                                "lockTTL": "10d",
-                                "availableDeliveryWindows": [],
-                                "deliveryWindow": null,
-                                "price": 1500,
-                                "listPrice": 1500,
-                                "tax": 0,
-                                "pickupStoreInfo": {
-                                  "isPickupStore": false,
-                                  "friendlyName": null,
-                                  "address": null,
-                                  "additionalInfo": null,
-                                  "dockId": null
-                                },
-                                "pickupPointId": null,
-                                "pickupDistance": 0,
-                                "polygonName": null,
-                                "transitTime": "3bd"
-                              }
-                            ],
-                            "shipsTo": [
-                              "BRA",
-                              "COL",
-                              "USA"
-                            ],
-                            "itemId": "2",
-                            "deliveryChannels": [
-                              {
-                                "id": "delivery"
-                              },
-                              {
-                                "id": "pickup-in-point"
-                              }
-                            ]
-                          }
-                        ],
-                        "selectedAddresses": [
-                          {
-                            "addressType": "residential",
-                            "receiverName": "Clark Kent",
-                            "addressId": "teste",
-                            "isDisposable": true,
-                            "postalCode": "12345000",
-                            "city": "Rio de Janeiro",
-                            "state": "RJ",
-                            "country": "BRA",
-                            "street": "Rua da minha casa",
-                            "number": "123",
-                            "neighborhood": "Copacabana",
-                            "complement": "15º andar",
-                            "reference": null,
-                            "geoCoordinates": [
-                              -47.924747467041016,
-                              -15.832582473754883
-                            ]
-                          }
-                        ],
-                        "availableAddresses": [
-                          {
-                            "addressType": "residential",
-                            "receiverName": "Clark Kent",
-                            "addressId": "teste",
-                            "isDisposable": true,
-                            "postalCode": "12345000",
-                            "city": "Rio de Janeiro",
-                            "state": "RJ",
-                            "country": "BRA",
-                            "street": "Rua da minha casa",
-                            "number": "123",
-                            "neighborhood": "Copacabana",
-                            "complement": "15º andar",
-                            "reference": null,
-                            "geoCoordinates": [
-                              -47.924747467041016,
-                              -15.832582473754883
-                            ]
-                          }
-                        ],
-                        "pickupPoints": []
-                      },
-                      "clientProfileData": {
-                        "email": "clark.kent@example.com",
-                        "firstName": "Clark",
-                        "lastName": "Kent",
-                        "document": "12345678900",
-                        "documentType": "cpf",
-                        "phone": "+5521998765432",
-                        "corporateName": null,
-                        "tradeName": null,
-                        "corporateDocument": null,
-                        "stateInscription": null,
-                        "corporatePhone": null,
-                        "isCorporate": false,
-                        "profileCompleteOnLoading": false,
-                        "profileErrorOnLoading": null,
-                        "customerClass": null
-                      },
-                      "paymentData": {
-                        "giftCards": [],
-                        "transactions": [
-                          {
-                            "isActive": true,
-                            "transactionId": "296D6D245C17437E823EB77E403FC88D",
-                            "merchantName": "MYSTORE",
-                            "payments": [],
-                            "sharedTransaction": false
-                          }
-                        ]
-                      },
-                      "marketingData": {
-                        "coupon": "free-shipping",
-                        "utmSource": "app",
-                        "utmMedium": "CPC",
-                        "utmCampaign": "Black friday",
-                        "utmipage": null,
-                        "utmiPart": null,
-                        "utmiCampaign": null
-                      },
-                      "sellers": [
-                        {
-                          "id": "1",
-                          "name": "lojadobreno",
-                          "logo": ""
-                        }
-                      ],
-                      "clientPreferencesData": {
-                        "locale": "pt-BR",
-                        "optinNewsLetter": false
-                      },
-                      "commercialConditionData": null,
-                      "storePreferencesData": {},
-                      "giftRegistryData": null,
-                      "openTextField": null,
-                      "invoiceData": null,
-                      "customData": null,
-                      "itemMetadata": {
-                        "items": [
-                          {
-                            "id": "2",
-                            "seller": "1",
-                            "name": "Chopp Brahma Claro 30L",
-                            "skuName": "Chopp Brahma Claro 30L",
-                            "productId": "2",
-                            "refId": "CBC30L",
-                            "ean": null,
-                            "imageUrl": "http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000",
-                            "detailUrl": "/chopp-brahma-claro-30l/p",
-                            "assemblyOptions": []
-                          }
-                        ]
-                      },
-                      "hooksData": null,
-                      "ratesAndBenefitsData": {
-                        "rateAndBenefitsIdentifiers": [],
-                        "teaser": []
-                      },
-                      "subscriptionData": null,
-                      "itemsOrdination": {
-                        "criteria": "NAME",
-                        "ascending": true
-                      }
-                    }
-                  }
-                }
-              }
-            }
-          }
-        },
-        "deprecated": false
-      }
-    },
-    "/api/checkout/pub/orderForm/{orderFormId}/installments": {
-      "get": {
-        "tags": [
-          "Shopping cart"
-        ],
-        "summary": "Cart installments",
-        "description": "Retrieves possible amount of installments and respective values for a given cart with a given payment method.\r\n\r\nThe [orderForm](https://developers.vtex.com/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.\n\r\n\rThis endpoint can be used to get the installment options for only one payment method at a time.\n\r\n\rThis endpoint should be called only after the selected `orderForm` already has a `paymentData`.",
-        "operationId": "GetCartInstallments",
-        "security": [],
-        "parameters": [
-          {
-            "name": "orderFormId",
-            "in": "path",
-            "required": true,
-            "description": "ID of the `orderForm` to be consulted for installments.",
-            "schema": {
-              "type": "string"
-            }
-          },
-          {
-            "name": "paymentSystem",
-            "in": "query",
-            "description": "ID of the payment method to be consulted for installments.",
-            "required": true,
-            "style": "form",
-            "explode": true,
-            "schema": {
-              "type": "integer"
-            }
-          },
-          {
-            "name": "Content-Type",
-            "in": "header",
-            "description": "Type of the content being sent.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "Accept",
-            "in": "header",
-            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "OK",
-            "headers": {},
-            "content": {
-              "application/json": {
-                "example": {
-                  "paymentSystem": "2",
-                  "bin": null,
-                  "paymentName": null,
-                  "paymentGroupName": null,
-                  "value": 32000,
-                  "installments": [
-                    {
-                      "count": 1,
-                      "hasInterestRate": false,
-                      "interestRate": 0,
-                      "value": 32000,
-                      "total": 32000,
-                      "sellerMerchantInstallments": [
-                        {
-                          "id": "MyStore",
-                          "count": 1,
-                          "hasInterestRate": false,
-                          "interestRate": 0,
-                          "value": 32000,
-                          "total": 32000
-                        }
-                      ]
-                    },
-                    {
-                      "count": 2,
-                      "hasInterestRate": false,
-                      "interestRate": 0,
-                      "value": 1600,
-                      "total": 32000,
-                      "sellerMerchantInstallments": [
-                        {
-                          "id": "MyStore",
-                          "count": 2,
-                          "hasInterestRate": false,
-                          "interestRate": 0,
-                          "value": 1600,
-                          "total": 32000
-                        }
-                      ]
-                    },
-                    {
-                      "count": 3,
-                      "hasInterestRate": false,
-                      "interestRate": 0,
-                      "value": 10666,
-                      "total": 32000,
-                      "sellerMerchantInstallments": [
-                        {
-                          "id": "MyStore",
-                          "count": 3,
-                          "hasInterestRate": false,
-                          "interestRate": 0,
-                          "value": 10666,
-                          "total": 32000
-                        }
-                      ]
-                    }
-                  ]
-                }
-              }
-            }
-          }
-        },
-        "deprecated": false
-      }
-    },
-    "/api/checkout/pub/orderForm/{orderFormId}/coupons": {
-      "post": {
-        "tags": [
-          "Shopping cart"
-        ],
-        "summary": "Add coupons to the cart",
-        "description": "Use this request to add coupons to a given shopping cart.\n\r\n\rTo add multiple coupons to the same cart, you need to:\n\r\n\r1. 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.\n\r2. Submit all coupon codes in the same requisition separated by commas. E.g.: {\"text\": \"freeshipping, discount10, holiday30\"}.\r\n\r\nFor more information on multiple coupons, access the [coupons tutorial](https://help.vtex.com/en/tutorial/creating-a-coupon-beta--7lMk3MmhNp2IEccyGApxU).",
-        "operationId": "AddCoupons",
-        "security": [],
-        "parameters": [
-          {
-            "name": "orderFormId",
-            "in": "path",
-            "required": true,
-            "description": "ID of the orderForm that will receive coupon information.",
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "ede846222cd44046ba6c638442c3505a"
-            }
-          },
-          {
-            "name": "Content-Type",
-            "in": "header",
-            "description": "Type of the content being sent.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "Accept",
-            "in": "header",
-            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          }
-        ],
-        "requestBody": {
-          "content": {
-            "application/json": {
-              "schema": {
-                "type": "object",
-                "properties": {
-                  "text": {
-                    "type": "string",
-                    "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase.",
-                    "default": "freeshipping"
-                  }
-                }
-              }
-            }
-          },
-          "required": true
-        },
-        "responses": {
-          "200": {
-            "description": "OK",
-            "headers": {},
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "object",
-                  "properties": {
-                    "orderFormId": {
-                      "type": "string",
-                      "description": "ID of the orderForm corresponding to a specific cart."
-                    },
-                    "salesChannel": {
-                      "type": "string",
-                      "description": "Attribute created by the seller, in their VTEX store configuration."
-                    },
-                    "loggedIn": {
-                      "type": "boolean",
-                      "description": "Indicates whether the user is logged into the store."
-                    },
-                    "isCheckedIn": {
-                      "type": "boolean",
-                      "description": "Indicates whether order is checked in."
-                    },
-                    "storeId": {
-                      "type": "string",
-                      "description": "ID of the store.",
-                      "nullable": true
-                    },
-                    "allowManualPrice": {
-                      "type": "boolean",
-                      "description": "Permission to modify item price manually."
-                    },
-                    "canEditData": {
-                      "type": "boolean",
-                      "description": "Data can be edited."
-                    },
-                    "userProfileId": {
-                      "type": "string",
-                      "description": "Unique ID associated with the customer profile."
-                    },
-                    "profileProvider": {
-                      "type": "string",
-                      "description": "Profile provider."
-                    },
-                    "availableAccounts": {
-                      "type": "array",
-                      "description": "Available accounts.",
-                      "items": {
-                        "type": "string"
-                      }
-                    },
-                    "availableAddresses": {
-                      "type": "array",
-                      "description": "Information on each available address.",
-                      "items": {
-                        "type": "object",
-                        "properties": {
-                          "addressType": {
-                            "type": "string",
-                            "description": "Address type."
-                          },
-                          "receiverName": {
-                            "type": "string",
-                            "description": "Name of the receiver."
-                          },
-                          "addressId": {
-                            "type": "string",
-                            "description": "Address ID."
-                          },
-                          "isDisposable": {
-                            "type": "boolean",
-                            "description": "Indicates whether address is disposable."
-                          },
-                          "city": {
-                            "type": "string",
-                            "description": "City of the address."
-                          },
-                          "state": {
-                            "type": "string",
-                            "description": "State of the address."
-                          },
-                          "country": {
-                            "type": "string",
-                            "description": "Country of the address. ISO three-letter code."
-                          },
-                          "street": {
-                            "type": "string",
-                            "description": "Street of the address."
-                          },
-                          "number": {
-                            "type": "string",
-                            "description": "Number of the address."
-                          },
-                          "neighborhood": {
-                            "type": "string",
-                            "description": "Neighborhood of the address."
-                          },
-                          "complement": {
-                            "type": "string",
-                            "description": "Complement to the address.",
-                            "nullable": true
-                          },
-                          "reference": {
-                            "type": "string",
-                            "description": "Reference that may help in the location of the address.",
-                            "nullable": true
-                          },
-                          "geoCoordinates": {
-                            "type": "array",
-                            "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
-                            "items": {
-                              "type": "number"
-                            }
-                          }
-                        }
-                      }
-                    },
-                    "userType": {
-                      "type": "string",
-                      "description": "User type.",
-                      "nullable": true
-                    },
-                    "ignoreProfileData": {
-                      "type": "boolean",
-                      "description": "Ignore customer profile data."
-                    },
-                    "value": {
-                      "type": "integer",
-                      "description": "Total value of the order without separating cents. For example, $24.99 is represented `2499`."
-                    },
-                    "messages": {
-                      "type": "array",
-                      "description": "Array containing an object for each message generated by our servers while processing the request."
-                    },
-                    "items": {
-                      "type": "array",
-                      "description": "Information on each item in the order.",
-                      "items": {
-                        "type": "object",
-                        "properties": {
-                          "uniqueId": {
-                            "type": "string",
-                            "description": "Unique ID."
-                          },
-                          "id": {
-                            "type": "string",
-                            "description": "ID of the item."
-                          },
-                          "productId": {
-                            "type": "string",
-                            "description": "Product ID."
-                          },
-                          "productRefId": {
-                            "type": "string",
-                            "description": "Product Ref ID."
-                          },
-                          "refId": {
-                            "type": "string",
-                            "description": "Ref ID."
-                          },
-                          "ean": {
-                            "type": "string",
-                            "description": "European Article Number.",
-                            "nullable": true
-                          },
-                          "name": {
-                            "type": "string",
-                            "description": "Product name."
-                          },
-                          "skuName": {
-                            "type": "string",
-                            "description": "SKU name."
-                          },
-                          "modalType": {
-                            "type": "string",
-                            "description": "Modal type.",
-                            "nullable": true
-                          },
-                          "parentItemIndex": {
-                            "type": "integer",
-                            "description": "Parent item index.",
-                            "nullable": true
-                          },
-                          "parentAssemblyBinding": {
-                            "type": "string",
-                            "description": "Parent assembly binding.",
-                            "nullable": true
-                          },
-                          "priceValidUntil": {
-                            "type": "string",
-                            "description": "Price expiration date and time."
-                          },
-                          "tax": {
-                            "type": "integer",
-                            "description": "Tax value in cents."
-                          },
-                          "price": {
-                            "type": "integer",
-                            "description": "Price in cents."
-                          },
-                          "listPrice": {
-                            "type": "integer",
-                            "description": "List price in cents."
-                          },
-                          "manualPrice": {
-                            "type": "integer",
-                            "description": "Manual price in cents.",
-                            "nullable": true
-                          },
-                          "manualPriceAppliedBy": {
-                            "type": "string",
-                            "description": "User that applied the manual price, if that is the case.",
-                            "nullable": true
-                          },
-                          "sellingPrice": {
-                            "type": "integer",
-                            "description": "Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead."
-                          },
-                          "rewardValue": {
-                            "type": "integer",
-                            "description": "Reward value in cents."
-                          },
-                          "isGift": {
-                            "type": "boolean",
-                            "description": "Indicates whether item is a gift."
-                          },
-                          "additionalInfo": {
-                            "type": "object",
-                            "description": "Additional information.",
-                            "properties": {
-                              "dimension": {
-                                "type": "string",
-                                "description": "Dimension.",
-                                "nullable": true
-                              },
-                              "brandName": {
-                                "type": "string",
-                                "description": "Brand name."
-                              },
-                              "brandId": {
-                                "type": "string",
-                                "description": "Brand ID."
-                              },
-                              "offeringInfo": {
-                                "type": "string",
-                                "description": "Offering information.",
-                                "nullable": true
-                              },
-                              "offeringType": {
-                                "type": "string",
-                                "description": "Offering type.",
-                                "nullable": true
-                              },
-                              "offeringTypeId": {
-                                "type": "string",
-                                "description": "Offering type ID.",
-                                "nullable": true
-                              }
-                            }
-                          },
-                          "preSaleDate": {
-                            "type": "string",
-                            "description": "Presale date.",
-                            "nullable": true
-                          },
-                          "productCategoryIds": {
-                            "type": "string",
-                            "description": "Product category IDs."
-                          },
-                          "productCategories": {
-                            "type": "object",
-                            "description": "Object, where each field is an ID from `productCategoryIds`.",
-                            "properties": {
-                              "{ID}": {
-                                "type": "string",
-                                "description": "Product category corresponding to the ID in the field key."
-                              }
-                            }
-                          },
-                          "quantity": {
-                            "type": "integer",
-                            "description": "Quantity."
-                          },
-                          "seller": {
-                            "type": "string",
-                            "description": "Seller."
-                          },
-                          "sellerChain": {
-                            "type": "array",
-                            "description": "Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.",
-                            "items": {
-                              "type": "string",
-                              "description": "Seller."
-                            }
-                          },
-                          "imageUrl": {
-                            "type": "string",
-                            "description": "Image URL."
-                          },
-                          "detailUrl": {
-                            "type": "string",
-                            "description": "Detail URL."
-                          },
-                          "bundleItems": {
-                            "type": "array",
-                            "description": "Information on services sold along with the SKU. Example: a gift package.",
-                            "items": {
-                              "type": "object",
-                              "properties": {
-                                "type": {
-                                  "type": "string",
-                                  "description": "Service type."
-                                },
-                                "id": {
-                                  "type": "integer",
-                                  "description": "Service identifier."
-                                },
-                                "name": {
-                                  "type": "string",
-                                  "description": "Service name."
-                                },
-                                "price": {
-                                  "type": "integer",
-                                  "description": "Service price in cents."
-                                }
-                              }
-                            }
-                          },
-                          "attachments": {
-                            "type": "array",
-                            "description": "Array containing information on attachments.",
-                            "items": {
-                              "type": "string"
-                            }
-                          },
-                          "priceTags": {
-                            "type": "array",
-                            "description": "Array of price tags, each of which, modifies the price in some way, like discounts or rates that apply to the item in the context of the order.",
-                            "items": {
-                              "type": "object",
-                              "properties": {
-                                "identifier": {
-                                  "type": "string",
-                                  "description": "Price tag identifier."
-                                },
-                                "isPercentual": {
-                                  "type": "boolean",
-                                  "description": "Indicates whether price tag value is applied through a percentage."
-                                },
-                                "name": {
-                                  "type": "string",
-                                  "description": "Price tag name."
-                                },
-                                "rawValue": {
-                                  "type": "integer",
-                                  "description": "Price tag raw value."
-                                },
-                                "value": {
-                                  "type": "integer",
-                                  "description": "Price tag value."
-                                }
-                              }
-                            }
-                          },
-                          "availability": {
-                            "type": "string",
-                            "description": "Availability"
-                          },
-                          "measurementUnit": {
-                            "type": "string",
-                            "description": "Measurement unit"
-                          },
-                          "unitMultiplier": {
-                            "type": "integer",
-                            "description": "Unit multiplier"
-                          },
-                          "manufacturerCode": {
-                            "type": "string",
-                            "description": "Manufacturer code.",
-                            "nullable": true
-                          },
-                          "priceDefinition": {
-                            "type": "object",
-                            "description": "Price information for all units of a specific item.",
-                            "properties": {
-                              "calculatedSellingPrice": {
-                                "type": "integer",
-                                "description": "Item's calculated unitary selling price in cents."
-                              },
-                              "total": {
-                                "type": "integer",
-                                "description": "Total value for all units of the item in cents."
-                              },
-                              "sellingPrices": {
-                                "type": "array",
-                                "description": "Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total.",
-                                "items": {
-                                  "type": "object",
-                                  "properties": {
-                                    "value": {
-                                      "type": "integer",
-                                      "description": "Value in cents for that specific rounding."
-                                    },
-                                    "quantity": {
-                                      "type": "integer",
-                                      "description": "Rounding quantity, meaning how many items are rounded to this value."
-                                    }
-                                  }
-                                }
-                              }
-                            }
-                          }
-                        }
-                      }
-                    },
-                    "selectableGifts": {
-                      "type": "array",
-                      "description": "Array containing the data of the item selected as a gift."
-                    },
-                    "totalizers": {
-                      "type": "array",
-                      "description": "Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value)."
-                    },
-                    "shippingData": {
-                      "type": "object",
-                      "description": "Shipping information pertinent to the order.",
-                      "properties": {
-                        "address": {
-                          "type": "object",
-                          "description": "Address information.",
-                          "properties": {
-                            "addressType": {
-                              "type": "string",
-                              "description": "Type of address. For example, `Residential` or `Pickup`."
-                            },
-                            "receiverName": {
-                              "type": "string",
-                              "description": "Name of the person who is going to receive the order."
-                            },
-                            "addressId": {
-                              "type": "string",
-                              "description": "Address ID."
-                            },
-                            "isDisposable": {
-                              "type": "boolean",
-                              "description": "Indicates whether address is disposable."
-                            },
-                            "postalCode": {
-                              "type": "string",
-                              "description": "Postal code."
-                            },
-                            "city": {
-                              "type": "string",
-                              "description": "City of the shipping address."
-                            },
-                            "state": {
-                              "type": "string",
-                              "description": "State of the shipping address."
-                            },
-                            "country": {
-                              "type": "string",
-                              "description": "Three letter ISO code of the country of the shipping address."
-                            },
-                            "street": {
-                              "type": "string",
-                              "description": "Street of the shipping address."
-                            },
-                            "number": {
-                              "type": "string",
-                              "description": "Number of the building, house or apartment in the shipping address."
-                            },
-                            "neighborhood": {
-                              "type": "string",
-                              "description": "Neighborhood of the shipping address."
-                            },
-                            "complement": {
-                              "type": "string",
-                              "description": "Complement to the shipping address, in case it applies.",
-                              "nullable": true
-                            },
-                            "reference": {
-                              "type": "string",
-                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
-                              "nullable": true
-                            },
-                            "geoCoordinates": {
-                              "type": "array",
-                              "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
-                              "items": {
-                                "type": "number"
-                              }
-                            }
-                          }
-                        },
-                        "logisticsInfo": {
-                          "type": "array",
-                          "description": "Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "itemIndex": {
-                                "type": "integer",
-                                "description": "Index corresponding to the position of the object in the `items` array."
-                              },
-                              "selectedSla": {
-                                "type": "string",
-                                "description": "SLA selected by the customer."
-                              },
-                              "selectedDeliveryChannel": {
-                                "type": "string",
-                                "description": "Delivery channel selected by the customer."
-                              },
-                              "addressId": {
-                                "type": "string",
-                                "description": "Address ID."
-                              },
-                              "slas": {
-                                "type": "array",
-                                "description": "Information on available SLAs.",
-                                "items": {
-                                  "type": "object",
-                                  "properties": {
-                                    "id": {
-                                      "type": "string",
-                                      "description": "SLA ID."
-                                    },
-                                    "deliveryChannel": {
-                                      "type": "string",
-                                      "description": "Delivery channel."
-                                    },
-                                    "name": {
-                                      "type": "string",
-                                      "description": "SLA name."
-                                    },
-                                    "deliveryIds": {
-                                      "type": "array",
-                                      "description": "Information on each delivery ID.",
-                                      "items": {
-                                        "type": "object",
-                                        "properties": {
-                                          "courierId": {
-                                            "type": "string",
-                                            "description": "Courier ID."
-                                          },
-                                          "warehouseId": {
-                                            "type": "string",
-                                            "description": "Warehouse ID."
-                                          },
-                                          "dockId": {
-                                            "type": "string",
-                                            "description": "Warehouse ID."
-                                          },
-                                          "courierName": {
-                                            "type": "string",
-                                            "description": "Courier name."
-                                          },
-                                          "quantity": {
-                                            "type": "integer",
-                                            "description": "Quantity."
-                                          }
-                                        }
-                                      }
-                                    },
-                                    "shippingEstimate": {
-                                      "type": "string",
-                                      "description": "Shipping estimate. For instance, Three business days will be represented `3bd`."
-                                    },
-                                    "shippingEstimateDate": {
-                                      "type": "string",
-                                      "description": "Shipping estimate date.",
-                                      "nullable": true
-                                    },
-                                    "lockTTL": {
-                                      "type": "string",
-                                      "description": "Estimate date of delivery."
-                                    },
-                                    "price": {
-                                      "type": "integer",
-                                      "description": "Price in cents."
-                                    },
-                                    "listPrice": {
-                                      "type": "integer",
-                                      "description": "List price in cents."
-                                    },
-                                    "tax": {
-                                      "type": "integer",
-                                      "description": "Tax in cents."
-                                    },
-                                    "pickupStoreInfo": {
-                                      "type": "object",
-                                      "description": "Information on the pickup store.",
-                                      "properties": {
-                                        "isPickupStore": {
-                                          "type": "boolean",
-                                          "description": "Indicates whether it is the pickup store."
-                                        },
-                                        "friendlyName": {
-                                          "type": "string",
-                                          "description": "Friendly name.",
-                                          "nullable": true
-                                        },
-                                        "address": {
-                                          "type": "object",
-                                          "description": "Address information.",
-                                          "nullable": true,
-                                          "properties": {
-                                            "addressType": {
-                                              "type": "string",
-                                              "description": "Type of address. For example, `Residential` or `Pickup`."
-                                            },
-                                            "postalCode": {
-                                              "type": "string",
-                                              "description": "Postal code."
-                                            },
-                                            "city": {
-                                              "type": "string",
-                                              "description": "City of the shipping address."
-                                            },
-                                            "state": {
-                                              "type": "string",
-                                              "description": "State of the shipping address."
-                                            },
-                                            "country": {
-                                              "type": "string",
-                                              "description": "Three letter ISO code of the country of the shipping address."
-                                            },
-                                            "street": {
-                                              "type": "string",
-                                              "description": "Street of the shipping address."
-                                            },
-                                            "number": {
-                                              "type": "string",
-                                              "description": "Number of the building, house or apartment in the shipping address."
-                                            },
-                                            "neighborhood": {
-                                              "type": "string",
-                                              "description": "Neighborhood of the shipping address."
-                                            },
-                                            "complement": {
-                                              "type": "string",
-                                              "description": "Complement to the shipping address, in case it applies.",
-                                              "nullable": true
-                                            },
-                                            "reference": {
-                                              "type": "string",
-                                              "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
-                                              "nullable": true
-                                            },
-                                            "geoCoordinates": {
-                                              "type": "array",
-                                              "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
-                                              "items": {
-                                                "type": "number"
-                                              }
-                                            }
-                                          }
-                                        },
-                                        "additionalInfo": {
-                                          "type": "string",
-                                          "description": "Additional information.",
-                                          "nullable": true
-                                        },
-                                        "dockId": {
-                                          "type": "string",
-                                          "description": "Corresponding dock ID.",
-                                          "nullable": true
-                                        }
-                                      }
-                                    },
-                                    "pickupPointId": {
-                                      "type": "string",
-                                      "description": "Pickup point ID.",
-                                      "nullable": true
-                                    },
-                                    "pickupDistance": {
-                                      "type": "integer",
-                                      "description": "Pickup point distance."
-                                    },
-                                    "polygonName": {
-                                      "type": "string",
-                                      "description": "Polygon name.",
-                                      "nullable": true
-                                    },
-                                    "transitTime": {
-                                      "type": "string",
-                                      "description": "Transit time. For instance, \"three business days\" is represented `3bd`."
-                                    }
-                                  }
-                                }
-                              },
-                              "shipsTo": {
-                                "type": "array",
-                                "description": "List of countries that the item may be shipped to.",
-                                "items": {
-                                  "type": "string",
-                                  "description": "Three letter country code."
-                                }
-                              },
-                              "itemId": {
-                                "type": "string",
-                                "description": "Item ID."
-                              },
-                              "deliveryChannels": {
-                                "type": "array",
-                                "description": "List of available delivery channels.",
-                                "items": {
-                                  "type": "object",
-                                  "properties": {
-                                    "id": {
-                                      "type": "string",
-                                      "description": "Delivery channel ID."
-                                    }
-                                  }
-                                }
-                              }
-                            }
-                          }
-                        },
-                        "selectedAddresses": {
-                          "type": "array",
-                          "description": "Array with information on the selected addresses for the order.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "addressType": {
-                                "type": "string",
-                                "description": "Type of address. For example, `Residential` or `Pickup`."
-                              },
-                              "receiverName": {
-                                "type": "string",
-                                "description": "Name of the person who is going to receive the order."
-                              },
-                              "addressId": {
-                                "type": "string",
-                                "description": "Address ID."
-                              },
-                              "isDisposable": {
-                                "type": "boolean",
-                                "description": "Indicates whether address is disposable."
-                              },
-                              "postalCode": {
-                                "type": "string",
-                                "description": "Postal code."
-                              },
-                              "city": {
-                                "type": "string",
-                                "description": "City of the shipping address."
-                              },
-                              "state": {
-                                "type": "string",
-                                "description": "State of the shipping address."
-                              },
-                              "country": {
-                                "type": "string",
-                                "description": "Three letter ISO code of the country of the shipping address."
-                              },
-                              "street": {
-                                "type": "string",
-                                "description": "Street of the shipping address."
-                              },
-                              "number": {
-                                "type": "string",
-                                "description": "Number of the building, house or apartment in the shipping address."
-                              },
-                              "neighborhood": {
-                                "type": "string",
-                                "description": "Neighborhood of the shipping address."
-                              },
-                              "complement": {
-                                "type": "string",
-                                "description": "Complement to the shipping address, in case it applies."
-                              },
-                              "reference": {
-                                "type": "string",
-                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
-                                "nullable": true
-                              },
-                              "geoCoordinates": {
-                                "type": "array",
-                                "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
-                                "items": {
-                                  "type": "number"
-                                }
-                              }
-                            }
-                          }
-                        },
-                        "availableAddresses": {
-                          "type": "array",
-                          "description": "Array with information on the available addresses for the order.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "addressType": {
-                                "type": "string",
-                                "description": "Type of address. For example, `Residential` or `Pickup`."
-                              },
-                              "receiverName": {
-                                "type": "string",
-                                "description": "Name of the person who is going to receive the order."
-                              },
-                              "addressId": {
-                                "type": "string",
-                                "description": "Address ID."
-                              },
-                              "isDisposable": {
-                                "type": "boolean",
-                                "description": "Indicates whether address is disposable."
-                              },
-                              "postalCode": {
-                                "type": "string",
-                                "description": "Postal code."
-                              },
-                              "city": {
-                                "type": "string",
-                                "description": "City of the shipping address."
-                              },
-                              "state": {
-                                "type": "string",
-                                "description": "State of the shipping address."
-                              },
-                              "country": {
-                                "type": "string",
-                                "description": "Three letter ISO code of the country of the shipping address."
-                              },
-                              "street": {
-                                "type": "string",
-                                "description": "Street of the shipping address."
-                              },
-                              "number": {
-                                "type": "string",
-                                "description": "Number of the building, house or apartment in the shipping address."
-                              },
-                              "neighborhood": {
-                                "type": "string",
-                                "description": "Neighborhood of the shipping address."
-                              },
-                              "complement": {
-                                "type": "string",
-                                "description": "Complement to the shipping address, in case it applies."
-                              },
-                              "reference": {
-                                "type": "string",
-                                "description": "Complement that might help locate the shipping address more precisely in case of delivery.",
-                                "nullable": true
-                              },
-                              "geoCoordinates": {
-                                "type": "array",
-                                "description": "Array containing two floats with geocoordinates, first longitude, then latitude.",
-                                "items": {
-                                  "type": "number"
-                                }
-                              }
-                            }
-                          }
-                        }
-                      }
-                    },
-                    "clientProfileData": {
-                      "type": "object",
-                      "description": "Customer's profile information.",
-                      "properties": {
-                        "email": {
-                          "type": "string",
-                          "description": "Email address."
-                        },
-                        "firstName": {
-                          "type": "string",
-                          "description": "First name."
-                        },
-                        "lastName": {
-                          "type": "string",
-                          "description": "Last name."
-                        },
-                        "documentType": {
-                          "type": "string",
-                          "description": "Type of the document informed by the customer."
-                        },
-                        "document": {
-                          "type": "string",
-                          "description": "Document informed by the customer."
-                        },
-                        "phone": {
-                          "type": "string",
-                          "description": "Phone number."
-                        },
-                        "corporateName": {
-                          "type": "string",
-                          "description": "Company name, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "tradeName": {
-                          "type": "string",
-                          "description": "Trade name, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "corporateDocument": {
-                          "type": "string",
-                          "description": "Corporate document, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "stateInscription": {
-                          "type": "string",
-                          "description": "State inscription, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "corporatePhone": {
-                          "type": "string",
-                          "description": "Corporate phone number, if the customer is a legal entity.",
-                          "nullable": true
-                        },
-                        "isCorporate": {
-                          "type": "boolean",
-                          "description": "Indicates whether the customer is a legal entity."
-                        },
-                        "profileCompleteOnLoading": {
-                          "type": "boolean",
-                          "description": "Indicates whether profile is complete on loading."
-                        },
-                        "profileErrorOnLoading": {
-                          "type": "boolean",
-                          "description": "Indicates whether profile presents error on loading.",
-                          "nullable": true
-                        },
-                        "customerClass": {
-                          "type": "string",
-                          "description": "Customer class.",
-                          "nullable": true
-                        }
-                      }
-                    },
-                    "paymentData": {
-                      "type": "object",
-                      "description": "Information on the order's payment.",
-                      "properties": {
-                        "giftCards": {
-                          "type": "array",
-                          "description": "Gift card information, if it applies to the order.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "redemptionCode": {
-                                "type": "string",
-                                "description": "Gift card redemption code."
-                              },
-                              "value": {
-                                "type": "integer",
-                                "description": "Gift card value in cents."
-                              },
-                              "balance": {
-                                "type": "integer",
-                                "description": "Gift card balance in cents."
-                              },
-                              "name": {
-                                "type": "string",
-                                "description": "Gift card name."
-                              },
-                              "id": {
-                                "type": "string",
-                                "description": "Gift card ID."
-                              },
-                              "inUse": {
-                                "type": "boolean",
-                                "description": "Indicates whether gift card is in use."
-                              },
-                              "isSpecialCard": {
-                                "type": "boolean",
-                                "description": "Indicates whether gift card is special."
-                              }
-                            }
-                          }
-                        },
-                        "transactions": {
-                          "type": "array",
-                          "description": "Information on each transaction pertinent to the order.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "isActive": {
-                                "type": "boolean",
-                                "description": "Indicates whether transaction is active."
-                              },
-                              "transactionId": {
-                                "type": "string",
-                                "description": "Transaction ID."
-                              },
-                              "merchantName": {
-                                "type": "string",
-                                "description": "Merchant name."
-                              },
-                              "payments": {
-                                "type": "array",
-                                "description": "Information on each payment.",
-                                "items": {
-                                  "type": "object",
-                                  "properties": {
-                                    "accountId": {
-                                      "type": "string",
-                                      "description": "Account ID."
-                                    },
-                                    "bin": {
-                                      "type": "string",
-                                      "description": "Bin."
-                                    },
-                                    "installments": {
-                                      "type": "integer",
-                                      "description": "Number of installments."
-                                    },
-                                    "paymentSystem": {
-                                      "type": "string",
-                                      "description": "Payment system."
-                                    },
-                                    "referenceValue": {
-                                      "type": "integer",
-                                      "description": "Reference value for calculating interest rates, in case it applies. Displayed in cents."
-                                    },
-                                    "value": {
-                                      "type": "integer",
-                                      "description": "Value including interest, in case it applies. Displayed in cents."
-                                    }
-                                  }
-                                }
-                              },
-                              "sharedTransaction": {
-                                "type": "boolean",
-                                "description": "Indicates whather transaction is shared."
-                              }
-                            }
-                          }
-                        }
-                      }
-                    },
-                    "marketingData": {
-                      "type": "object",
-                      "description": "Object containIng promotion data such as coupon tracking information and internal or external UTMs.",
-                      "properties": {
-                        "coupon": {
-                          "type": "string",
-                          "description": "Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order.",
-                          "default": "free-shipping"
-                        },
-                        "utmSource": {
-                          "type": "string",
-                          "description": "UTM source.",
-                          "default": "Facebook",
-                          "nullable": true
-                        },
-                        "utmMedium": {
-                          "type": "string",
-                          "description": "UTM medium.",
-                          "default": "CPC",
-                          "nullable": true
-                        },
-                        "utmCampaign": {
-                          "type": "string",
-                          "description": "UTM campaign.",
-                          "default": "Black friday",
-                          "nullable": true
-                        },
-                        "utmiPage": {
-                          "type": "string",
-                          "description": "utmi_page (internal utm).",
-                          "default": "utmi_page-example",
-                          "nullable": true
-                        },
-                        "utmiPart": {
-                          "type": "string",
-                          "description": "utmi_part (internal utm).",
-                          "default": "utmi_part-exmaple",
-                          "nullable": true
-                        },
-                        "utmiCampaign": {
-                          "type": "string",
-                          "description": "utmi_campaign (internal utm).",
-                          "default": "utmi_campaign-exmaple",
-                          "nullable": true
-                        }
-                      }
-                    },
-                    "sellers": {
-                      "type": "array",
-                      "description": "Information on each seller.",
-                      "items": {
-                        "type": "object",
-                        "properties": {
-                          "id": {
-                            "type": "string",
-                            "description": "Seller ID."
-                          },
-                          "name": {
-                            "type": "string",
-                            "description": "Seller name."
-                          },
-                          "logo": {
-                            "type": "string",
-                            "description": "Seller logo.",
-                            "nullable": true
-                          }
-                        }
-                      }
-                    },
-                    "clientPreferencesData": {
-                      "type": "object",
-                      "description": "Object containing preferences from the client who placed the order.",
-                      "properties": {
-                        "locale": {
-                          "type": "string",
-                          "description": "Client's locale. Examples: `pt-BR` and `en-US`."
-                        },
-                        "optinNewsLetter": {
-                          "type": "boolean",
-                          "description": "`true` if the client opted to receive newsletter from the store.",
-                          "nullable": false
-                        }
-                      }
-                    },
-                    "commercialConditionData": {
-                      "type": "object",
-                      "description": "Object containing commercial condition information.",
-                      "nullable": true
-                    },
-                    "storePreferencesData": {
-                      "type": "object",
-                      "description": "Object containing data from the store's configuration (stored in VTEX's License Manager)."
-                    },
-                    "giftRegistryData": {
-                      "type": "object",
-                      "description": "Gift registry list information.",
-                      "nullable": true
-                    },
-                    "openTextField": {
-                      "type": "string",
-                      "description": "Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1)",
-                      "default": "open-text-example",
-                      "nullable": true
-                    },
-                    "invoiceData": {
-                      "type": "object",
-                      "description": "Object containing information pertinent to the order's invoice.",
-                      "nullable": true
-                    },
-                    "customData": {
-                      "type": "object",
-                      "description": "Customer additional information.",
-                      "nullable": true
-                    },
-                    "itemMetadata": {
-                      "type": "object",
-                      "description": "Item metadata.",
-                      "properties": {
-                        "items": {
-                          "type": "array",
-                          "description": "List of objects containing metadata on each item in the order.",
-                          "items": {
-                            "type": "object",
-                            "properties": {
-                              "id": {
-                                "type": "string",
-                                "description": "Item ID."
-                              },
-                              "seller": {
-                                "type": "string",
-                                "description": "Seller."
-                              },
-                              "name": {
-                                "type": "string",
-                                "description": "Product name."
-                              },
-                              "skuName": {
-                                "type": "string",
-                                "description": "SKU name."
-                              },
-                              "productId": {
-                                "type": "string",
-                                "description": "Product ID."
-                              },
-                              "refId": {
-                                "type": "string",
-                                "description": "Ref ID."
-                              },
-                              "ean": {
-                                "type": "string",
-                                "description": "European Article Number.",
-                                "nullable": true
-                              },
-                              "imageUrl": {
-                                "type": "string",
-                                "description": "Image URL."
-                              },
-                              "detailUrl": {
-                                "type": "string",
-                                "description": "Detail URL."
-                              }
-                            }
-                          }
-                        }
-                      }
-                    },
-                    "hooksData": {
-                      "type": "object",
-                      "description": "Hooks information.",
-                      "nullable": true
-                    },
-                    "ratesAndBenefitsData": {
-                      "type": "object",
-                      "description": "Information on rates and benefits that apply to the order.",
-                      "properties": {
-                        "rateAndBenefitsIdentifiers": {
-                          "type": "array",
-                          "description": "List with rates and benefits identifiers.",
-                          "items": {
-                            "type": "string"
-                          }
-                        },
-                        "teaser": {
-                          "type": "array",
-                          "description": "List with rates and benefits teasers.",
-                          "items": {
-                            "type": "string"
-                          }
-                        }
-                      }
-                    },
-                    "subscriptionData": {
-                      "type": "object",
-                      "description": "Subscription information.",
-                      "nullable": true
-                    },
-                    "itemsOrdination": {
-                      "type": "object",
-                      "description": "Object containing information about the ordering of items within the orderForm.",
-                      "properties": {
-                        "criteria": {
-                          "type": "string",
-                          "description": "Criteria adopted to order the items in the list."
-                        },
-                        "ascending": {
-                          "type": "boolean",
-                          "description": "Indicates whether the ordering is ascending."
-                        }
-                      }
-                    }
-                  }
-                },
-                "examples": {
-                  "response": {
-                    "value": {
-                      "orderFormId": "ede846222cd44046ba6c638442c3505a",
-                      "salesChannel": "1",
-                      "loggedIn": false,
-                      "isCheckedIn": false,
-                      "storeId": null,
-                      "allowManualPrice": false,
-                      "canEditData": true,
-                      "userProfileId": "fb542e51-5488-4c34-8d17-ed8fcf597a94",
-                      "profileProvider": "VTEX",
-                      "availableAccounts": [],
-                      "availableAddresses": [
-                        {
-                          "addressType": "residential",
-                          "receiverName": "Clark Kent",
-                          "addressId": "666c2e830bd9474ab6f6cc53fb6dd2d2",
-                          "isDisposable": true,
-                          "postalCode": "70386000",
-                          "city": "Brasília",
-                          "state": "DF",
-                          "country": "BRA",
-                          "street": "Rua da minha casa",
-                          "number": "123",
-                          "neighborhood": "Copacabana",
-                          "complement": "15º andar",
-                          "reference": null,
-                          "geoCoordinates": [
-                            -47.924747467041016,
-                            -15.832582473754883
-                          ]
-                        }
-                      ],
-                      "userType": null,
-                      "ignoreProfileData": false,
-                      "value": 34390,
-                      "messages": [],
-                      "items": [
-                        {
-                          "uniqueId": "9D6E447B3FF64CEDA33B17C01379C119",
-                          "id": "2",
-                          "productId": "2",
-                          "productRefId": "",
-                          "refId": "CBC30L",
-                          "ean": null,
-                          "name": "Chopp Brahma Claro 30L",
-                          "skuName": "Chopp Brahma Claro 30L",
-                          "modalType": null,
-                          "parentItemIndex": null,
-                          "parentAssemblyBinding": null,
-                          "assemblies": [],
-                          "priceValidUntil": "2022-07-13T18:30:46Z",
-                          "tax": 0,
-                          "price": 32890,
-                          "listPrice": 49900,
-                          "manualPrice": null,
-                          "manualPriceAppliedBy": null,
-                          "sellingPrice": 32890,
-                          "rewardValue": 0,
-                          "isGift": false,
-                          "additionalInfo": {
-                            "dimension": null,
-                            "brandName": "Brahma",
-                            "brandId": "2000000",
-                            "offeringInfo": null,
-                            "offeringType": null,
-                            "offeringTypeId": null
-                          },
-                          "preSaleDate": null,
-                          "productCategoryIds": "/1/",
-                          "productCategories": {
-                            "1": "Bebidas"
-                          },
-                          "quantity": 1,
-                          "seller": "1",
-                          "sellerChain": [
-                            "1"
-                          ],
-                          "imageUrl": "http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000",
-                          "detailUrl": "/chopp-brahma-claro-30l/p",
-                          "components": [],
-                          "bundleItems": [],
-                          "attachments": [],
-                          "attachmentOfferings": [],
-                          "offerings": [],
-                          "priceTags": [],
-                          "availability": "available",
-                          "measurementUnit": "un",
-                          "unitMultiplier": 1,
-                          "manufacturerCode": null,
-                          "priceDefinition": {
-                            "calculatedSellingPrice": 32890,
-                            "total": 32890,
-                            "sellingPrices": [
-                              {
-                                "value": 32890,
-                                "quantity": 1
-                              }
-                            ]
-                          }
-                        }
-                      ],
-                      "selectableGifts": [],
-                      "totalizers": [
-                        {
-                          "id": "Items",
-                          "name": "Total Items",
-                          "value": 32890
-                        }
-                      ],
-                      "shippingData": {
-                        "address": {
-                          "addressType": "residential",
-                          "receiverName": "Clark Kent",
-                          "addressId": "teste",
-                          "isDisposable": true,
-                          "postalCode": "70386000",
-                          "city": "Brasília",
-                          "state": "DF",
-                          "country": "BRA",
-                          "street": "Rua da minha casa",
-                          "number": "123",
-                          "neighborhood": "Copacabana",
-                          "complement": "15º andar",
-                          "reference": null,
-                          "geoCoordinates": [
-                            -47.924747467041016,
-                            -15.832582473754883
-                          ]
-                        },
-                        "logisticsInfo": [
-                          {
-                            "itemIndex": 0,
-                            "selectedSla": "Normal",
-                            "selectedDeliveryChannel": "delivery",
-                            "addressId": "teste",
-                            "slas": [
-                              {
-                                "id": "Normal",
-                                "deliveryChannel": "delivery",
-                                "name": "Normal",
-                                "deliveryIds": [
-                                  {
-                                    "courierId": "1",
-                                    "warehouseId": "1_1",
-                                    "dockId": "1",
-                                    "courierName": "Transportadora",
-                                    "quantity": 1,
-                                    "kitItemDetails": []
-                                  }
-                                ],
-                                "shippingEstimate": "3bd",
-                                "shippingEstimateDate": null,
-                                "lockTTL": "10d",
-                                "availableDeliveryWindows": [],
-                                "deliveryWindow": null,
-                                "price": 1500,
-                                "listPrice": 1500,
-                                "tax": 0,
-                                "pickupStoreInfo": {
-                                  "isPickupStore": false,
-                                  "friendlyName": null,
-                                  "address": null,
-                                  "additionalInfo": null,
-                                  "dockId": null
-                                },
-                                "pickupPointId": null,
-                                "pickupDistance": 0,
-                                "polygonName": null,
-                                "transitTime": "3bd"
-                              }
-                            ],
-                            "shipsTo": [
-                              "BRA",
-                              "COL",
-                              "USA"
-                            ],
-                            "itemId": "2",
-                            "deliveryChannels": [
-                              {
-                                "id": "delivery"
-                              },
-                              {
-                                "id": "pickup-in-point"
-                              }
-                            ]
-                          }
-                        ],
-                        "selectedAddresses": [
-                          {
-                            "addressType": "residential",
-                            "receiverName": "Clark Kent",
-                            "addressId": "teste",
-                            "isDisposable": true,
-                            "postalCode": "12345000",
-                            "city": "Rio de Janeiro",
-                            "state": "RJ",
-                            "country": "BRA",
-                            "street": "Rua da minha casa",
-                            "number": "123",
-                            "neighborhood": "Copacabana",
-                            "complement": "15º andar",
-                            "reference": null,
-                            "geoCoordinates": [
-                              -47.924747467041016,
-                              -15.832582473754883
-                            ]
-                          }
-                        ],
-                        "availableAddresses": [
-                          {
-                            "addressType": "residential",
-                            "receiverName": "Clark Kent",
-                            "addressId": "teste",
-                            "isDisposable": true,
-                            "postalCode": "12345000",
-                            "city": "Rio de Janeiro",
-                            "state": "RJ",
-                            "country": "BRA",
-                            "street": "Rua da minha casa",
-                            "number": "123",
-                            "neighborhood": "Copacabana",
-                            "complement": "15º andar",
-                            "reference": null,
-                            "geoCoordinates": [
-                              -47.924747467041016,
-                              -15.832582473754883
-                            ]
-                          }
-                        ],
-                        "pickupPoints": []
-                      },
-                      "clientProfileData": {
-                        "email": "clark.kent@example.com",
-                        "firstName": "Clark",
-                        "lastName": "Kent",
-                        "document": "12345678900",
-                        "documentType": "cpf",
-                        "phone": "+5521998765432",
-                        "corporateName": null,
-                        "tradeName": null,
-                        "corporateDocument": null,
-                        "stateInscription": null,
-                        "corporatePhone": null,
-                        "isCorporate": false,
-                        "profileCompleteOnLoading": false,
-                        "profileErrorOnLoading": null,
-                        "customerClass": null
-                      },
-                      "paymentData": {
-                        "giftCards": [],
-                        "transactions": [
-                          {
-                            "isActive": true,
-                            "transactionId": "296D6D245C17437E823EB77E403FC88D",
-                            "merchantName": "MYSTORE",
-                            "payments": [],
-                            "sharedTransaction": false
-                          }
-                        ]
-                      },
-                      "marketingData": {
-                        "utmSource": null,
-                        "utmMedium": null,
-                        "utmCampaign": null,
-                        "utmipage": null,
-                        "utmiPart": null,
-                        "utmiCampaign": null,
-                        "coupon": "freeshipping",
-                        "marketingTags": []
-                      },
-                      "sellers": [
-                        {
-                          "id": "1",
-                          "name": "lojadobreno",
-                          "logo": ""
-                        }
-                      ],
-                      "clientPreferencesData": {
-                        "locale": "pt-BR",
-                        "optinNewsLetter": false
-                      },
-                      "commercialConditionData": null,
-                      "storePreferencesData": {},
-                      "giftRegistryData": null,
-                      "openTextField": null,
-                      "invoiceData": null,
-                      "customData": null,
-                      "itemMetadata": {
-                        "items": [
-                          {
-                            "id": "2",
-                            "seller": "1",
-                            "name": "Chopp Brahma Claro 30L",
-                            "skuName": "Chopp Brahma Claro 30L",
-                            "productId": "2",
-                            "refId": "CBC30L",
-                            "ean": null,
-                            "imageUrl": "http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000",
-                            "detailUrl": "/chopp-brahma-claro-30l/p",
-                            "assemblyOptions": []
-                          }
-                        ]
-                      },
-                      "hooksData": null,
-                      "ratesAndBenefitsData": {
-                        "rateAndBenefitsIdentifiers": [],
-                        "teaser": []
-                      },
-                      "subscriptionData": null,
-                      "itemsOrdination": {
-                        "criteria": "NAME",
-                        "ascending": true
-                      }
-                    }
-                  }
-                }
-              }
-            }
-          }
-        },
-        "deprecated": false
-      }
-    },
-    "/api/oms/pvt/orders/{orderId}/cancel": {
-      "post": {
-        "tags": [
-          "Orders"
-        ],
-        "summary": "Cancel order",
-        "description": "Cancels an order using its identification code (`orderId`). A common scenario is when the seller has a problem fulfilling the order and requests the marketplace to cancel it. \r\n\r\n## Orders that cannot be canceled \r\n\r\nThe following situations do not allow order cancellation: \r\n\r\n- **Partial invoices:** [Partially invoiced](https://help.vtex.com/en/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/q9GPspTb9cHlMeAZfdEUe) orders cannot be canceled. However, the customer can [change the order](https://developers.vtex.com/docs/guides/change-order) to replace or remove items from it. \r\n\r\n- **Invoiced status:** Orders with `invoiced` [status](https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials_196) cannot be canceled. If the order has already been invoiced, you can use the [Order invoice notification](https://developers.vtex.com/docs/api-reference/orders-api#post-/api/oms/pvt/orders/-orderId-/invoice) endpoint to generate a return invoice. \r\n\r\n- **Incomplete orders:** [Incomplete orders](https://help.vtex.com/en/tutorial/how-incomplete-orders-work--tutorials_294) cannot be canceled. \r\n\r\n## Declining order cancelation \r\n\r\nThe order flow has a cancellation window (grace period) in which the customer can automatically cancel the order. Except for that period, the seller can [decline an order cancellation request](https://help.vtex.com/en/tutorial/declining-order-cancelation--F2n0h1TeQ5td540Gjyff4), regardless of whether the customer or the marketplace initiated it. \r\n\r\nFor more information, see [Order canceling improvements](https://developers.vtex.com/docs/guides/order-canceling-improvements). \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| OMS | OMS access | **Cancel order** | \r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| OMS - Full access | Cancel order |\r\n| IntegrationProfile - Fulfillment Oms | Cancel order |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm). \r\n\r\nTo learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).",
-        "operationId": "CancelOrder",
-        "parameters": [
-          {
-            "name": "Accept",
-            "in": "header",
-            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "Content-Type",
-            "in": "header",
-            "description": "Describes the type of the content being sent.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "orderId",
-            "in": "path",
-            "description": "ID that identifies the order in the seller.",
-            "example": "1172452900788-01",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "example": "1172452900788-01"
-            }
-          }
-        ],
-        "requestBody": {
-          "content": {
-            "application/json": {
-              "schema": {
-                "type": "object",
-                "properties": {
-                  "reason": {
-                    "type": "string",
-                    "description": "Reason for cancelling the order.",
-                    "example": "Unexpected stock shortage"
-                  },
-                  "requestedByUser": {
-                    "type": "boolean",
-                    "description": "If requested by the user",
-                    "example": "User canceled the order "
-                  }
-                }
-              }
-            }
-          }
-        },
-        "responses": {
-          "200": {
-            "description": "OK",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "type": "object",
-                  "properties": {
-                    "date": {
-                      "type": "string",
-                      "description": "Date and time when the notification was received."
-                    },
-                    "orderId": {
-                      "type": "string",
-                      "description": "Identification of the order in the seller."
-                    },
-                    "receipt": {
-                      "type": "string",
-                      "description": "Protocol code generated by the update. It may be `null`."
-                    }
-                  }
-                },
-                "example": {
-                  "date": "2024-02-07T15:22:56.7612218-02:00",
-                  "orderId": "123543123",
-                  "receipt": "38e0e47da2934847b489216d208cfd91"
-                }
-              }
-            }
-          },
-          "429": {
-            "description": "Too many requests."
-          },
-          "403": {
-            "description": "The credentials are not enabled to access the service."
-          },
-          "404": {
-            "description": "Value not found."
-          }
-        }
-      }
-    },
-    "/api/checkout/pub/pickup-points": {
-      "get": {
-        "tags": [
-          "Fulfillment"
-        ],
-        "summary": "List pickup points by location",
-        "description": "Retrieves information on pickup points close to a given location determined by geocoordinates or postal code.\n\r\n\rThe pickup points returned are not necessarily all active ones. Make sure to validate the information consumed by integrations.",
-        "operationId": "ListPickupPpointsByLocation",
-        "security": [],
-        "parameters": [
-          {
-            "name": "Content-Type",
-            "in": "header",
-            "description": "Type of the content being sent.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "Accept",
-            "in": "header",
-            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "geoCoordinates",
-            "in": "query",
-            "description": "Geocoordinates (first longitude, then latitude) around which to search for pickup points. If you use this type of search, do not pass postal and country codes.",
-            "required": false,
-            "style": "form",
-            "schema": {
-              "type": "array",
-              "default": [
-                -47.924747467041016,
-                -15.832582473754883
-              ],
-              "items": {
-                "type": "number",
-                "example": -47.924747467041016
-              }
-            }
-          },
-          {
-            "name": "postalCode",
-            "in": "query",
-            "description": "Postal code around which to search for pickup points. If you use this type of search, make sure to pass a `countryCode` and do not pass `geoCoordinates`.",
-            "required": false,
-            "style": "form",
-            "schema": {
-              "type": "string",
-              "default": "1234000"
-            }
-          },
-          {
-            "name": "countryCode",
-            "in": "query",
-            "description": "Three letter country code refering to the `postalCode` field. Pass the country code only if you are searching pickup points by postal code.",
-            "required": false,
-            "style": "form",
-            "schema": {
-              "type": "string",
-              "default": "BRA"
-            }
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "OK",
-            "content": {
-              "application/json": {
-                "example": {
-                  "paging": {
-                    "page": 1,
-                    "pageSize": 30,
-                    "total": 1,
-                    "pages": 1
-                  },
-                  "items": [
-                    {
-                      "distance": 0.84697865186165456,
-                      "pickupPoint": {
-                        "friendlyName": "physical-store-02",
-                        "address": {
-                          "addressType": "pickup",
-                          "receiverName": null,
-                          "addressId": "physical-store-02",
-                          "isDisposable": true,
-                          "postalCode": "23450-070",
-                          "city": "Rio de Janeiro",
-                          "state": "RJ",
-                          "country": "BRA",
-                          "street": "Praia de Botafogo",
-                          "number": "132",
-                          "neighborhood": "Botafogo",
-                          "complement": "",
-                          "reference": null,
-                          "geoCoordinates": [
-                            -47.924747467041016,
-                            -15.832582473754883
-                          ]
-                        },
-                        "additionalInfo": null,
-                        "id": "02_Physical",
-                        "businessHours": [
-                          {
-                            "DayOfWeek": 0,
-                            "OpeningTime": "00:00:00",
-                            "ClosingTime": "23:59:00"
-                          },
-                          {
-                            "DayOfWeek": 1,
-                            "OpeningTime": "00:00:00",
-                            "ClosingTime": "23:59:00"
-                          },
-                          {
-                            "DayOfWeek": 2,
-                            "OpeningTime": "00:00:00",
-                            "ClosingTime": "23:59:00"
-                          },
-                          {
-                            "DayOfWeek": 3,
-                            "OpeningTime": "00:00:00",
-                            "ClosingTime": "23:59:00"
-                          },
-                          {
-                            "DayOfWeek": 4,
-                            "OpeningTime": "00:00:00",
-                            "ClosingTime": "23:50:00"
-                          },
-                          {
-                            "DayOfWeek": 5,
-                            "OpeningTime": "00:00:00",
-                            "ClosingTime": "23:59:00"
-                          },
-                          {
-                            "DayOfWeek": 6,
-                            "OpeningTime": "00:00:00",
-                            "ClosingTime": "23:59:00"
-                          }
-                        ]
-                      }
-                    }
-                  ]
-                },
-                "schema": {
-                  "type": "object",
-                  "properties": {
-                    "paging": {
-                      "description": "Paging.",
-                      "type": "object",
-                      "properties": {
-                        "page": {
-                          "description": "Page number.",
-                          "type": "integer"
-                        },
-                        "pageSize": {
-                          "description": "Page size.",
-                          "type": "integer"
-                        },
-                        "total": {
-                          "description": "Total pages.",
-                          "type": "integer"
-                        },
-                        "pages": {
-                          "description": "Pages.",
-                          "type": "integer"
-                        }
-                      }
-                    },
-                    "items": {
-                      "description": "Items.",
-                      "type": "array",
-                      "items": {
-                        "description": "Item information.",
-                        "type": "object",
-                        "properties": {
-                          "distance": {
-                            "description": "Distance.",
-                            "type": "integer"
-                          },
-                          "pickupPoint": {
-                            "description": "Pickup point.",
-                            "type": "object",
-                            "properties": {
-                              "friendlyName": {
-                                "description": "Friendly name.",
-                                "type": "string"
-                              },
-                              "address": {
-                                "description": "Address.",
-                                "type": "object",
-                                "properties": {
-                                  "addressType": {
-                                    "description": "Address type.",
-                                    "type": "string"
-                                  },
-                                  "receiverName": {
-                                    "description": "Receiver name.",
-                                    "type": "string"
-                                  },
-                                  "addressId": {
-                                    "description": "Address ID.",
-                                    "type": "string",
-                                    "nullable": true
-                                  },
-                                  "isDisposable": {
-                                    "description": "Is disposable.",
-                                    "type": "boolean"
-                                  },
-                                  "postalCode": {
-                                    "description": "Postal code.",
-                                    "type": "string"
-                                  },
-                                  "city": {
-                                    "description": "City.",
-                                    "type": "string"
-                                  },
-                                  "state": {
-                                    "description": "State.",
-                                    "type": "string"
-                                  },
-                                  "country": {
-                                    "description": "Country.",
-                                    "type": "string"
-                                  },
-                                  "street": {
-                                    "description": "Street.",
-                                    "type": "string"
-                                  },
-                                  "number": {
-                                    "description": "Number.",
-                                    "type": "string"
-                                  },
-                                  "neighborhood": {
-                                    "description": "Neighborhood.",
-                                    "type": "string"
-                                  },
-                                  "complement": {
-                                    "description": "Complement to the shipping address, in case it applies.",
-                                    "type": "string",
-                                    "nullable": true
-                                  },
-                                  "reference": {
-                                    "description": "Racao.",
-                                    "type": "string"
-                                  },
-                                  "geoCoordinates": {
-                                    "description": "Geo coordinates.",
-                                    "type": "array",
-                                    "items": {
-                                      "description": "Geo coordinate.",
-                                      "type": "integer"
-                                    }
-                                  }
-                                }
-                              },
-                              "additionalInfo": {
-                                "description": "Additional info.",
-                                "type": "string"
-                              },
-                              "id": {
-                                "description": "ID.",
-                                "type": "string"
-                              },
-                              "businessHours": {
-                                "description": "Array with business hours.",
-                                "type": "array",
-                                "items": {
-                                  "description": "Business hours.",
-                                  "type": "object",
-                                  "properties": {
-                                    "DayOfWeek": {
-                                      "description": "Day of week.",
-                                      "type": "integer"
-                                    },
-                                    "OpeningTime": {
-                                      "description": "Opening time.",
-                                      "type": "string"
-                                    },
-                                    "ClosingTime": {
-                                      "description": "Closing time.",
-                                      "type": "string"
-                                    }
-                                  }
-                                }
-                              }
-                            }
-                          }
-                        }
-                      }
+                      "description": "Protocol code generated by the update. It may be `null`."
                     }
                   }
+                },
+                "example": {
+                  "date": "2024-02-07T15:22:56.7612218-02:00",
+                  "orderId": "123543123",
+                  "receipt": "38e0e47da2934847b489216d208cfd91"
                 }
               }
             }
+          },
+          "429": {
+            "description": "Too many requests."
+          },
+          "403": {
+            "description": "The credentials are not enabled to access the service."
+          },
+          "404": {
+            "description": "Value not found."
           }
         }
       }
     },
-    "/api/checkout/pub/postal-code/{countryCode}/{postalCode}": {
+    "/api/checkout/pub/pickup-points": {
       "get": {
         "tags": [
           "Fulfillment"
         ],
-        "summary": "Get address by postal code",
-        "description": "Retrieves address information for a given postal code and country.\r\n\r\nThis request can be used to implement auto complete functionality when a customer needs to fill in an address.",
-        "operationId": "GetAddressByPostalCode",
+        "summary": "List pickup points by location",
+        "description": "Retrieves information on pickup points close to a given location determined by geocoordinates or postal code.\n\r\n\rThe pickup points returned are not necessarily all active ones. Make sure to validate the information consumed by integrations.",
+        "operationId": "ListPickupPpointsByLocation",
         "security": [],
         "parameters": [
           {
@@ -35474,582 +21452,407 @@
             }
           },
           {
-            "name": "countryCode",
-            "in": "path",
-            "description": "Three letter country code refering to the `postalCode` field.",
-            "required": true,
-            "style": "simple",
+            "name": "geoCoordinates",
+            "in": "query",
+            "description": "Geocoordinates (first longitude, then latitude) around which to search for pickup points. If you use this type of search, do not pass postal and country codes.",
+            "required": false,
+            "style": "form",
             "schema": {
-              "type": "string",
-              "default": "BRA"
+              "type": "array",
+              "default": [
+                -47.924747467041016,
+                -15.832582473754883
+              ],
+              "items": {
+                "type": "number",
+                "example": -47.924747467041016
+              }
             }
           },
           {
             "name": "postalCode",
-            "in": "path",
-            "description": "Postal code.",
-            "required": true,
-            "style": "simple",
+            "in": "query",
+            "description": "Postal code around which to search for pickup points. If you use this type of search, make sure to pass a `countryCode` and do not pass `geoCoordinates`.",
+            "required": false,
+            "style": "form",
             "schema": {
               "type": "string",
               "default": "1234000"
             }
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "OK",
-            "content": {
-              "application/json": {
-                "example": {
-                  "postalCode": "12345000",
-                  "city": "Rio de Janeiro",
-                  "state": "RJ",
-                  "country": "BRA",
-                  "street": "My street",
-                  "number": "",
-                  "neighborhood": "My neighborhood",
-                  "complement": "",
-                  "reference": "",
-                  "geoCoordinates": []
-                },
-                "schema": {
-                  "description": "Address.",
-                  "type": "object",
-                  "properties": {
-                    "postalCode": {
-                      "description": "Postal code.",
-                      "type": "string"
-                    },
-                    "city": {
-                      "description": "City.",
-                      "type": "string"
-                    },
-                    "state": {
-                      "description": "State.",
-                      "type": "string"
-                    },
-                    "country": {
-                      "description": "Country.",
-                      "type": "string"
-                    },
-                    "street": {
-                      "description": "Street.",
-                      "type": "string"
-                    },
-                    "number": {
-                      "description": "Number.",
-                      "type": "string"
-                    },
-                    "neighborhood": {
-                      "description": "Neighborhood.",
-                      "type": "string"
-                    },
-                    "complement": {
-                      "description": "Complement to the shipping address, in case it applies.",
-                      "type": "string",
-                      "nullable": true
-                    },
-                    "reference": {
-                      "description": "Reference.",
-                      "type": "string"
-                    },
-                    "geoCoordinates": {
-                      "description": "Geo coordinates.",
-                      "type": "array",
-                      "items": {
-                        "description": "Geo coordinate.",
-                        "type": "integer"
-                      }
-                    }
-                  }
-                }
-              }
-            }
-          }
-        }
-      }
-    },
-    "/api/checkout/pub/orderForm/{orderFormId}/transaction": {
-      "post": {
-        "tags": [
-          "Order placement"
-        ],
-        "summary": "Place order from an existing cart",
-        "description": "This endpoint places an order from an existing `orderForm` object, meaning an existing cart.\n\r\n\rAfter the creation of an order with this request, you have five minutes to send payment information and then request payment processing.",
-        "operationId": "PlaceOrderFromExistingOrderForm",
-        "security": [],
-        "parameters": [
-          {
-            "name": "orderFormId",
-            "in": "path",
-            "description": "ID of the `orderForm` corresponding to the cart from which to place the order.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "ede846222cd44046ba6c638442c3505a"
-            }
           },
           {
-            "name": "Content-Type",
-            "in": "header",
-            "description": "Type of the content being sent.",
-            "required": true,
-            "style": "simple",
-            "schema": {
-              "type": "string",
-              "default": "application/json"
-            }
-          },
-          {
-            "name": "Accept",
-            "in": "header",
-            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
-            "required": true,
-            "style": "simple",
+            "name": "countryCode",
+            "in": "query",
+            "description": "Three letter country code refering to the `postalCode` field. Pass the country code only if you are searching pickup points by postal code.",
+            "required": false,
+            "style": "form",
             "schema": {
               "type": "string",
-              "default": "application/json"
+              "default": "BRA"
             }
           }
         ],
-        "requestBody": {
-          "content": {
-            "application/json": {
-              "schema": {
-                "type": "object",
-                "title": "",
-                "required": [
-                  "referenceId",
-                  "value",
-                  "referenceValue",
-                  "interestValue"
-                ],
-                "properties": {
-                  "referenceId": {
-                    "title": "referenceId",
-                    "type": "string",
-                    "description": "ID of the `orderForm` corresponding to the cart from which to place the order. This is the same as the `orderFormId` parameter.",
-                    "default": "41a22925298a4ddca95318131a25b000"
-                  },
-                  "savePersonalData": {
-                    "title": "savePersonalData",
-                    "type": "boolean",
-                    "description": "`true` if the shopper's data provided during checkout should be saved for future reference.",
-                    "default": false
-                  },
-                  "optinNewsLetter": {
-                    "title": "optinNewsLetter",
-                    "type": "boolean",
-                    "description": "True if the shopper opted to receive the newsletter.",
-                    "default": false
-                  },
-                  "value": {
-                    "type": "integer",
-                    "description": "Total value of the order without separating cents. For example, $24.99 is represented `2499`.",
-                    "default": 6800
-                  },
-                  "referenceValue": {
-                    "type": "integer",
-                    "description": "Reference value of the order for calculating interest if that is the case. Can be equal to the total value and does not separate cents. For example, $24.99 is represented `2499`.",
-                    "default": 6800
-                  },
-                  "interestValue": {
-                    "type": "integer",
-                    "description": "Interest rate to be used in case it applies.",
-                    "default": 0
-                  }
-                }
-              }
-            }
-          }
-        },
         "responses": {
           "200": {
-            "description": "",
-            "headers": {},
+            "description": "OK",
             "content": {
               "application/json": {
-                "schema": {
-                  "type": "object"
-                },
                 "example": {
-                  "orderForm": null,
-                  "transactionData": {
-                    "merchantTransactions": [
-                      {
-                        "id": "STORE",
-                        "transactionId": "62FEDE228E2144649CF67812C4E5ER79",
-                        "merchantName": "STORE",
-                        "payments": [
+                  "paging": {
+                    "page": 1,
+                    "pageSize": 30,
+                    "total": 1,
+                    "pages": 1
+                  },
+                  "items": [
+                    {
+                      "distance": 0.84697865186165456,
+                      "pickupPoint": {
+                        "friendlyName": "physical-store-02",
+                        "address": {
+                          "addressType": "pickup",
+                          "receiverName": null,
+                          "addressId": "physical-store-02",
+                          "isDisposable": true,
+                          "postalCode": "23450-070",
+                          "city": "Rio de Janeiro",
+                          "state": "RJ",
+                          "country": "BRA",
+                          "street": "Praia de Botafogo",
+                          "number": "132",
+                          "neighborhood": "Botafogo",
+                          "complement": "",
+                          "reference": null,
+                          "geoCoordinates": [
+                            -47.924747467041016,
+                            -15.832582473754883
+                          ]
+                        },
+                        "additionalInfo": null,
+                        "id": "02_Physical",
+                        "businessHours": [
+                          {
+                            "DayOfWeek": 0,
+                            "OpeningTime": "00:00:00",
+                            "ClosingTime": "23:59:00"
+                          },
                           {
-                            "paymentSystem": "6",
-                            "bin": null,
-                            "accountId": null,
-                            "value": 15650,
-                            "referenceValue": 15650,
-                            "giftCardRedemptionCode": null,
-                            "giftCardProvider": null,
-                            "giftCardId": null
-                          }
-                        ]
-                      }
-                    ],
-                    "receiverUri": "https://store.vtexpayments.com.br/split/v976778amgh/payments",
-                    "gatewayCallbackTemplatePath": "/checkout/gatewayCallback/v976778amgh/{messageCode}"
-                  },
-                  "orders": [
-                    {
-                      "orderId": "v976778amgh-01",
-                      "orderGroup": "v976778amgh",
-                      "state": "order-created",
-                      "isCheckedIn": false,
-                      "sellerOrderId": "00-v976778amgh-01",
-                      "storeId": null,
-                      "value": 15650,
-                      "items": [
-                        {
-                          "uniqueId": "0F93E9C4926A4CD97FDD4C2599BDF9DB",
-                          "id": "2000016",
-                          "productId": "2000002",
-                          "refId": "35-Preto",
-                          "ean": null,
-                          "name": "Produto Seleção SKU - Lista 35 - Preto",
-                          "skuName": "35 - Preto",
-                          "modalType": null,
-                          "priceValidUntil": "2018-02-16T23:42:44.5467295Z",
-                          "tax": 0,
-                          "price": 15000,
-                          "listPrice": 15000,
-                          "manualPrice": null,
-                          "sellingPrice": 15000,
-                          "rewardValue": 1,
-                          "isGift": false,
-                          "additionalInfo": {
-                            "brandName": "Marca Um",
-                            "brandId": "1",
-                            "offeringInfo": null,
-                            "offeringType": null,
-                            "offeringTypeId": null
+                            "DayOfWeek": 1,
+                            "OpeningTime": "00:00:00",
+                            "ClosingTime": "23:59:00"
                           },
-                          "preSaleDate": null,
-                          "productCategoryIds": "/12/28/",
-                          "productCategories": {
-                            "28": "Categoria 5-3",
-                            "12": "Departamento 5"
+                          {
+                            "DayOfWeek": 2,
+                            "OpeningTime": "00:00:00",
+                            "ClosingTime": "23:59:00"
                           },
-                          "defaultPicker": null,
-                          "handlerSequence": 0,
-                          "handling": false,
-                          "quantity": 1,
-                          "seller": "1",
-                          "imageUrl": "http://store.vteximg.com.br/arquivos/ids/168463-55-55/imagem-modo-lista.png",
-                          "detailUrl": "/produto-selecao-sku-lista/p",
-                          "components": [],
-                          "bundleItems": [],
-                          "attachments": [],
-                          "itemAttachment": {
-                            "name": null,
-                            "content": {}
+                          {
+                            "DayOfWeek": 3,
+                            "OpeningTime": "00:00:00",
+                            "ClosingTime": "23:59:00"
                           },
-                          "attachmentOfferings": [],
-                          "offerings": [],
-                          "priceTags": [],
-                          "availability": "available",
-                          "measurementUnit": "un",
-                          "unitMultiplier": 1.0
-                        }
-                      ],
-                      "sellers": [
-                        {
-                          "id": "1",
-                          "name": "Store",
-                          "logo": ""
-                        }
-                      ],
-                      "totals": [
-                        {
-                          "id": "Items",
-                          "name": "Total dos Itens",
-                          "value": 15000
+                          {
+                            "DayOfWeek": 4,
+                            "OpeningTime": "00:00:00",
+                            "ClosingTime": "23:50:00"
+                          },
+                          {
+                            "DayOfWeek": 5,
+                            "OpeningTime": "00:00:00",
+                            "ClosingTime": "23:59:00"
+                          },
+                          {
+                            "DayOfWeek": 6,
+                            "OpeningTime": "00:00:00",
+                            "ClosingTime": "23:59:00"
+                          }
+                        ]
+                      }
+                    }
+                  ]
+                },
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "paging": {
+                      "description": "Paging.",
+                      "type": "object",
+                      "properties": {
+                        "page": {
+                          "description": "Page number.",
+                          "type": "integer"
                         },
-                        {
-                          "id": "Discounts",
-                          "name": "Total dos Descontos",
-                          "value": 0
+                        "pageSize": {
+                          "description": "Page size.",
+                          "type": "integer"
                         },
-                        {
-                          "id": "Shipping",
-                          "name": "Total do Frete",
-                          "value": 650
+                        "total": {
+                          "description": "Total pages.",
+                          "type": "integer"
                         },
-                        {
-                          "id": "Tax",
-                          "name": "Total da Taxa",
-                          "value": 0
+                        "pages": {
+                          "description": "Pages.",
+                          "type": "integer"
                         }
-                      ],
-                      "clientProfileData": {
-                        "attachmentId": "clientProfileData",
-                        "email": "marcelo@vtex.com.br",
-                        "firstName": "Marcelo",
-                        "lastName": "Couto",
-                        "document": "71279846675",
-                        "documentType": "cpf",
-                        "phone": "1234567890",
-                        "corporateName": null,
-                        "tradeName": null,
-                        "corporateDocument": null,
-                        "stateInscription": null,
-                        "corporatePhone": null,
-                        "isCorporate": false,
-                        "profileCompleteOnLoading": null,
-                        "profileErrorOnLoading": null
-                      },
-                      "ratesAndBenefitsData": {
-                        "attachmentId": "ratesAndBenefitsData",
-                        "rateAndBenefitsIdentifiers": [],
-                        "teaser": []
-                      },
-                      "shippingData": {
-                        "attachmentId": "shippingData",
-                        "address": {
-                          "addressType": "residential",
-                          "receiverName": "Marcelo",
-                          "addressId": "49ad09e5fba8434a8ff1e0faa4b60ceb",
-                          "postalCode": "28050987",
-                          "city": "Rio de Janeiro",
-                          "state": "RJ",
-                          "country": "BRA",
-                          "street": "Rua da minha casa",
-                          "number": "123",
-                          "neighborhood": "Copacabana",
-                          "complement": "15º andar",
-                          "reference": null,
-                          "geoCoordinates": []
-                        },
-                        "logisticsInfo": [
-                          {
-                            "itemIndex": 0,
-                            "selectedSla": "Normal",
-                            "slas": [
-                              {
-                                "id": "n2_2",
-                                "name": "n2_2",
-                                "deliveryIds": [
-                                  {
-                                    "courierId": "1de4790",
-                                    "warehouseId": "1_1",
-                                    "dockId": "N2",
-                                    "courierName": "N2_2",
-                                    "quantity": 1
-                                  }
-                                ],
-                                "shippingEstimate": "6bd",
-                                "shippingEstimateDate": null,
-                                "lockTTL": "7d",
-                                "availableDeliveryWindows": [
-                                  {
-                                    "startDateUtc": "2017-03-27T00:00:00+00:00",
-                                    "endDateUtc": "2017-03-27T00:00:00+00:00",
-                                    "price": 0,
-                                    "lisPrice": 0,
-                                    "tax": 0
-                                  },
-                                  {
-                                    "startDateUtc": "2017-03-28T00:00:00+00:00",
-                                    "endDateUtc": "2017-03-28T00:00:00+00:00",
-                                    "price": 0,
-                                    "lisPrice": 0,
-                                    "tax": 0
-                                  }
-                                ],
-                                "deliveryWindow": null,
-                                "price": 650,
-                                "listPrice": 650,
-                                "tax": 0,
-                                "pickupStoreInfo": {
-                                  "isPickupStore": false,
-                                  "friendlyName": null,
-                                  "address": null,
-                                  "additionalInfo": null,
-                                  "dockId": null
-                                }
+                      }
+                    },
+                    "items": {
+                      "description": "Items.",
+                      "type": "array",
+                      "items": {
+                        "description": "Item information.",
+                        "type": "object",
+                        "properties": {
+                          "distance": {
+                            "description": "Distance.",
+                            "type": "integer"
+                          },
+                          "pickupPoint": {
+                            "description": "Pickup point.",
+                            "type": "object",
+                            "properties": {
+                              "friendlyName": {
+                                "description": "Friendly name.",
+                                "type": "string"
                               },
-                              {
-                                "id": "Normal",
-                                "name": "Normal",
-                                "deliveryIds": [
-                                  {
-                                    "courierId": "2p1t",
-                                    "warehouseId": "1_1",
-                                    "dockId": "N2",
-                                    "courierName": "Post_Test_2",
-                                    "quantity": 1
+                              "address": {
+                                "description": "Address.",
+                                "type": "object",
+                                "properties": {
+                                  "addressType": {
+                                    "description": "Address type.",
+                                    "type": "string"
+                                  },
+                                  "receiverName": {
+                                    "description": "Receiver name.",
+                                    "type": "string"
+                                  },
+                                  "addressId": {
+                                    "description": "Address ID.",
+                                    "type": "string",
+                                    "nullable": true
+                                  },
+                                  "isDisposable": {
+                                    "description": "Is disposable.",
+                                    "type": "boolean"
+                                  },
+                                  "postalCode": {
+                                    "description": "Postal code.",
+                                    "type": "string"
+                                  },
+                                  "city": {
+                                    "description": "City.",
+                                    "type": "string"
+                                  },
+                                  "state": {
+                                    "description": "State.",
+                                    "type": "string"
+                                  },
+                                  "country": {
+                                    "description": "Country.",
+                                    "type": "string"
+                                  },
+                                  "street": {
+                                    "description": "Street.",
+                                    "type": "string"
+                                  },
+                                  "number": {
+                                    "description": "Number.",
+                                    "type": "string"
+                                  },
+                                  "neighborhood": {
+                                    "description": "Neighborhood.",
+                                    "type": "string"
+                                  },
+                                  "complement": {
+                                    "description": "Complement to the shipping address, in case it applies.",
+                                    "type": "string",
+                                    "nullable": true
+                                  },
+                                  "reference": {
+                                    "description": "Racao.",
+                                    "type": "string"
+                                  },
+                                  "geoCoordinates": {
+                                    "description": "Geo coordinates.",
+                                    "type": "array",
+                                    "items": {
+                                      "description": "Geo coordinate.",
+                                      "type": "integer"
+                                    }
                                   }
-                                ],
-                                "shippingEstimate": "6bd",
-                                "shippingEstimateDate": null,
-                                "lockTTL": "7d",
-                                "availableDeliveryWindows": [],
-                                "deliveryWindow": null,
-                                "price": 650,
-                                "listPrice": 650,
-                                "tax": 0,
-                                "pickupStoreInfo": {
-                                  "isPickupStore": false,
-                                  "friendlyName": null,
-                                  "address": null,
-                                  "additionalInfo": null,
-                                  "dockId": null
                                 }
                               },
-                              {
-                                "id": "P_T",
-                                "name": "P_T",
-                                "deliveryIds": [
-                                  {
-                                    "courierId": "1p1t",
-                                    "warehouseId": "1_1",
-                                    "dockId": "N2",
-                                    "courierName": "Post_Teste",
-                                    "quantity": 1
-                                  }
-                                ],
-                                "shippingEstimate": "6bd",
-                                "shippingEstimateDate": null,
-                                "lockTTL": "7d",
-                                "availableDeliveryWindows": [],
-                                "deliveryWindow": null,
-                                "price": 1462,
-                                "listPrice": 1462,
-                                "tax": 0,
-                                "pickupStoreInfo": {
-                                  "isPickupStore": false,
-                                  "friendlyName": null,
-                                  "address": null,
-                                  "additionalInfo": null,
-                                  "dockId": null
-                                }
+                              "additionalInfo": {
+                                "description": "Additional info.",
+                                "type": "string"
                               },
-                              {
-                                "id": "Econômica",
-                                "name": "Econômica",
-                                "deliveryIds": [
-                                  {
-                                    "courierId": "2B9C2C7D-7A76-485D-94EF-701D041E448C",
-                                    "warehouseId": "1_1",
-                                    "dockId": "1_1_1",
-                                    "courierName": "Leve 30kg (De: 10000-000 Até: 25999-999) ",
-                                    "quantity": 1
+                              "id": {
+                                "description": "ID.",
+                                "type": "string"
+                              },
+                              "businessHours": {
+                                "description": "Array with business hours.",
+                                "type": "array",
+                                "items": {
+                                  "description": "Business hours.",
+                                  "type": "object",
+                                  "properties": {
+                                    "DayOfWeek": {
+                                      "description": "Day of week.",
+                                      "type": "integer"
+                                    },
+                                    "OpeningTime": {
+                                      "description": "Opening time.",
+                                      "type": "string"
+                                    },
+                                    "ClosingTime": {
+                                      "description": "Closing time.",
+                                      "type": "string"
+                                    }
                                   }
-                                ],
-                                "shippingEstimate": "20bd",
-                                "shippingEstimateDate": null,
-                                "lockTTL": "7d",
-                                "availableDeliveryWindows": [],
-                                "deliveryWindow": null,
-                                "price": 2265,
-                                "listPrice": 2265,
-                                "tax": 0,
-                                "pickupStoreInfo": {
-                                  "isPickupStore": false,
-                                  "friendlyName": null,
-                                  "address": null,
-                                  "additionalInfo": null,
-                                  "dockId": null
                                 }
                               }
-                            ],
-                            "shipsTo": [
-                              "BRA"
-                            ],
-                            "itemId": "2000016"
-                          }
-                        ],
-                        "availableAddresses": [
-                          {
-                            "addressType": "residential",
-                            "receiverName": "Marcelo",
-                            "addressId": "49ad09e5fba8434a8ff1e0faa4b60ceb",
-                            "postalCode": "28050642",
-                            "city": "Rio de Janeiro",
-                            "state": "RJ",
-                            "country": "BRA",
-                            "street": "Rua da minha casa",
-                            "number": "123",
-                            "neighborhood": "Copacabana",
-                            "complement": "15º andar",
-                            "reference": null,
-                            "geoCoordinates": []
-                          }
-                        ]
-                      },
-                      "paymentData": {
-                        "attachmentId": "paymentData",
-                        "transactionId": "62FEDE228E2144649CF67812C4E5DD87",
-                        "payments": [],
-                        "giftCards": [],
-                        "transactions": [
-                          {
-                            "isActive": true,
-                            "transactionId": "62FEDE228E2144649CF67812C4E5DD87",
-                            "merchantName": "STORE",
-                            "payments": []
+                            }
                           }
-                        ],
-                        "merchantName": "STORE"
-                      },
-                      "clientPreferencesData": {
-                        "attachmentId": "clientPreferencesData",
-                        "locale": "pt-BR",
-                        "optinNewsLetter": true
-                      },
-                      "giftRegistryData": null,
-                      "marketingData": null,
-                      "storePreferencesData": {
-                        "countryCode": "BRA",
-                        "checkToSavePersonDataByDefault": false,
-                        "templateOptions": {
-                          "toggleCorporate": false
-                        },
-                        "timeZone": "E. South America Standard Time",
-                        "currencyCode": "BRL",
-                        "currencyLocale": 1046,
-                        "currencySymbol": "R$",
-                        "currencyFormatInfo": {
-                          "currencyDecimalDigits": 2,
-                          "currencyDecimalSeparator": ",",
-                          "currencyGroupSeparator": ".",
-                          "currencyGroupSize": 3,
-                          "startsWithCurrencySymbol": true
                         }
-                      },
-                      "openTextField": {
-                        "attachmentId": "openTextField",
-                        "value": null
-                      },
-                      "changeData": null,
-                      "salesChannel": "1",
-                      "followUpEmail": "f1e7309d88dd4633825ce183d52a50a6@ct.vtex.com.br",
-                      "creationDate": "2017-02-16T23:42:43.9605088Z",
-                      "lastChange": "2017-02-16T23:42:47.62285Z",
-                      "timeZoneCreationDate": "2017-02-16T21:42:43.9605088",
-                      "timeZoneLastChange": "2017-02-16T21:42:47.62285",
-                      "isCompleted": false,
-                      "hostName": "ambienteqa",
-                      "merchantName": null,
-                      "userType": "",
-                      "roundingError": 0
+                      }
                     }
-                  ]
+                  }
                 }
               }
             }
           }
-        },
-        "deprecated": false
+        }
+      }
+    },
+    "/api/checkout/pub/postal-code/{countryCode}/{postalCode}": {
+      "get": {
+        "tags": [
+          "Fulfillment"
+        ],
+        "summary": "Get address by postal code",
+        "description": "Retrieves address information for a given postal code and country.\r\n\r\nThis request can be used to implement auto complete functionality when a customer needs to fill in an address.",
+        "operationId": "GetAddressByPostalCode",
+        "security": [],
+        "parameters": [
+          {
+            "name": "Content-Type",
+            "in": "header",
+            "description": "Type of the content being sent.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "description": "HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "application/json"
+            }
+          },
+          {
+            "name": "countryCode",
+            "in": "path",
+            "description": "Three letter country code refering to the `postalCode` field.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "BRA"
+            }
+          },
+          {
+            "name": "postalCode",
+            "in": "path",
+            "description": "Postal code.",
+            "required": true,
+            "style": "simple",
+            "schema": {
+              "type": "string",
+              "default": "1234000"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "OK",
+            "content": {
+              "application/json": {
+                "example": {
+                  "postalCode": "12345000",
+                  "city": "Rio de Janeiro",
+                  "state": "RJ",
+                  "country": "BRA",
+                  "street": "My street",
+                  "number": "",
+                  "neighborhood": "My neighborhood",
+                  "complement": "",
+                  "reference": "",
+                  "geoCoordinates": []
+                },
+                "schema": {
+                  "description": "Address.",
+                  "type": "object",
+                  "properties": {
+                    "postalCode": {
+                      "description": "Postal code.",
+                      "type": "string"
+                    },
+                    "city": {
+                      "description": "City.",
+                      "type": "string"
+                    },
+                    "state": {
+                      "description": "State.",
+                      "type": "string"
+                    },
+                    "country": {
+                      "description": "Country.",
+                      "type": "string"
+                    },
+                    "street": {
+                      "description": "Street.",
+                      "type": "string"
+                    },
+                    "number": {
+                      "description": "Number.",
+                      "type": "string"
+                    },
+                    "neighborhood": {
+                      "description": "Neighborhood.",
+                      "type": "string"
+                    },
+                    "complement": {
+                      "description": "Complement to the shipping address, in case it applies.",
+                      "type": "string",
+                      "nullable": true
+                    },
+                    "reference": {
+                      "description": "Reference.",
+                      "type": "string"
+                    },
+                    "geoCoordinates": {
+                      "description": "Geo coordinates.",
+                      "type": "array",
+                      "items": {
+                        "description": "Geo coordinate.",
+                        "type": "integer"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
       }
     },
     "/api/checkout/pub/orders": {
diff --git a/vtex/utils/openapi/vtexid.openapi.json b/vtex/utils/openapi/vtexid.openapi.json
index a3dc465a0..31f30e04a 100644
--- a/vtex/utils/openapi/vtexid.openapi.json
+++ b/vtex/utils/openapi/vtexid.openapi.json
@@ -2085,4 +2085,4 @@
       "VtexIdclientAutCookie": []
     }
   ]
-}
\ No newline at end of file
+}

From b67147e49cd9818db2d3e59c78ad29a64818d48b Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Fri, 9 Jan 2026 14:07:25 -0400
Subject: [PATCH 74/93] fix: config loader type

---
 vtex/loaders/config.ts | 2 +-
 vtex/mod.ts            | 7 +------
 vtex/utils/types.ts    | 6 ++++++
 3 files changed, 8 insertions(+), 7 deletions(-)

diff --git a/vtex/loaders/config.ts b/vtex/loaders/config.ts
index 1a14a2323..0c17ac2ef 100644
--- a/vtex/loaders/config.ts
+++ b/vtex/loaders/config.ts
@@ -3,10 +3,10 @@ import { type createHttpClient } from "../../utils/http.ts";
 import { type AppContext } from "../mod.ts";
 import { type SP } from "../utils/client.ts";
 import { type OpenAPI as API } from "../utils/openapi/api.openapi.gen.ts";
-import { type OpenAPI as VCS } from "../utils/openapi/vcs.openapi.gen.ts";
 import { type OpenAPI as MY } from "../utils/openapi/my.openapi.gen.ts";
 import { type OpenAPI as VPAY } from "../utils/openapi/payments.openapi.gen.ts";
 import { type OpenAPI as SUB } from "../utils/openapi/subscriptions.openapi.gen.ts";
+import { type VCS } from "../utils/types.ts";
 
 export type Config = {
   sp: ReturnType<typeof createHttpClient<SP>>;
diff --git a/vtex/mod.ts b/vtex/mod.ts
index b5a0901da..b7ad6ce70 100644
--- a/vtex/mod.ts
+++ b/vtex/mod.ts
@@ -23,12 +23,7 @@ import { OpenAPI as API } from "./utils/openapi/api.openapi.gen.ts";
 import { OpenAPI as MY } from "./utils/openapi/my.openapi.gen.ts";
 import { OpenAPI as VPAY } from "./utils/openapi/payments.openapi.gen.ts";
 import { OpenAPI as SUB } from "./utils/openapi/subscriptions.openapi.gen.ts";
-import { OpenAPI as _VCS } from "./utils/openapi/vcs.openapi.gen.ts";
-import { OpenAPI as VTEXID } from "./utils/openapi/vtexid.openapi.gen.ts";
-import { OpenAPI as CHECKOUT } from "./utils/openapi/checkout.openapi.gen.ts";
-import { OpenAPI as LOGISTICS } from "./utils/openapi/logistics.openapi.gen.ts";
-
-type VCS = _VCS & LOGISTICS & VTEXID & CHECKOUT;
+import { VCS } from "./utils/types.ts";
 
 import { Segment } from "./utils/types.ts";
 
diff --git a/vtex/utils/types.ts b/vtex/utils/types.ts
index bb40602b0..0d56e56f0 100644
--- a/vtex/utils/types.ts
+++ b/vtex/utils/types.ts
@@ -1,8 +1,14 @@
+import { OpenAPI as CHECKOUT } from "./openapi/checkout.openapi.gen.ts";
+import { OpenAPI as LOGISTICS } from "./openapi/logistics.openapi.gen.ts";
 import { OpenAPI } from "./openapi/orders.openapi.gen.ts";
 import {
   ChangesAttachment,
+  OpenAPI as _VCS,
   PaymentData as PaymentDataOpenAPI,
 } from "./openapi/vcs.openapi.gen.ts";
+import { OpenAPI as VTEXID } from "./openapi/vtexid.openapi.gen.ts";
+
+export type VCS = _VCS & LOGISTICS & VTEXID & CHECKOUT;
 
 /**
  * @format dynamic-options

From 1b5b0c52c84f7c897b329ddb0c6f5ebbe8d89f9d Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Fri, 9 Jan 2026 14:45:11 -0400
Subject: [PATCH 75/93] feat: add missing param

---
 vtex/loaders/cart.ts | 3 ++-
 vtex/utils/client.ts | 2 +-
 2 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/vtex/loaders/cart.ts b/vtex/loaders/cart.ts
index f441d8994..267444924 100644
--- a/vtex/loaders/cart.ts
+++ b/vtex/loaders/cart.ts
@@ -9,6 +9,7 @@ import { forceHttpsOnAssets } from "../utils/transform.ts";
 interface Props {
   orderformId?: string;
   ignoreSetCookie?: boolean;
+  forceNewCart?: boolean;
 }
 
 /**
@@ -28,7 +29,7 @@ const loader = async (
   const segment = getSegmentFromBag(ctx);
 
   const response = await vcsDeprecated["POST /api/checkout/pub/orderForm"](
-    { sc: segment?.payload?.channel },
+    { sc: segment?.payload?.channel, forceNewCart: props.forceNewCart || false },
     { headers: { cookie } },
   );
 
diff --git a/vtex/utils/client.ts b/vtex/utils/client.ts
index 05a567f07..0047c0c84 100644
--- a/vtex/utils/client.ts
+++ b/vtex/utils/client.ts
@@ -182,7 +182,7 @@ export interface VTEXCommerceStable {
     };
   };
   "POST /api/checkout/pub/orderForm": {
-    searchParams: { sc?: string };
+    searchParams: { sc?: string; forceNewCart?: boolean };
     response: OrderForm;
   };
   "GET /api/checkout/pub/orderForm/:orderFormId/installments": {

From 4b92473f38808b49a4b0e6bc257bf43a89b3854d Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Wed, 14 Jan 2026 12:30:11 -0400
Subject: [PATCH 76/93] refactor: page types

---
 vtex/utils/intelligentSearch.ts | 43 ++++++++++++++++++++++++++++++---
 1 file changed, 39 insertions(+), 4 deletions(-)

diff --git a/vtex/utils/intelligentSearch.ts b/vtex/utils/intelligentSearch.ts
index 754fcefbb..315ffe428 100644
--- a/vtex/utils/intelligentSearch.ts
+++ b/vtex/utils/intelligentSearch.ts
@@ -145,12 +145,13 @@ export const setISCookiesBag = (
 export const isFilterParam = (keyFilter: string): boolean =>
   keyFilter.startsWith("filter.");
 
-const segmentsFromTerm = (term: string) => term.split("/").filter(Boolean);
+const segmentsFromPath = (url: string) =>
+  new URL(url, "http://localhost").pathname.split("/").filter(Boolean);
 
 const segmentsFromSearchParams = (url: string) => {
   const searchParams = new URLSearchParams(url).entries();
 
-  const categories = Array.from(searchParams).toSorted()
+  const filters = Array.from(searchParams).toSorted()
     .reduce((acc, [key, value]) => {
       if (key.includes("filter.category")) {
         acc.push(value);
@@ -159,14 +160,48 @@ const segmentsFromSearchParams = (url: string) => {
       return acc;
     }, [] as string[]);
 
-  return categories.length ? categories : segmentsFromTerm(url);
+  return filters;
+};
+
+const segmentsFromUrl = (url: string): string[] => {
+  const fromPath = segmentsFromPath(url).map((p) => p.toLowerCase());
+  const fromSearchParams = segmentsFromSearchParams(url).map((s) =>
+    s.toLowerCase()
+  );
+
+  if (!fromSearchParams.length) {
+    return fromPath;
+  }
+
+  if (!fromPath.length) {
+    return fromSearchParams;
+  }
+
+  fromSearchParams.push(
+    ...fromPath.filter((p) => !fromSearchParams.some((s) => s === p)),
+  );
+
+  return fromSearchParams.sort((a, b) => {
+    const indexOfA = fromPath.indexOf(a);
+    const indexOfB = fromPath.indexOf(b);
+
+    if (indexOfB === -1) {
+      return -1;
+    }
+
+    if (indexOfA === -1) {
+      return 1;
+    }
+
+    return 0;
+  });
 };
 
 export const pageTypesFromUrl = async (
   url: string,
   ctx: AppContext,
 ) => {
-  const segments = segmentsFromSearchParams(url);
+  const segments = segmentsFromUrl(url);
   const { vcsDeprecated } = ctx;
 
   return await Promise.all(

From 857c239c9027c5e57bda9e78db65e2800204d1ca Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Wed, 14 Jan 2026 13:36:16 -0400
Subject: [PATCH 77/93] fix: page types order

---
 vtex/utils/intelligentSearch.ts | 21 ++++++---------------
 1 file changed, 6 insertions(+), 15 deletions(-)

diff --git a/vtex/utils/intelligentSearch.ts b/vtex/utils/intelligentSearch.ts
index 315ffe428..a385e7bfa 100644
--- a/vtex/utils/intelligentSearch.ts
+++ b/vtex/utils/intelligentSearch.ts
@@ -177,24 +177,15 @@ const segmentsFromUrl = (url: string): string[] => {
     return fromSearchParams;
   }
 
-  fromSearchParams.push(
-    ...fromPath.filter((p) => !fromSearchParams.some((s) => s === p)),
-  );
-
-  return fromSearchParams.sort((a, b) => {
-    const indexOfA = fromPath.indexOf(a);
-    const indexOfB = fromPath.indexOf(b);
+  const segments = [...fromPath];
 
-    if (indexOfB === -1) {
-      return -1;
-    }
-
-    if (indexOfA === -1) {
-      return 1;
+  for (const segment of fromSearchParams) {
+    if (!segments.includes(segment)) {
+      segments.push(segment);
     }
+  }
 
-    return 0;
-  });
+  return segments;
 };
 
 export const pageTypesFromUrl = async (

From f3ad41995b4e51eaeb0d7af514e1d6cf1b273b36 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Tue, 20 Jan 2026 12:38:51 -0400
Subject: [PATCH 78/93] Squashed commit of the following:

commit ecac91e7670c0582a07e316884ffd532b935f91e
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Mon Jan 19 16:04:08 2026 +0000

    Update version to 0.133.25

commit 80b2920ce9d0b5ad031ac70f589ca92855531e5b
Author: guitavano <tavano62@gmail.com>
Date:   Mon Jan 19 13:03:53 2026 -0300

    Tavano/add cacheable matchers (#1511)

    * add cacheable matchers

    * fmt

commit dee3782d110a2ec7ba0367c6768df40735fc63b6
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Wed Jan 7 19:54:04 2026 +0000

    Update version to 0.133.24

commit 800e3a933a18d1094fab7fafae70ef98e708a8e1
Author: guitavano <tavano62@gmail.com>
Date:   Wed Jan 7 16:53:54 2026 -0300

    optmize magento (#1507)

    * optmize magento

    * fmt

commit e5f8a84e6ff320d0abc66281ee2e87513bb7ba1b
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Tue Jan 6 16:32:31 2026 +0000

    Update version to 0.133.23

commit d05f11e688209c9c66bf877f34cbb7dd27a34300
Author: guitavano <tavano62@gmail.com>
Date:   Tue Jan 6 13:32:20 2026 -0300

    fix fuzzy (#1506)

commit 30ca287c489c40eee4d9fe672020805e6744ccd6
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Tue Dec 23 21:38:11 2025 +0000

    Update version to 0.133.22

commit a42a08ec2c1042dbfe978254ce8edf78cfa7274a
Author: guitavano <tavano62@gmail.com>
Date:   Tue Dec 23 18:38:01 2025 -0300

    Refactor _Controls component by removing unused DomInspector code and related logic (#1504)

commit 9dd7e8ac668d4f4a6405b7d36392654c9d03503c
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Wed Dec 17 19:40:34 2025 +0000

    Update version to 0.133.21

commit fa0c5a8124e224955a6f266f94c0d4fa68d05376
Author: Pedro Bernardina <pedro.bernardina@guidance.dev>
Date:   Wed Dec 17 16:40:21 2025 -0300

    feat(vtex): add schema parameter to Masterdata loaders and actions (#1502)

    Co-authored-by: decobot <capy@deco.cx>

commit 05e5834a28e9c4387e9e4dc1e17385027c01d531
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Wed Dec 10 19:42:04 2025 +0000

    Update version to 0.133.20

commit 46f346d0d943cbc6158e0372d437e5952fea00a1
Author: guitavano <tavano62@gmail.com>
Date:   Wed Dec 10 16:41:51 2025 -0300

    add wake optimization for images (#1501)

    * add wake optimization for images

    * fmt

commit 2b0d58354fd49a6d7b77f7866e702631c0dbf245
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Wed Dec 10 16:27:37 2025 +0000

    Update version to 0.133.19

commit 47bb82e3c281f7621e33043f4dc8a977714d18f2
Author: guitavano <tavano62@gmail.com>
Date:   Wed Dec 10 13:27:25 2025 -0300

    remove console.warn from Image Component (#1499)

commit 6b8525b37eb0810d3d6ede922fa198d74b0dc3ce
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Wed Dec 10 16:25:05 2025 +0000

    Update version to 0.133.18

commit 3c7a7be561e4f8b51b11280a22f8abd902e06162
Author: guitavano <tavano62@gmail.com>
Date:   Wed Dec 10 13:24:53 2025 -0300

    add Vary Cookie (#1483)

    * add Vary Cookie

    * only vary cookie if includes checkout

    * clear cookie if mismatch

    * improve log

    * only clear specific orderFormIds

    * clear blocklist even if it is not mismatch

    * Add orderFormIdsToClear variable for improved cart handling

    * handling better with logged cases

    * removed clear cart cookie

    * removed custom header from checkout

    ---------

    Co-authored-by: decobot <capy@deco.cx>

commit 7f44e26f865348d7d409879a7d6025ef4aa011d0
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Wed Dec 10 15:26:23 2025 +0000

    Update version to 0.133.17

commit 535e9ac9d2c38dcce98504c41e6f377c030eb495
Author: L. Sacci <167649583+aka-sacci-ccr@users.noreply.github.com>
Date:   Wed Dec 10 12:26:11 2025 -0300

    added inventory (#1498)

    Co-authored-by: decobot <capy@deco.cx>

commit a94f6ad323e96e0059ead8146063c67d5a5af108
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Mon Dec 8 17:09:48 2025 +0000

    Update version to 0.133.16

commit c1ceeef579f9728fe1775afa49b4fd7358f5fae6
Author: guitavano <tavano62@gmail.com>
Date:   Mon Dec 8 14:09:32 2025 -0300

    add data.decoassets.com (#1496)

    * add data.decoassets.com

    * fmt

commit ecc4a9d7dc8fb1ca9bec7c1cb8ef7f8b471a14f2
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Fri Dec 5 16:56:50 2025 +0000

    Update version to 0.133.15

commit 7c8f79dd9c3a1df42113ed9be2cf9d0423bcef75
Author: L. Sacci <167649583+aka-sacci-ccr@users.noreply.github.com>
Date:   Fri Dec 5 13:56:40 2025 -0300

    feat(hubspot): update ticket tool (#1495)

    * feat(hubspot): update ticket tool

    * updated gen

    * updated gen

    ---------

    Co-authored-by: decobot <capy@deco.cx>

commit 3337db5da0239ccbe6d511dd49c415bd1a8d25ab
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Thu Dec 4 23:33:04 2025 +0000

    Update version to 0.133.14

commit e2b9abe0b470cec4132382a7bd7cebff5a0c2d60
Author: L. Sacci <167649583+aka-sacci-ccr@users.noreply.github.com>
Date:   Thu Dec 4 20:32:53 2025 -0300

    fix(hubspot): thread params (#1494)

    Co-authored-by: decobot <capy@deco.cx>

commit cd8a9ebce064275a2a8a63472957ba7a99a6c695
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Tue Dec 2 13:35:08 2025 +0000

    Update version to 0.133.13

commit 3afb7e1d18bb2762d84750dd12d07da1af435dfd
Author: L. Sacci <167649583+aka-sacci-ccr@users.noreply.github.com>
Date:   Tue Dec 2 10:34:51 2025 -0300

    fix(linx): added forcing source (#1490)

    * fix(linx): added forcing source

    * fmt

    * regen drive manifest

    ---------

    Co-authored-by: decobot <capy@deco.cx>

commit 3831358c844c05a87d9aa7e76e0f7c570348161b
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Tue Dec 2 13:33:55 2025 +0000

    Update version to 0.133.12

commit 4bfe75199415ac0ea514f13db01f32aada86c2a7
Author: L. Sacci <167649583+aka-sacci-ccr@users.noreply.github.com>
Date:   Tue Dec 2 10:33:34 2025 -0300

    fix(vtex): listingPage loader sort (#1491)

    Co-authored-by: decobot <capy@deco.cx>

commit 7fcdb230d16bb173e6a60a8510473d849268d328
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Mon Dec 1 19:01:09 2025 +0000

    Update version to 0.133.11

commit 5887e18b905bad8dc99e32e5206ca1b5e0612e1b
Author: L. Sacci <167649583+aka-sacci-ccr@users.noreply.github.com>
Date:   Mon Dec 1 16:00:55 2025 -0300

    small fix in hub client (#1492)

    * small fix in hub client

    * fix in drive manifest

    ---------

    Co-authored-by: decobot <capy@deco.cx>

commit 67f142f88d13a6201aa33ceb04b0b668ba0df379
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Thu Nov 27 05:00:50 2025 +0000

    Update version to 0.133.10

commit 3f1c594adbd1cbcc69b0590beedcf3c7ed00dae6
Author: Jonas Jesus <jonasjesus@carcara.tech>
Date:   Thu Nov 27 02:00:39 2025 -0300

    feat: add download file action for Google Drive with multiple output formats (#1489)

    - Add DownloadFileParams and DownloadFileResult interfaces in types.ts
    - Add download endpoint to Client interface in client.ts
    - Add error constants for download operations in constant.ts
    - Create new download.ts action with support for 3 output formats:
      * link: Returns webContentLink without actual file download
      * base64: Downloads file and returns as base64 string
      * blob: Downloads file and returns as ArrayBuffer
    - Update mod.ts to include new error handlers

commit 9bf0b5a14cafe7b7f601420c792388abc5c74cd9
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Tue Nov 25 19:21:39 2025 +0000

    Update version to 0.133.9

commit 52100b12c1ab7560f22e6eb9d8e7eda354f15891
Author: Renan Henrique <93907598+RenanHCosta@users.noreply.github.com>
Date:   Tue Nov 25 16:21:24 2025 -0300

    feat: VNDA productListingPage default sorting param (#1481)

    * feat: VNDA productListingPage default sorting param

    * fix: cacheKey sort precedence order

commit 278fcbfdbaa03251803a3d2b57daa6c189f1d716
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Fri Nov 21 13:43:21 2025 +0000

    Update version to 0.133.8

commit 5906a9944cec1dbf19be4f929f4f0bf27d368e3f
Author: L. Sacci <167649583+aka-sacci-ccr@users.noreply.github.com>
Date:   Fri Nov 21 10:43:10 2025 -0300

    fmt (#1485)

    Co-authored-by: decobot <capy@deco.cx>

commit 91ea12e68f0a6d9b551503a2df849e2e70cd916a
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Fri Nov 21 13:38:56 2025 +0000

    Update version to 0.133.7

commit a708ba71f19db9e42d783b1ada195825718b1ea6
Author: Rafael Oliveira <87982042+pandeiro7@users.noreply.github.com>
Date:   Fri Nov 21 10:38:40 2025 -0300

    feat: simulationBehavior productDetails (#1453)

    * feat: simulationBehavior productDetails

    * fix(pdp): simulation behaviour fallback

    ---------

    Co-authored-by: pandeiro7 <dev@tec4udigital.com>
    Co-authored-by: L. Sacci <167649583+aka-sacci-ccr@users.noreply.github.com>

commit 4fae26e3bf468b2fcf87649c9b6bd0b293c4bf4f
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Wed Nov 19 13:01:00 2025 +0000

    Update version to 0.133.6

commit 60cbaf26def11aa2f9a123b6182d63ea43fd1565
Author: Tiago Gimenes <tlgimenes@gmail.com>
Date:   Wed Nov 19 10:00:46 2025 -0300

    chore: add logs to cart (#1482)

    * add logs to cart

    * add logs to cart

commit 8ca84a8b38b40a5ca5bc6092ff171946bc5b923c
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Wed Nov 19 00:29:24 2025 +0000

    Update version to 0.133.5

commit 728a9674a9bce17d92eac560b3613c0a005601c1
Author: Marcos Candeia <marrcooos@gmail.com>
Date:   Tue Nov 18 21:29:12 2025 -0300

    Deduplicate vtex cookie (#1480)

    * Deduplicate vtex cookie

    Signed-off-by: Marcos Candeia <marrcooos@gmail.com>

    * Use cookie with orderFormId on marketing data

    Signed-off-by: Marcos Candeia <marrcooos@gmail.com>

    * Fix orderform fn

    Signed-off-by: Marcos Candeia <marrcooos@gmail.com>

    * Format ts

    Signed-off-by: Marcos Candeia <marrcooos@gmail.com>

    * Adds cache no store

    Signed-off-by: Marcos Candeia <marrcooos@gmail.com>

    ---------

    Signed-off-by: Marcos Candeia <marrcooos@gmail.com>

commit 3b1a4a55ea64b2669c496b7e80ba5b82d4d33578
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Mon Nov 17 15:03:05 2025 +0000

    Update version to 0.133.4

commit e1aa80f4f18d0a9ac919103f4c02964109f6b24d
Author: Jonas Jesus <jonasjesus@carcara.tech>
Date:   Mon Nov 17 12:02:48 2025 -0300

    Error docs (#1478)

    * fix: adjust return errors

    * fix: adjust return type to handle document retrieval errors properly

    * refactor: remove listDocuments and searchDocuments loaders to streamline document handling

    * refactor: update manifest to remove unused loaders and streamline imports

commit 89cd94c4605a8fa3805078a2b10669fc921df9af
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Mon Nov 17 14:13:49 2025 +0000

    Update version to 0.133.3

commit 09732efe362d3334fa03ee5fff69bf6bca33ff81
Author: Jonas Jesus <jonasjesus@carcara.tech>
Date:   Mon Nov 17 11:13:36 2025 -0300

    fix: adjust return errors (#1477)

    * fix: adjust return errors

    * fix: adjust return type to handle document retrieval errors properly
---
 deno.json                                     |    2 +-
 google-docs/loaders/getDocument.ts            |   81 +-
 google-docs/loaders/listDocuments.ts          |   99 --
 google-docs/loaders/searchDocuments.ts        |  158 --
 google-docs/manifest.gen.ts                   |   12 +-
 google-drive/actions/files/download.ts        |   95 ++
 google-drive/manifest.gen.ts                  |   14 +-
 google-drive/mod.ts                           |    4 +
 google-drive/utils/client.ts                  |    7 +
 google-drive/utils/constant.ts                |    2 +
 google-drive/utils/types.ts                   |   14 +
 hubspot/actions/crm/updateTicket.ts           |   54 +
 hubspot/loaders/conversations/getThread.ts    |   16 +-
 hubspot/manifest.gen.ts                       |   34 +-
 hubspot/utils/client.ts                       |    2 +-
 linx-impulse/loaders/products/linxEngage.ts   |   15 +-
 linx-impulse/loaders/products/productLists.ts |    9 +-
 linx-impulse/loaders/search/autocomplete.ts   |    9 +-
 linx-impulse/loaders/search/popular.ts        |    9 +-
 linx-impulse/loaders/search/products.ts       |    9 +-
 vnda/loaders/productDetailsPage.ts            |    1 +
 vnda/loaders/productListingPage.ts            |   10 +-
 vnda/utils/client/client.ts                   |    2 +-
 vnda/utils/transform.ts                       |   16 +
 vtex/actions/masterdata/createDocument.ts     |    7 +-
 vtex/actions/masterdata/updateDocument.ts     |    7 +-
 vtex/loaders/cart.ts                          |   95 +-
 .../intelligentSearch/productDetailsPage.ts   |   15 +-
 .../intelligentSearch/productListingPage.ts   |   20 +-
 vtex/loaders/legacy/productListingPage.ts     |   10 +-
 .../logistics/listPickupPointsByLocation.ts   |    8 +-
 vtex/loaders/masterdata/searchDocuments.ts    |    7 +-
 vtex/utils/client.ts                          |    3 +
 vtex/utils/intelligentSearch.ts               |    4 +-
 vtex/utils/openapi/checkout.openapi.gen.ts    | 1356 +++++++++--------
 vtex/utils/openapi/vcs.openapi.gen.ts         |   39 +-
 vtex/utils/openapi/vcs.openapi.json           |   39 +-
 vtex/utils/orderForm.ts                       |   20 +-
 vtex/utils/segment.ts                         |    9 +
 website/components/Image.tsx                  |   56 +-
 website/components/_Controls.tsx              |   30 +-
 website/matchers/always.ts                    |    2 +
 website/matchers/date.ts                      |    2 +
 website/matchers/never.ts                     |    2 +
 44 files changed, 1313 insertions(+), 1092 deletions(-)
 delete mode 100644 google-docs/loaders/listDocuments.ts
 delete mode 100644 google-docs/loaders/searchDocuments.ts
 create mode 100644 google-drive/actions/files/download.ts
 create mode 100644 hubspot/actions/crm/updateTicket.ts

diff --git a/deno.json b/deno.json
index 36062db90..0ccf51d56 100644
--- a/deno.json
+++ b/deno.json
@@ -69,5 +69,5 @@
       ]
     }
   },
-  "version": "0.133.2"
+  "version": "0.133.25"
 }
diff --git a/google-docs/loaders/getDocument.ts b/google-docs/loaders/getDocument.ts
index 5e0ed22fe..e949891fb 100644
--- a/google-docs/loaders/getDocument.ts
+++ b/google-docs/loaders/getDocument.ts
@@ -48,7 +48,7 @@ const loader = async (
   props: Props,
   _req: Request,
   ctx: AppContext,
-): Promise<DocumentResponse> => {
+): Promise<(DocumentResponse & { error?: string }) | { error: string }> => {
   const {
     documentId,
     includeTabsContent = false,
@@ -57,65 +57,54 @@ const loader = async (
   } = props;
 
   if (!documentId) {
-    ctx.errorHandler.toHttpError(
-      new Error("Document ID is required"),
-      "Document ID is required",
-    );
+    return {
+      error: "Document ID is required",
+    };
   }
 
   if (!validateDocumentId(documentId)) {
-    ctx.errorHandler.toHttpError(
-      new Error("Invalid document ID format"),
-      "Invalid document ID format",
-    );
-  }
-
-  try {
-    const searchParams: Record<string, string | boolean> = {
-      includeTabsContent,
-      suggestionsViewMode,
+    return {
+      error: "Invalid document ID format",
     };
+  }
 
-    const response = await ctx.client["GET /v1/documents/:documentId"]({
-      documentId,
-      ...searchParams,
-    });
+  const searchParams: Record<string, string | boolean> = {
+    includeTabsContent,
+    suggestionsViewMode,
+  };
 
-    if (!response.ok) {
-      ctx.errorHandler.toHttpError(
-        response,
-        `Error retrieving document: ${response.statusText}`,
-      );
-    }
+  const response = await ctx.client["GET /v1/documents/:documentId"]({
+    documentId,
+    ...searchParams,
+  });
 
-    const document = await response.json();
+  if (!response.ok) {
+    return {
+      error: `Error retrieving document: ${response.statusText}`,
+    };
+  }
 
-    const result: DocumentResponse = { ...document };
+  const document = await response.json();
 
-    if (contentFormat === "TEXT_ONLY" || contentFormat === "FULL") {
-      const textContent = extractTextFromDocument(document);
-      result.textContent = textContent;
+  const result: DocumentResponse = { ...document };
 
-      if (textContent) {
-        result.wordCount = textContent.split(/\s+/).filter((word) =>
-          word.length > 0
-        ).length;
-        result.characterCount = textContent.length;
-      }
-    }
+  if (contentFormat === "TEXT_ONLY" || contentFormat === "FULL") {
+    const textContent = extractTextFromDocument(document);
+    result.textContent = textContent;
 
-    if (contentFormat === "METADATA_ONLY") {
-      delete result.body;
+    if (textContent) {
+      result.wordCount = textContent.split(/\s+/).filter((word) =>
+        word.length > 0
+      ).length;
+      result.characterCount = textContent.length;
     }
+  }
 
-    return result;
-  } catch (error) {
-    ctx.errorHandler.toHttpError(
-      error,
-      `Failed to retrieve document: ${documentId}`,
-    );
-    throw error;
+  if (contentFormat === "METADATA_ONLY") {
+    delete result.body;
   }
+
+  return result;
 };
 
 export default loader;
diff --git a/google-docs/loaders/listDocuments.ts b/google-docs/loaders/listDocuments.ts
deleted file mode 100644
index 5da63fe97..000000000
--- a/google-docs/loaders/listDocuments.ts
+++ /dev/null
@@ -1,99 +0,0 @@
-import { AppContext } from "../mod.ts";
-import { DocumentsListResponse } from "../utils/types.ts";
-
-export interface Props {
-  /**
-   * @description Maximum number of documents to return
-   * @title Page Size
-   */
-  pageSize?: number;
-
-  /**
-   * @description Token for retrieving the next page of results
-   * @title Page Token
-   */
-  pageToken?: string;
-
-  /**
-   * @description Search query to filter documents by title or content
-   * @title Search Query
-   */
-  query?: string;
-
-  /**
-   * @description Order documents by creation or modification date
-   * @title Order By
-   */
-  orderBy?: "createdTime" | "modifiedTime" | "name";
-
-  /**
-   * @description Whether to include shared documents
-   * @title Include Shared
-   */
-  includeShared?: boolean;
-}
-
-/**
- * @title List Documents
- * @description Retrieves a list of Google Docs documents with optional filtering and pagination
- */
-const loader = async (
-  props: Props,
-  _req: Request,
-  ctx: AppContext,
-): Promise<DocumentsListResponse> => {
-  const {
-    pageSize = 10,
-    pageToken,
-    query,
-    orderBy = "modifiedTime",
-    includeShared = true,
-  } = props;
-
-  try {
-    const searchParams: Record<string, string | number | boolean> = {
-      pageSize: Math.min(pageSize, 100),
-    };
-
-    if (pageToken) {
-      searchParams.pageToken = pageToken;
-    }
-
-    if (query) {
-      searchParams.q = query;
-    }
-
-    if (orderBy) {
-      searchParams.orderBy = orderBy;
-    }
-
-    const response = await ctx.client["GET /v1/documents"](searchParams);
-
-    if (!response.ok) {
-      ctx.errorHandler.toHttpError(
-        response,
-        `Error listing documents: ${response.statusText}`,
-      );
-      throw new Error("Request failed");
-    }
-
-    const data = await response.json();
-
-    const filteredDocuments = includeShared
-      ? data.documents
-      : data.documents.filter((doc: { shared?: boolean }) => !doc.shared);
-
-    return {
-      documents: filteredDocuments,
-      nextPageToken: data.nextPageToken,
-    };
-  } catch (error) {
-    ctx.errorHandler.toHttpError(
-      error,
-      "Failed to list documents",
-    );
-    throw error;
-  }
-};
-
-export default loader;
diff --git a/google-docs/loaders/searchDocuments.ts b/google-docs/loaders/searchDocuments.ts
deleted file mode 100644
index 4446c03f1..000000000
--- a/google-docs/loaders/searchDocuments.ts
+++ /dev/null
@@ -1,158 +0,0 @@
-import { AppContext } from "../mod.ts";
-import { DocumentMetadata, DocumentsListResponse } from "../utils/types.ts";
-
-export interface Props {
-  /**
-   * @description Search query for document title or content
-   * @title Search Query
-   */
-  query: string;
-
-  /**
-   * @description Search in document title only
-   * @title Title Only
-   */
-  titleOnly?: boolean;
-
-  /**
-   * @description Filter by document owner email
-   * @title Owner Email
-   */
-  ownerEmail?: string;
-
-  /**
-   * @description Filter by last modified date (ISO format)
-   * @title Modified After
-   */
-  modifiedAfter?: string;
-
-  /**
-   * @description Filter by last modified date (ISO format)
-   * @title Modified Before
-   */
-  modifiedBefore?: string;
-
-  /**
-   * @description Maximum number of results to return
-   * @title Max Results
-   */
-  maxResults?: number;
-
-  /**
-   * @description Token for pagination
-   * @title Page Token
-   */
-  pageToken?: string;
-
-  /**
-   * @description Include shared documents in search
-   * @title Include Shared
-   */
-  includeShared?: boolean;
-}
-
-/**
- * @title Search Documents
- * @description Search Google Docs documents by title, content, owner, and date filters
- */
-const loader = async (
-  props: Props,
-  _req: Request,
-  ctx: AppContext,
-): Promise<DocumentsListResponse> => {
-  const {
-    query,
-    titleOnly = false,
-    ownerEmail,
-    modifiedAfter,
-    modifiedBefore,
-    maxResults = 20,
-    pageToken,
-    includeShared = true,
-  } = props;
-
-  if (!query || query.trim().length === 0) {
-    ctx.errorHandler.toHttpError(
-      new Error("Search query is required"),
-      "Search query is required",
-    );
-    throw new Error("Search query is required");
-  }
-
-  try {
-    let searchQuery = query.trim();
-
-    if (titleOnly) {
-      searchQuery = `name contains '${searchQuery}'`;
-    } else {
-      searchQuery = `fullText contains '${searchQuery}'`;
-    }
-
-    if (ownerEmail) {
-      searchQuery += ` and '${ownerEmail}' in owners`;
-    }
-
-    if (modifiedAfter) {
-      const date = new Date(modifiedAfter).toISOString();
-      searchQuery += ` and modifiedTime > '${date}'`;
-    }
-
-    if (modifiedBefore) {
-      const date = new Date(modifiedBefore).toISOString();
-      searchQuery += ` and modifiedTime < '${date}'`;
-    }
-
-    if (!includeShared) {
-      searchQuery += ` and sharedWithMe = false`;
-    }
-
-    searchQuery += ` and mimeType = 'application/vnd.google-apps.document'`;
-
-    const searchParams: Record<string, string | number> = {
-      q: searchQuery,
-      pageSize: Math.min(maxResults, 100),
-      orderBy: "modifiedTime desc",
-    };
-
-    if (pageToken) {
-      searchParams.pageToken = pageToken;
-    }
-
-    const response = await ctx.client["GET /v1/documents"](searchParams);
-
-    if (!response.ok) {
-      ctx.errorHandler.toHttpError(
-        response,
-        `Error searching documents: ${response.statusText}`,
-      );
-      throw new Error("Request failed");
-    }
-
-    const data = await response.json();
-
-    const filteredDocuments = data.documents.filter((doc: DocumentMetadata) => {
-      if (!includeShared && doc.shared) {
-        return false;
-      }
-
-      if (titleOnly) {
-        return doc.title.toLowerCase().includes(query.toLowerCase());
-      }
-
-      return true;
-    });
-
-    return {
-      documents: filteredDocuments,
-      nextPageToken: data.nextPageToken,
-    };
-  } catch (error) {
-    ctx.errorHandler.toHttpError(
-      error,
-      `Failed to search documents with query: ${query}`,
-    );
-    throw error;
-  }
-};
-
-export default loader;
diff --git a/google-docs/manifest.gen.ts b/google-docs/manifest.gen.ts
index ed8063aa9..3ae831184 100644
--- a/google-docs/manifest.gen.ts
+++ b/google-docs/manifest.gen.ts
@@ -8,19 +8,15 @@ import * as $$$$$$$$$2 from "./actions/oauth/callback.ts";
 import * as $$$$$$$$$3 from "./actions/updateDocumentContent.ts";
 import * as $$$0 from "./loaders/getDocument.ts";
 import * as $$$1 from "./loaders/getDocumentMetadata.ts";
-import * as $$$2 from "./loaders/listDocuments.ts";
-import * as $$$3 from "./loaders/listSharedDocuments.ts";
-import * as $$$4 from "./loaders/oauth/start.ts";
-import * as $$$5 from "./loaders/searchDocuments.ts";
+import * as $$$2 from "./loaders/listSharedDocuments.ts";
+import * as $$$3 from "./loaders/oauth/start.ts";
 
 const manifest = {
   "loaders": {
     "google-docs/loaders/getDocument.ts": $$$0,
     "google-docs/loaders/getDocumentMetadata.ts": $$$1,
-    "google-docs/loaders/listDocuments.ts": $$$2,
-    "google-docs/loaders/listSharedDocuments.ts": $$$3,
-    "google-docs/loaders/oauth/start.ts": $$$4,
-    "google-docs/loaders/searchDocuments.ts": $$$5,
+    "google-docs/loaders/listSharedDocuments.ts": $$$2,
+    "google-docs/loaders/oauth/start.ts": $$$3,
   },
   "actions": {
     "google-docs/actions/appendToDocument.ts": $$$$$$$$$0,
diff --git a/google-drive/actions/files/download.ts b/google-drive/actions/files/download.ts
new file mode 100644
index 000000000..8035058a0
--- /dev/null
+++ b/google-drive/actions/files/download.ts
@@ -0,0 +1,95 @@
+import type { AppContext } from "../../mod.ts";
+import {
+  COMMON_FIELDS,
+  ERROR_FAILED_TO_DOWNLOAD_FILE,
+  ERROR_INVALID_OUTPUT_FORMAT,
+  ERROR_MISSING_FILE_ID,
+  FIELDS,
+  WEB_CONTENT_LINK,
+} from "../../utils/constant.ts";
+import {
+  DownloadFileParams,
+  DownloadFileResult,
+  DriveFile,
+} from "../../utils/types.ts";
+
+export interface Props extends DownloadFileParams {}
+
+/**
+ * @title Download File
+ * @description Downloads a file from Google Drive in multiple formats: link, base64, or blob
+ */
+export default async function downloadFile(
+  props: Props,
+  _req: Request,
+  ctx: AppContext,
+): Promise<DownloadFileResult> {
+  const { fileId, outputFormat = "link" } = props;
+
+  if (!fileId) {
+    ctx.errorHandler.toHttpError(ERROR_MISSING_FILE_ID, ERROR_MISSING_FILE_ID);
+  }
+
+  if (!["link", "base64", "blob"].includes(outputFormat)) {
+    ctx.errorHandler.toHttpError(
+      ERROR_INVALID_OUTPUT_FORMAT,
+      `Invalid output format: ${outputFormat}. Must be one of: link, base64, blob`,
+    );
+  }
+
+  try {
+    // First, get file metadata
+    const metadataResponse = await ctx.client["GET /files/:fileId"]({
+      fileId,
+      [FIELDS]: `${COMMON_FIELDS},${WEB_CONTENT_LINK},size`,
+    });
+
+    const fileMetadata: DriveFile = await metadataResponse.json();
+
+    // If format is "link", just return the web content link
+    if (outputFormat === "link") {
+      return {
+        fileId,
+        fileName: fileMetadata.name,
+        mimeType: fileMetadata.mimeType,
+        size: fileMetadata.size,
+        format: "link",
+        content: fileMetadata.webContentLink || "",
+      };
+    }
+
+    // For base64 and blob, download the actual file content
+    const downloadResponse = await ctx.client["GET /files/:fileId/download"]({
+      fileId,
+      alt: "media",
+    });
+
+    const arrayBuffer = await downloadResponse.arrayBuffer();
+
+    let content: string | ArrayBuffer;
+
+    if (outputFormat === "base64") {
+      // Convert ArrayBuffer to base64
+      const bytes = new Uint8Array(arrayBuffer);
+      let binary = "";
+      for (let i = 0; i < bytes.byteLength; i++) {
+        binary += String.fromCharCode(bytes[i]);
+      }
+      content = btoa(binary);
+    } else {
+      // outputFormat === "blob", return as ArrayBuffer
+      content = arrayBuffer;
+    }
+
+    return {
+      fileId,
+      fileName: fileMetadata.name,
+      mimeType: fileMetadata.mimeType,
+      size: fileMetadata.size,
+      format: outputFormat,
+      content,
+    };
+  } catch (error) {
+    ctx.errorHandler.toHttpError(error, ERROR_FAILED_TO_DOWNLOAD_FILE);
+  }
+}
diff --git a/google-drive/manifest.gen.ts b/google-drive/manifest.gen.ts
index 018c308e7..931620903 100644
--- a/google-drive/manifest.gen.ts
+++ b/google-drive/manifest.gen.ts
@@ -6,9 +6,10 @@ import * as $$$$$$$$$0 from "./actions/docs/create.ts";
 import * as $$$$$$$$$1 from "./actions/files/copy.ts";
 import * as $$$$$$$$$2 from "./actions/files/create.ts";
 import * as $$$$$$$$$3 from "./actions/files/delete.ts";
-import * as $$$$$$$$$4 from "./actions/files/update.ts";
-import * as $$$$$$$$$5 from "./actions/oauth/callback.ts";
-import * as $$$$$$$$$6 from "./actions/slides/create.ts";
+import * as $$$$$$$$$4 from "./actions/files/download.ts";
+import * as $$$$$$$$$5 from "./actions/files/update.ts";
+import * as $$$$$$$$$6 from "./actions/oauth/callback.ts";
+import * as $$$$$$$$$7 from "./actions/slides/create.ts";
 import * as $$$0 from "./loaders/docs/get.ts";
 import * as $$$1 from "./loaders/docs/list.ts";
 import * as $$$2 from "./loaders/files/get.ts";
@@ -38,9 +39,10 @@ const manifest = {
     "google-drive/actions/files/copy.ts": $$$$$$$$$1,
     "google-drive/actions/files/create.ts": $$$$$$$$$2,
     "google-drive/actions/files/delete.ts": $$$$$$$$$3,
-    "google-drive/actions/files/update.ts": $$$$$$$$$4,
-    "google-drive/actions/oauth/callback.ts": $$$$$$$$$5,
-    "google-drive/actions/slides/create.ts": $$$$$$$$$6,
+    "google-drive/actions/files/download.ts": $$$$$$$$$4,
+    "google-drive/actions/files/update.ts": $$$$$$$$$5,
+    "google-drive/actions/oauth/callback.ts": $$$$$$$$$6,
+    "google-drive/actions/slides/create.ts": $$$$$$$$$7,
   },
   "name": "google-drive",
   "baseUrl": import.meta.url,
diff --git a/google-drive/mod.ts b/google-drive/mod.ts
index 2cc64bec0..1bd05f22b 100644
--- a/google-drive/mod.ts
+++ b/google-drive/mod.ts
@@ -6,10 +6,12 @@ import {
   API_URL,
   ERROR_FAILED_TO_CREATE_FILE,
   ERROR_FAILED_TO_DELETE_FILE,
+  ERROR_FAILED_TO_DOWNLOAD_FILE,
   ERROR_FAILED_TO_GET_FILE,
   ERROR_FAILED_TO_LIST_FILES,
   ERROR_FAILED_TO_UPDATE_FILE,
   ERROR_FILE_NOT_FOUND,
+  ERROR_INVALID_OUTPUT_FORMAT,
   ERROR_INVALID_PARAMETERS,
   ERROR_MISSING_FILE_ID,
   ERROR_MISSING_FILE_NAME,
@@ -124,8 +126,10 @@ export default function App(
       ERROR_FAILED_TO_CREATE_FILE,
       ERROR_FAILED_TO_UPDATE_FILE,
       ERROR_FAILED_TO_DELETE_FILE,
+      ERROR_FAILED_TO_DOWNLOAD_FILE,
       ERROR_FILE_NOT_FOUND,
       ERROR_INVALID_PARAMETERS,
+      ERROR_INVALID_OUTPUT_FORMAT,
       ERROR_MISSING_FILE_ID,
       ERROR_MISSING_FILE_NAME,
       ERROR_MISSING_MIME_TYPE,
diff --git a/google-drive/utils/client.ts b/google-drive/utils/client.ts
index ad6bda49b..06c695035 100644
--- a/google-drive/utils/client.ts
+++ b/google-drive/utils/client.ts
@@ -82,4 +82,11 @@ export interface Client {
       parents?: string[];
     };
   };
+  "GET /files/:fileId/download": {
+    response: ArrayBuffer;
+    searchParams: {
+      alt?: "media";
+      fields?: string;
+    };
+  };
 }
diff --git a/google-drive/utils/constant.ts b/google-drive/utils/constant.ts
index 42821bbfa..7a5a9365e 100644
--- a/google-drive/utils/constant.ts
+++ b/google-drive/utils/constant.ts
@@ -70,8 +70,10 @@ export const ERROR_FAILED_TO_GET_FILE = "Failed to get file";
 export const ERROR_FAILED_TO_CREATE_FILE = "Failed to create file";
 export const ERROR_FAILED_TO_UPDATE_FILE = "Failed to update file";
 export const ERROR_FAILED_TO_DELETE_FILE = "Failed to delete file";
+export const ERROR_FAILED_TO_DOWNLOAD_FILE = "Failed to download file";
 export const ERROR_FILE_NOT_FOUND = "File not found";
 export const ERROR_INVALID_PARAMETERS = "Invalid parameters";
+export const ERROR_INVALID_OUTPUT_FORMAT = "Invalid output format";
 export const ERROR_MISSING_FILE_ID = "Missing file ID";
 export const ERROR_MISSING_FILE_NAME = "Missing file name";
 export const ERROR_MISSING_MIME_TYPE = "Missing MIME type";
diff --git a/google-drive/utils/types.ts b/google-drive/utils/types.ts
index 21dd5da0d..8954f75a0 100644
--- a/google-drive/utils/types.ts
+++ b/google-drive/utils/types.ts
@@ -246,3 +246,17 @@ export interface SearchFilesParams {
    */
   includeItemsFromAllDrives?: boolean;
 }
+
+export interface DownloadFileParams {
+  fileId: string;
+  outputFormat?: "link" | "base64" | "blob";
+}
+
+export interface DownloadFileResult {
+  fileId: string;
+  fileName?: string;
+  mimeType?: string;
+  size?: string;
+  format: "link" | "base64" | "blob";
+  content: string | ArrayBuffer;
+}
diff --git a/hubspot/actions/crm/updateTicket.ts b/hubspot/actions/crm/updateTicket.ts
new file mode 100644
index 000000000..0214e17b7
--- /dev/null
+++ b/hubspot/actions/crm/updateTicket.ts
@@ -0,0 +1,54 @@
+import { logger } from "@deco/deco/o11y";
+import type { AppContext } from "../../mod.ts";
+import { HubSpotClient } from "../../utils/client.ts";
+import type { SimplePublicObject } from "../../utils/types.ts";
+
+export interface Props {
+  /**
+   * @title Ticket ID
+   * @description The unique ID of the ticket to update, or a unique property value if using idProperty
+   */
+  ticketId: string;
+
+  /**
+   * @title ID Property
+   * @description The name of a property whose values are unique for this object (optional)
+   */
+  idProperty?: string;
+
+  /**
+   * @title Ticket Properties
+   * @description Key-value pairs of ticket properties to update. Provided values will be overwritten. Pass empty string to clear a property.
+   */
+  properties: Record<string, string>;
+}
+
+/**
+ * @title Update Ticket
+ * @description Perform a partial update of a ticket in HubSpot CRM
+ */
+export default async function updateTicket(
+  props: Props,
+  _req: Request,
+  ctx: AppContext,
+): Promise<SimplePublicObject> {
+  const { ticketId, idProperty, properties } = props;
+
+  const client = new HubSpotClient(ctx);
+
+  try {
+    // Build endpoint with optional idProperty query param
+    let endpoint = `/crm/v3/objects/tickets/${ticketId}`;
+    if (idProperty) {
+      endpoint += `?idProperty=${encodeURIComponent(idProperty)}`;
+    }
+
+    const ticket = await client.patch<SimplePublicObject>(endpoint, {
+      properties,
+    });
+    return ticket;
+  } catch (error) {
+    logger.error(error);
+    throw new Error("Failed to update ticket");
+  }
+}
diff --git a/hubspot/loaders/conversations/getThread.ts b/hubspot/loaders/conversations/getThread.ts
index 88098b689..01876706c 100644
--- a/hubspot/loaders/conversations/getThread.ts
+++ b/hubspot/loaders/conversations/getThread.ts
@@ -7,6 +7,16 @@ export interface Props {
    * @description The ID of the conversation thread to retrieve
    */
   threadId: string;
+  /**
+   * @title Archived
+   * @description Whether to return archived threads
+   */
+  archived?: boolean;
+  /**
+   * @title Associations
+   * @description Object types to retrieve associated IDs for
+   */
+  association?: "TICKET";
 }
 
 export interface ThreadAssociations {
@@ -118,12 +128,16 @@ export default async function getThread(
   _req: Request,
   ctx: AppContext,
 ): Promise<Thread> {
-  const { threadId } = props;
+  const { threadId, association, archived } = props;
 
   const client = new HubSpotClient(ctx);
 
   const response = await client.get<Thread>(
     `/conversations/v3/conversations/threads/${threadId}`,
+    {
+      association,
+      archived,
+    },
   );
 
   return response;
diff --git a/hubspot/manifest.gen.ts b/hubspot/manifest.gen.ts
index 845791a5e..7c816132b 100644
--- a/hubspot/manifest.gen.ts
+++ b/hubspot/manifest.gen.ts
@@ -32,14 +32,15 @@ import * as $$$$$$$$$26 from "./actions/crm/deleteContact.ts";
 import * as $$$$$$$$$27 from "./actions/crm/updateContact.ts";
 import * as $$$$$$$$$28 from "./actions/crm/updateCustomObject.ts";
 import * as $$$$$$$$$29 from "./actions/crm/updateDeal.ts";
-import * as $$$$$$$$$30 from "./actions/events/sendCustomEvent.ts";
-import * as $$$$$$$$$31 from "./actions/files/uploadFile.ts";
-import * as $$$$$$$$$32 from "./actions/marketing/sendTransactionalEmail.ts";
-import * as $$$$$$$$$33 from "./actions/marketing/updateCommunicationPreferences.ts";
-import * as $$$$$$$$$34 from "./actions/oauth/refreshToken.ts";
-import * as $$$$$$$$$35 from "./actions/settings/createUser.ts";
-import * as $$$$$$$$$36 from "./actions/webhooks/createWebhook.ts";
-import * as $$$$$$$$$37 from "./actions/webhooks/deleteWebhook.ts";
+import * as $$$$$$$$$30 from "./actions/crm/updateTicket.ts";
+import * as $$$$$$$$$31 from "./actions/events/sendCustomEvent.ts";
+import * as $$$$$$$$$32 from "./actions/files/uploadFile.ts";
+import * as $$$$$$$$$33 from "./actions/marketing/sendTransactionalEmail.ts";
+import * as $$$$$$$$$34 from "./actions/marketing/updateCommunicationPreferences.ts";
+import * as $$$$$$$$$35 from "./actions/oauth/refreshToken.ts";
+import * as $$$$$$$$$36 from "./actions/settings/createUser.ts";
+import * as $$$$$$$$$37 from "./actions/webhooks/createWebhook.ts";
+import * as $$$$$$$$$38 from "./actions/webhooks/deleteWebhook.ts";
 import * as $$$0 from "./loaders/automation/getWorkflows.ts";
 import * as $$$1 from "./loaders/cms/getPages.ts";
 import * as $$$2 from "./loaders/conversations/getChannelAccounts.ts";
@@ -193,14 +194,15 @@ const manifest = {
     "hubspot/actions/crm/updateContact.ts": $$$$$$$$$27,
     "hubspot/actions/crm/updateCustomObject.ts": $$$$$$$$$28,
     "hubspot/actions/crm/updateDeal.ts": $$$$$$$$$29,
-    "hubspot/actions/events/sendCustomEvent.ts": $$$$$$$$$30,
-    "hubspot/actions/files/uploadFile.ts": $$$$$$$$$31,
-    "hubspot/actions/marketing/sendTransactionalEmail.ts": $$$$$$$$$32,
-    "hubspot/actions/marketing/updateCommunicationPreferences.ts": $$$$$$$$$33,
-    "hubspot/actions/oauth/refreshToken.ts": $$$$$$$$$34,
-    "hubspot/actions/settings/createUser.ts": $$$$$$$$$35,
-    "hubspot/actions/webhooks/createWebhook.ts": $$$$$$$$$36,
-    "hubspot/actions/webhooks/deleteWebhook.ts": $$$$$$$$$37,
+    "hubspot/actions/crm/updateTicket.ts": $$$$$$$$$30,
+    "hubspot/actions/events/sendCustomEvent.ts": $$$$$$$$$31,
+    "hubspot/actions/files/uploadFile.ts": $$$$$$$$$32,
+    "hubspot/actions/marketing/sendTransactionalEmail.ts": $$$$$$$$$33,
+    "hubspot/actions/marketing/updateCommunicationPreferences.ts": $$$$$$$$$34,
+    "hubspot/actions/oauth/refreshToken.ts": $$$$$$$$$35,
+    "hubspot/actions/settings/createUser.ts": $$$$$$$$$36,
+    "hubspot/actions/webhooks/createWebhook.ts": $$$$$$$$$37,
+    "hubspot/actions/webhooks/deleteWebhook.ts": $$$$$$$$$38,
   },
   "name": "hubspot",
   "baseUrl": import.meta.url,
diff --git a/hubspot/utils/client.ts b/hubspot/utils/client.ts
index 192faf418..f46ddeac6 100644
--- a/hubspot/utils/client.ts
+++ b/hubspot/utils/client.ts
@@ -34,7 +34,7 @@ export class HubSpotClient {
     const url = new URL(endpoint, api.baseUrl);
     if (searchParams) {
       Object.entries(searchParams).forEach(([key, value]) => {
-        if (value !== undefined && value !== null) {
+        if (value !== undefined && value !== null && value !== "") {
           url.searchParams.set(key, String(value));
         }
       });
diff --git a/linx-impulse/loaders/products/linxEngage.ts b/linx-impulse/loaders/products/linxEngage.ts
index 1575bacb1..7c3c7ad57 100644
--- a/linx-impulse/loaders/products/linxEngage.ts
+++ b/linx-impulse/loaders/products/linxEngage.ts
@@ -43,6 +43,11 @@ export interface Props {
    * @description Used to sync user data with linx impulse
    */
   user: Person | null;
+  /**
+   * @title Force Source
+   * @description Force the source of the request
+   */
+  forceSource?: "desktop" | "mobile";
 
   /**
    * @ignore
@@ -123,10 +128,16 @@ const loader = async (
     return null;
   }
 
-  const { resultsPerPage, allowRedirect, showOnlyAvailable, user } = props;
+  const {
+    resultsPerPage,
+    allowRedirect,
+    showOnlyAvailable,
+    user,
+    forceSource,
+  } = props;
   const { apiKey, salesChannel, api, cdn } = ctx;
   const deviceId = getDeviceIdFromBag(ctx);
-  const source = getSource(ctx);
+  const source = forceSource ?? getSource(ctx);
   const url = new URL(req.url);
 
   const origin = url.searchParams.get("origin") || undefined;
diff --git a/linx-impulse/loaders/products/productLists.ts b/linx-impulse/loaders/products/productLists.ts
index 1c7dfc10b..4f3d80da1 100644
--- a/linx-impulse/loaders/products/productLists.ts
+++ b/linx-impulse/loaders/products/productLists.ts
@@ -115,6 +115,11 @@ interface Props {
     | ProductPageProps
     | CategoryPageProps
     | SearchPageProps;
+  /**
+   * @title Force Source
+   * @description Force the source of the request
+   */
+  forceSource?: "desktop" | "mobile";
 }
 
 const generateParams = (
@@ -231,7 +236,7 @@ function toLinxImpulseShelf(
  * @title Linx Impulse - Shelves Loader
  */
 const loader = async (
-  { props }: Props,
+  { props, forceSource }: Props,
   req: Request,
   ctx: AppContext,
 ): Promise<LinxImpulseShelf[] | null> => {
@@ -242,7 +247,7 @@ const loader = async (
   const { showOnlyAvailable, userId: _userId, user } = props;
   const { chaordicApi, apiKey, salesChannel, origin, cdn } = ctx;
   const deviceId = getDeviceIdFromBag(ctx);
-  const source = getSource(ctx);
+  const source = forceSource ?? getSource(ctx);
 
   const url = new URL(req.url);
   const dummy = url.searchParams.get("dummy") || undefined;
diff --git a/linx-impulse/loaders/search/autocomplete.ts b/linx-impulse/loaders/search/autocomplete.ts
index 2512d94e3..ba18302d2 100644
--- a/linx-impulse/loaders/search/autocomplete.ts
+++ b/linx-impulse/loaders/search/autocomplete.ts
@@ -17,6 +17,11 @@ export interface Props {
    * @description Used to sync user data with linx impulse
    */
   user?: Person | null;
+  /**
+   * @title Force Source
+   * @description Force the source of the request
+   */
+  forceSource?: "desktop" | "mobile";
 
   /**
    * @ignore
@@ -34,7 +39,7 @@ const loaders = async (
   ctx: AppContext,
 ): Promise<Suggestion | null> => {
   const { api, apiKey, origin, cdn } = ctx;
-  const { query, count = 20, user, userId: _userId } = props;
+  const { query, count = 20, user, userId: _userId, forceSource } = props;
   const userId = _userId ?? user?.["@id"];
 
   if (!query) return null;
@@ -47,7 +52,7 @@ const loaders = async (
     resultsProducts: count,
     resultsQueries: count,
     salesChannel: ctx.salesChannel,
-    source: getSource(ctx),
+    source: forceSource ?? getSource(ctx),
     productFormat: "complete",
     userId,
   })
diff --git a/linx-impulse/loaders/search/popular.ts b/linx-impulse/loaders/search/popular.ts
index acc7da727..cf2bbc0f2 100644
--- a/linx-impulse/loaders/search/popular.ts
+++ b/linx-impulse/loaders/search/popular.ts
@@ -10,6 +10,11 @@ export interface Props {
    * @description Used to sync user data with linx impulse
    */
   user?: Person | null;
+  /**
+   * @title Force Source
+   * @description Force the source of the request
+   */
+  forceSource?: "desktop" | "mobile";
 
   /**
    * @ignore
@@ -27,7 +32,7 @@ const loaders = async (
   ctx: AppContext,
 ): Promise<Suggestion | null> => {
   const { api, apiKey, origin } = ctx;
-  const { user, userId: _userId } = props;
+  const { user, userId: _userId, forceSource } = props;
   const userId = _userId ?? user?.["@id"];
 
   const search = await api["GET /engage/search/v3/autocompletes/popular"]({
@@ -35,7 +40,7 @@ const loaders = async (
     origin,
     deviceId: getDeviceIdFromBag(ctx),
     salesChannel: ctx.salesChannel,
-    source: getSource(ctx),
+    source: forceSource ?? getSource(ctx),
     userId,
     // For some reason the API is returning onlyIds products, even when the productFormat is set to complete
     // If you are here to fix this, see the output of the API and check if the products are being returned
diff --git a/linx-impulse/loaders/search/products.ts b/linx-impulse/loaders/search/products.ts
index 60f0eb20e..37d7714ae 100644
--- a/linx-impulse/loaders/search/products.ts
+++ b/linx-impulse/loaders/search/products.ts
@@ -12,6 +12,11 @@ interface Props {
    */
   count?: number;
   categoryId?: string;
+  /**
+   * @title Force Source
+   * @description Force the source of the request
+   */
+  forceSource?: "desktop" | "mobile";
 }
 
 /**
@@ -24,7 +29,7 @@ const loaders = async (
   ctx: AppContext,
 ): Promise<Suggestion | null> => {
   const { api, apiKey, origin, cdn } = ctx;
-  const { query = "", count = 20, categoryId } = props;
+  const { query = "", count = 20, categoryId, forceSource } = props;
 
   const search = await api["GET /engage/search/v3/autocompletes/products"]({
     terms: query,
@@ -34,7 +39,7 @@ const loaders = async (
     origin,
     deviceId: getDeviceIdFromBag(ctx),
     salesChannel: ctx.salesChannel,
-    source: getSource(ctx),
+    source: forceSource ?? getSource(ctx),
     productFormat: "complete",
   })
     .then((res) => res.json())
diff --git a/vnda/loaders/productDetailsPage.ts b/vnda/loaders/productDetailsPage.ts
index 385cedef2..b0909179c 100644
--- a/vnda/loaders/productDetailsPage.ts
+++ b/vnda/loaders/productDetailsPage.ts
@@ -40,6 +40,7 @@ async function loader(
       const result = await api["GET /api/v2/products/:id"]({
         id,
         include_images: "true",
+        include_inventory_place: "true",
       }, STALE);
       return result.json();
     } catch (error) {
diff --git a/vnda/loaders/productListingPage.ts b/vnda/loaders/productListingPage.ts
index fd03219b8..a76fbb9f8 100644
--- a/vnda/loaders/productListingPage.ts
+++ b/vnda/loaders/productListingPage.ts
@@ -48,7 +48,10 @@ export interface Props {
    * @description number of products per page to display
    */
   count: number;
-
+  /**
+   * @title Sorting
+   */
+  sort?: Sort;
   /**
    * Slug for category pages
    */
@@ -99,7 +102,8 @@ const searchLoader = async (
   const { api } = ctx;
 
   const count = props.count ?? 12;
-  const sort = url.searchParams.get("sort") as Sort;
+  const sort = (url.searchParams.get("sort") as Sort) ?? props.sort ??
+    VNDA_SORT_OPTIONS[0].value;
   const page = Number(url.searchParams.get("page")) || 1;
 
   const isSearchPage = ctx.searchPagePath
@@ -295,7 +299,7 @@ export const cacheKey = (props: Props, req: Request, _ctx: AppContext) => {
 
   const params = new URLSearchParams([
     ["count", (props.count || url.searchParams.get("count") || 12).toString()],
-    ["sort", url.searchParams.get("sort") ?? ""],
+    ["sort", url.searchParams.get("sort") ?? props.sort ?? ""],
     ["type_tags", typeTags],
     ["tags", props?.tags?.join("\\") ?? ""],
     [
diff --git a/vnda/utils/client/client.ts b/vnda/utils/client/client.ts
index 85e8c2853..79a498af2 100644
--- a/vnda/utils/client/client.ts
+++ b/vnda/utils/client/client.ts
@@ -15,7 +15,7 @@ export interface API {
   /** @docs https://developers.vnda.com.br/reference/get-api-v2-products-id */
   "GET /api/v2/products/:id": {
     response: ProductGroup;
-    searchParams: { include_images: boolean };
+    searchParams: { include_images: boolean; include_inventory_place: boolean };
   };
 
   /** @docs https://developers.vnda.com.br/reference/get-api-v2-products-product_id-price */
diff --git a/vnda/utils/transform.ts b/vnda/utils/transform.ts
index 84133429f..c8182960a 100644
--- a/vnda/utils/transform.ts
+++ b/vnda/utils/transform.ts
@@ -16,6 +16,7 @@ import {
   ProductInstallment,
   ProductSearch,
   ProductVariant,
+  ProductVariantInventory,
   VariantProductSearch,
 } from "./openapi/vnda.openapi.gen.ts";
 import { getSegmentFromCookie, parse } from "./segment.ts";
@@ -246,6 +247,19 @@ const toPropertyValueCategoryTags = (
   });
 };
 
+const toPropertyValueInventory = (inventories?: ProductVariantInventory[]) => {
+  if (!inventories) return [];
+  return inventories.map((inventory) => {
+    return {
+      "@type": "PropertyValue",
+      name: inventory.name ?? inventory.place_name,
+      value: inventory.quantity.toString(),
+      description: inventory.slug,
+      valueReference: "INVENTORY",
+    } as PropertyValue;
+  });
+};
+
 // deno-lint-ignore no-explicit-any
 const isProductVariant = (p: any): p is VariantProductSearch =>
   typeof p.id === "number";
@@ -298,6 +312,7 @@ export const toProduct = (
 
   const productID = `${variant.sku}`;
   const productGroupID = `${product.id}`;
+  const inventories = variant.inventories as ProductVariantInventory[];
 
   const myTags = "tags" in product ? product.tags : [];
   const myCategoryTags = "category_tags" in product
@@ -315,6 +330,7 @@ export const toProduct = (
       ...toPropertyValue(variant),
       ...toPropertyValueTags(myTags),
       ...toPropertyValueCategoryTags(myCategoryTags),
+      ...toPropertyValueInventory(inventories),
     ],
     inProductGroupWithID: productGroupID,
     gtin: product.reference,
diff --git a/vtex/actions/masterdata/createDocument.ts b/vtex/actions/masterdata/createDocument.ts
index 6f8914ae7..1982d077f 100644
--- a/vtex/actions/masterdata/createDocument.ts
+++ b/vtex/actions/masterdata/createDocument.ts
@@ -5,6 +5,7 @@ import type { CreateNewDocument } from "../../utils/types.ts";
 export interface Props {
   data: Record<string, unknown>;
   acronym: string;
+  schema?: string;
   isPrivateEntity?: boolean;
 }
 
@@ -20,7 +21,7 @@ const action = async (
   /* no-explicit-any */
 ): Promise<CreateNewDocument> => {
   const { vcs, vcsDeprecated } = ctx;
-  const { data, acronym, isPrivateEntity } = props;
+  const { data, acronym, isPrivateEntity, schema } = props;
   const { cookie } = parseCookie(req.headers, ctx.account);
 
   const requestOptions = {
@@ -35,11 +36,11 @@ const action = async (
   const response =
     await (isPrivateEntity
       ? vcs[`POST /api/dataentities/:acronym/documents`](
-        { acronym },
+        schema ? { acronym, _schema: schema } : { acronym },
         requestOptions,
       )
       : vcsDeprecated[`POST /api/dataentities/:acronym/documents`](
-        { acronym },
+        schema ? { acronym, _schema: schema } : { acronym },
         requestOptions,
       ));
 
diff --git a/vtex/actions/masterdata/updateDocument.ts b/vtex/actions/masterdata/updateDocument.ts
index 6a8add491..78f3484f7 100644
--- a/vtex/actions/masterdata/updateDocument.ts
+++ b/vtex/actions/masterdata/updateDocument.ts
@@ -10,6 +10,7 @@ export interface Props {
   acronym: string;
   data: Record<string, unknown>;
   createIfNotExists?: boolean;
+  schema?: string;
 }
 
 /**
@@ -24,7 +25,7 @@ const action = async (
   ctx: AppContext,
 ): Promise<unknown | IdHrefDocumentID> => {
   const { vcs } = ctx;
-  const { id, data, acronym, createIfNotExists } = props;
+  const { id, data, acronym, createIfNotExists, schema } = props;
   const { cookie } = parseCookie(req.headers, ctx.account);
 
   const requestOptions = {
@@ -39,11 +40,11 @@ const action = async (
   const response =
     await (createIfNotExists
       ? vcs["PATCH /api/dataentities/:acronym/documents"](
-        { acronym },
+        schema ? { acronym, _schema: schema } : { acronym },
         requestOptions,
       )
       : vcs["PATCH /api/dataentities/:acronym/documents/:id"](
-        { acronym, id },
+        schema ? { acronym, id, _schema: schema } : { acronym, id },
         requestOptions,
       ));
 
diff --git a/vtex/loaders/cart.ts b/vtex/loaders/cart.ts
index 267444924..9018b7425 100644
--- a/vtex/loaders/cart.ts
+++ b/vtex/loaders/cart.ts
@@ -1,10 +1,19 @@
+import { logger } from "@deco/deco/o11y";
+import { getCookies } from "std/http/mod.ts";
+import { DEFAULT_EXPECTED_SECTIONS } from "../actions/cart/removeItemAttachment.ts";
 import { AppContext } from "../mod.ts";
 import { proxySetCookie } from "../utils/cookies.ts";
-import { hasDifferentMarketingData, parseCookie } from "../utils/orderForm.ts";
-import { getSegmentFromBag } from "../utils/segment.ts";
-import type { MarketingData, OrderForm } from "../utils/types.ts";
-import { DEFAULT_EXPECTED_SECTIONS } from "../actions/cart/removeItemAttachment.ts";
+import {
+  getCheckoutVtexCookie,
+  hasDifferentMarketingData,
+  parseCookie,
+} from "../utils/orderForm.ts";
+import {
+  getSegmentFromBag,
+  setOrderFormIdInBag as setCheckoutVtexCookieInBag,
+} from "../utils/segment.ts";
 import { forceHttpsOnAssets } from "../utils/transform.ts";
+import type { MarketingData, OrderForm } from "../utils/types.ts";
 
 interface Props {
   orderformId?: string;
@@ -12,6 +21,60 @@ interface Props {
   forceNewCart?: boolean;
 }
 
+const safeParseJwt = (cookie: string) => {
+  try {
+    return [JSON.parse(atob(cookie.split(".")[1])), null];
+  } catch (e) {
+    return [null, e];
+  }
+};
+
+const logMismatchedCart = (cart: OrderForm, req: Request, ctx: AppContext) => {
+  const email = cart?.clientProfileData?.email;
+  const cookies = getCookies(req.headers);
+
+  const userFromCookie = cookies[`VtexIdclientAutCookie_${ctx.account}`];
+
+  const [jwtPayload, _error] = userFromCookie
+    ? safeParseJwt(userFromCookie)
+    : [null, null];
+
+  const emailFromCookie = jwtPayload?.sub;
+  const userIdFromCookie = jwtPayload?.userId;
+
+  const orderFormIdFromRequest = cookies["checkout.vtex.com"]?.split("=").at(1);
+
+  if (
+    userFromCookie &&
+    typeof emailFromCookie === "string" &&
+    typeof email === "string" &&
+    emailFromCookie !== email
+  ) {
+    const headersDenyList = new Set(["cookie", "cache-control"]);
+
+    const hasTwoCookies =
+      req.headers.get("cookie")?.split("checkout.vtex.com")?.length === 3;
+
+    logger.warn(`Cookie cart mismatch`, {
+      hasTwoCookies,
+      OrderFormId: cart?.orderFormId,
+      OrderFormIdFromRequest: orderFormIdFromRequest,
+      EmailFromCookie: emailFromCookie,
+      EmailFromOrderForm: email,
+      UserIdFromCookie: userIdFromCookie,
+      UserIdFromOrderForm: cart?.userProfileId,
+      reqUrl: req.url,
+      reqHeaders: Object.fromEntries(
+        Array.from(req.headers.entries()).filter(([key]) =>
+          !headersDenyList.has(key)
+        ),
+      ),
+    });
+  }
+};
+
+export const cache = "no-store";
+
 /**
  * @docs https://developers.vtex.com/docs/api-reference/checkout-api#get-/api/checkout/pub/orderForm
  * @title Get Cart
@@ -28,12 +91,25 @@ const loader = async (
   });
   const segment = getSegmentFromBag(ctx);
 
-  const response = await vcsDeprecated["POST /api/checkout/pub/orderForm"](
-    { sc: segment?.payload?.channel, forceNewCart: props.forceNewCart || false },
+  const responsePromise = vcsDeprecated["POST /api/checkout/pub/orderForm"](
+    {
+      sc: segment?.payload?.channel,
+      forceNewCart: props.forceNewCart || false,
+    },
     { headers: { cookie } },
   );
 
-  const result = response.json();
+  setCheckoutVtexCookieInBag(
+    ctx,
+    responsePromise.then((response) => getCheckoutVtexCookie(response.headers)),
+  );
+
+  const response = await responsePromise;
+
+  const cart = await response.json() as OrderForm;
+
+  // Temporary logging to check for cart mismatch
+  logMismatchedCart(cart, req, ctx);
 
   if (!props.ignoreSetCookie) {
     proxySetCookie(response.headers, ctx.response.headers, req.url);
@@ -42,7 +118,7 @@ const loader = async (
   }
 
   if (!segment?.payload) {
-    return forceHttpsOnAssets((await result) as OrderForm);
+    return forceHttpsOnAssets(cart);
   }
 
   const {
@@ -56,7 +132,6 @@ const loader = async (
     },
   } = segment;
 
-  const cart = await result;
   const hasUtm = utm_campaign || utm_source || utm_medium || utmi_campaign ||
     utmi_page || utmi_part;
 
@@ -97,7 +172,7 @@ const loader = async (
     }
   }
 
-  return forceHttpsOnAssets((await result) as OrderForm);
+  return forceHttpsOnAssets(cart);
 };
 
 export default loader;
diff --git a/vtex/loaders/intelligentSearch/productDetailsPage.ts b/vtex/loaders/intelligentSearch/productDetailsPage.ts
index d60e39792..8b519e1b7 100644
--- a/vtex/loaders/intelligentSearch/productDetailsPage.ts
+++ b/vtex/loaders/intelligentSearch/productDetailsPage.ts
@@ -15,6 +15,7 @@ import type {
   AdvancedLoaderConfig,
   PageType,
   Product as VTEXProduct,
+  SimulationBehavior,
 } from "../../utils/types.ts";
 import PDPDefaultPath from "../paths/PDPDefaultPath.ts";
 
@@ -35,6 +36,11 @@ export interface Props {
    * @description Further change loader behaviour
    */
   advancedConfigs?: AdvancedLoaderConfig;
+  /**
+   * @title Simulation Behavior
+   * @description Defines the simulation behavior.
+   */
+  simulationBehavior?: SimulationBehavior;
 }
 
 /**
@@ -101,8 +107,12 @@ const loader = async (
   }
 
   const facets = withDefaultFacets([], ctx);
-  const params = withDefaultParams({ query, count: 1, locale });
-
+  const params = withDefaultParams({
+    query,
+    count: 1,
+    locale,
+    simulationBehavior: props.simulationBehavior ?? "default",
+  });
   const { products: [product] } = await vcsDeprecated
     ["GET /api/io/_v/api/intelligent-search/product_search/*facets"]({
       ...params,
@@ -122,6 +132,7 @@ const loader = async (
     const params = withDefaultParams({
       query: `sku:${sku.kitItems.join(";")}`,
       count: sku.kitItems.length,
+      simulationBehavior: props.simulationBehavior ?? "default",
     });
 
     const result = await vcsDeprecated
diff --git a/vtex/loaders/intelligentSearch/productListingPage.ts b/vtex/loaders/intelligentSearch/productListingPage.ts
index 5e5551ca3..ffb627b89 100644
--- a/vtex/loaders/intelligentSearch/productListingPage.ts
+++ b/vtex/loaders/intelligentSearch/productListingPage.ts
@@ -69,17 +69,6 @@ const LEGACY_TO_IS: Record<string, Sort> = {
   OrderByBestDiscountDESC: "discount:desc",
 };
 
-const sortValues = [
-  "price:desc",
-  "price:asc",
-  "orders:desc",
-  "name:desc",
-  "name:asc",
-  "release:desc",
-  "discount:desc",
-  "relevance:desc",
-];
-
 export const mapLabelledFuzzyToFuzzy = (
   labelledFuzzy?: LabelledFuzzy,
 ): Fuzzy | undefined => {
@@ -194,13 +183,12 @@ const searchArgsOf = (props: Props, url: URL, ctx: AppContext) => {
         : 0,
       VTEX_MAX_PAGES - currentPageoffset,
     );
-  let sort = (url.searchParams.get("sort") as Sort) ??
+  const sort = (url.searchParams.get("sort")) ??
     LEGACY_TO_IS[url.searchParams.get("O") ?? ""] ??
     props.sort ??
     sortOptions[0].value;
-  if (!sort || !sortValues.includes(sort)) {
-    sort = sortOptions[0].value as Sort;
-  }
+
+  const isSortValid = sortOptions.some((option) => option.value === sort);
   const selectedFacets = mergeFacets(
     props.selectedFacets ?? [],
     filtersFromURL(url),
@@ -213,7 +201,7 @@ const searchArgsOf = (props: Props, url: URL, ctx: AppContext) => {
     query,
     fuzzy,
     page,
-    sort,
+    sort: isSortValid ? (sort as Sort) : sortOptions[0].value as Sort,
     count,
     hideUnavailableItems,
     selectedFacets,
diff --git a/vtex/loaders/legacy/productListingPage.ts b/vtex/loaders/legacy/productListingPage.ts
index fe90c51f6..d7c23a0c6 100644
--- a/vtex/loaders/legacy/productListingPage.ts
+++ b/vtex/loaders/legacy/productListingPage.ts
@@ -457,16 +457,18 @@ export const cacheKey = (props: Props, req: Request, ctx: AppContext) => {
     ]),
   ].sort();
   const segment = getSegmentFromBag(ctx)?.token ?? "";
+  const sort = (url.searchParams.get("O") as LegacySort) ??
+    IS_TO_LEGACY[url.searchParams.get("sort") ?? ""] ??
+    url.searchParams.get("sort") ??
+    props.sort ?? "";
+  const isSortValid = sortOptions.some((option) => option.value === sort);
   const params = new URLSearchParams([
     ["term", props.term ?? url.pathname ?? ""],
     ["count", (props.count || url.searchParams.get("count") || 12).toString()],
     ["page", (props.page ?? url.searchParams.get("page") ?? 1).toString()],
     [
       "sort",
-      (url.searchParams.get("O") as LegacySort) ??
-        IS_TO_LEGACY[url.searchParams.get("sort") ?? ""] ??
-        url.searchParams.get("sort") ??
-        props.sort ?? "",
+      isSortValid ? sort : sortOptions[0].value,
     ],
     ["filters", props.filters ?? ""],
     ["fq", fq.join(",") ?? ""],
diff --git a/vtex/loaders/logistics/listPickupPointsByLocation.ts b/vtex/loaders/logistics/listPickupPointsByLocation.ts
index 09fff0907..7d7379fe3 100644
--- a/vtex/loaders/logistics/listPickupPointsByLocation.ts
+++ b/vtex/loaders/logistics/listPickupPointsByLocation.ts
@@ -30,11 +30,15 @@ export default async function loader(
   const { geoCoordinates, postalCode, countryCode } = props;
   const { vcs } = ctx;
 
-  const _props = geoCoordinates
+  const _props: { geoCoordinates: number[] } | {
+    postalCode: string;
+    countryCode: string;
+  } = geoCoordinates
     ? { geoCoordinates }
-    : { postalCode, countryCode };
+    : { postalCode: postalCode!, countryCode: countryCode! };
 
   const pickupPoints = await vcs
+    // @ts-expect-error - the api is not well-typed
     ["GET /api/checkout/pub/pickup-points"](_props)
     .then((r) => r.json()) as {
       paging: { page: number; pageSize: number; total: number; pages: number };
diff --git a/vtex/loaders/masterdata/searchDocuments.ts b/vtex/loaders/masterdata/searchDocuments.ts
index 1dbfdc999..4956a50fa 100644
--- a/vtex/loaders/masterdata/searchDocuments.ts
+++ b/vtex/loaders/masterdata/searchDocuments.ts
@@ -16,6 +16,10 @@ interface Props {
    * @description Specification of filters.
    */
   where?: string;
+  /**
+   * @description Schema of the data entity.
+   */
+  schema?: string;
   /**
    * @description Inform a field name plus ASC to sort results by this field value in ascending order or DESC to sort by descending order.
    */
@@ -47,7 +51,7 @@ export default async function loader(
   ctx: AppContext,
 ): Promise<Document[]> {
   const { vcs } = ctx;
-  const { acronym, fields, where, sort, skip = 0, take = 10 } = props;
+  const { acronym, fields, where, sort, skip = 0, take = 10, schema } = props;
   const { cookie } = parseCookie(req.headers, ctx.account);
   const limits = resourceRange(skip, take);
 
@@ -56,6 +60,7 @@ export default async function loader(
     _fields: fields,
     _where: where,
     _sort: sort,
+    _schema: schema,
   }, {
     headers: {
       accept: "application/vnd.vtex.ds.v10+json",
diff --git a/vtex/utils/client.ts b/vtex/utils/client.ts
index 0047c0c84..e3de28007 100644
--- a/vtex/utils/client.ts
+++ b/vtex/utils/client.ts
@@ -288,6 +288,9 @@ export interface VTEXCommerceStable {
       };
     };
   "POST /api/dataentities/:acronym/documents": {
+    searchParams: {
+      _schema?: string;
+    };
     response: CreateNewDocument;
     body: Record<string, unknown>;
   };
diff --git a/vtex/utils/intelligentSearch.ts b/vtex/utils/intelligentSearch.ts
index a385e7bfa..8c24425a5 100644
--- a/vtex/utils/intelligentSearch.ts
+++ b/vtex/utils/intelligentSearch.ts
@@ -60,7 +60,7 @@ export const withDefaultParams = ({
   page = 0,
   count = 12,
   sort = "",
-  fuzzy = "auto",
+  fuzzy = "",
   locale = "pt-BR",
   hideUnavailableItems,
   simulationBehavior = "default",
@@ -71,7 +71,7 @@ export const withDefaultParams = ({
   count,
   query,
   sort,
-  fuzzy,
+  ...(fuzzy ? { fuzzy } : {}),
   locale,
   // locale: locale ?? ctx.configVTEX!.defaultLocale,
   hideUnavailableItems: hideUnavailableItems ?? false,
diff --git a/vtex/utils/openapi/checkout.openapi.gen.ts b/vtex/utils/openapi/checkout.openapi.gen.ts
index 1741a6805..d8cc3e445 100644
--- a/vtex/utils/openapi/checkout.openapi.gen.ts
+++ b/vtex/utils/openapi/checkout.openapi.gen.ts
@@ -23,26 +23,27 @@ export type OptinNewsLetter = (null | boolean)
 
 export interface OpenAPI {
 /**
- * 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 seller ID.
- * 
- * It returns all information about the cart, such as the selling price of each item, pricing and promotion data, payment and logistics info.
- * 
- * This request 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.
- * 
- * >⚠️ 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.
- * 
- * ## Permissions
- * 
+ * 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 seller ID.
+ * 
+ * It returns all information about the cart, such as the selling price of each item, pricing and promotion data, payment and logistics info.
+ * 
+ * This request 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.
+ * 
+ * >⚠️ 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.
+ * 
+ * ## Permissions
+ * 
  * This endpoint does not require [authentication](https://developers.vtex.com/docs/guides/authentication) or [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).
  */
 "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
 /**
@@ -196,10 +197,10 @@ identifier?: (null | string)
  */
 isPercentual?: boolean
 /**
- * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
- * - `type` indicates whether the tag refers to a discount or tax.
- * - `where` specifies the context, either price or shipping.
- * - `identifier` is the promotion ID.
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
  * - `calculationId` is a hash that may vary with each price calculation.
  */
 name?: string
@@ -961,24 +962,25 @@ assemblyOptions?: string[]
 }
 }
 /**
- * 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.
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Read Shopping Cart** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 
+ * 
+> This request has a time out of 45 seconds.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "GET /api/checkout/pub/orderForm": {
@@ -1298,10 +1300,10 @@ identifier?: (null | string)
  */
 isPercentual?: boolean
 /**
- * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
- * - `type` indicates whether the tag refers to a discount or tax.
- * - `where` specifies the context, either price or shipping.
- * - `identifier` is the promotion ID.
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
  * - `calculationId` is a hash that may vary with each price calculation.
  */
 name?: string
@@ -2149,22 +2151,23 @@ ascending?: boolean
 }
 }
 /**
- * Retrieves all information associated to a given shopping  cart.
- * 
+ * Retrieves 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.
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | Checkout | **Read Shopping Cart** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 
+ * 
+> This request has a time out of 45 seconds.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | Checkout | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "GET /api/checkout/pub/orderForm/:orderFormId": {
@@ -2484,10 +2487,10 @@ identifier?: (null | string)
  */
 isPercentual?: boolean
 /**
- * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
- * - `type` indicates whether the tag refers to a discount or tax.
- * - `where` specifies the context, either price or shipping.
- * - `identifier` is the promotion ID.
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
  * - `calculationId` is a hash that may vary with each price calculation.
  */
 name?: string
@@ -3335,24 +3338,24 @@ ascending?: 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.
- * 
- * >ℹ️ Request body must always be sent with empty value "{ }" in this endpoint.
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Shopping Cart Full Access** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 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.
+ * 
+ * >ℹ️ Request body must always be sent with empty value "{ }" in this endpoint.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Shopping Cart Full Access** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "POST /api/checkout/pub/orderForm/:orderFormId/items/removeAll": {
@@ -3674,10 +3677,10 @@ identifier?: (null | string)
  */
 isPercentual?: boolean
 /**
- * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
- * - `type` indicates whether the tag refers to a discount or tax.
- * - `where` specifies the context, either price or shipping.
- * - `identifier` is the promotion ID.
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
  * - `calculationId` is a hash that may vary with each price calculation.
  */
 name?: string
@@ -4525,22 +4528,22 @@ ascending?: boolean
 }
 }
 /**
- * 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`).
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Save OrderForm Configuration** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 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`).
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Save OrderForm Configuration** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "GET /checkout/changeToAnonymousUser/:orderFormId": {
@@ -4553,34 +4556,38 @@ individualShippingEstimates?: boolean
 }
 /**
  * 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).
- * 
- * >ℹ️ To remove all items from the cart at the same time, use the [Remove all items](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pub/orderForm/-orderFormId-/items/removeAll?endpoint=post-/api/checkout/pub/orderForm/-orderFormId-/items/removeAll) 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).
+ * 
+ * >ℹ️ To remove all items from the cart at the same time, use the [Remove all items](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pub/orderForm/-orderFormId-/items/removeAll?endpoint=post-/api/checkout/pub/orderForm/-orderFormId-/items/removeAll) 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.
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Read Shopping Cart** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 
+ * 
+> This request has a time out of 45 seconds.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "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?: string[]
 /**
@@ -4909,10 +4916,10 @@ identifier?: (null | string)
  */
 isPercentual?: boolean
 /**
- * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
- * - `type` indicates whether the tag refers to a discount or tax.
- * - `where` specifies the context, either price or shipping.
- * - `identifier` is the promotion ID.
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
  * - `calculationId` is a hash that may vary with each price calculation.
  */
 name?: string
@@ -5760,30 +5767,32 @@ 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.
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Read Shopping Cart** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 
+ * 
+> This request has a time out of 45 seconds.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "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?: string[]
 /**
@@ -6124,10 +6133,10 @@ identifier?: (null | string)
  */
 isPercentual?: boolean
 /**
- * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
- * - `type` indicates whether the tag refers to a discount or tax.
- * - `where` specifies the context, either price or shipping.
- * - `identifier` is the promotion ID.
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
  * - `calculationId` is a hash that may vary with each price calculation.
  */
 name?: string
@@ -6976,26 +6985,29 @@ 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.
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Read Shopping Cart** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 
+ * 
+> This request has a time out of 45 seconds.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "PATCH /api/checkout/pub/orderForm/:orderFormId/items": {
@@ -7364,10 +7376,10 @@ identifier?: (null | string)
  */
 isPercentual?: boolean
 /**
- * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
- * - `type` indicates whether the tag refers to a discount or tax.
- * - `where` specifies the context, either price or shipping.
- * - `identifier` is the promotion ID.
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
  * - `calculationId` is a hash that may vary with each price calculation.
  */
 name?: string
@@ -8215,28 +8227,32 @@ 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.
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Read Shopping Cart** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 
+ * 
+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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "PUT /api/checkout/pub/orderForm/:orderFormId/items/:itemIndex/price": {
@@ -8558,10 +8574,10 @@ identifier?: (null | string)
  */
 isPercentual?: boolean
 /**
- * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
- * - `type` indicates whether the tag refers to a discount or tax.
- * - `where` specifies the context, either price or shipping.
- * - `identifier` is the promotion ID.
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
  * - `calculationId` is a hash that may vary with each price calculation.
  */
 name?: string
@@ -9409,22 +9425,22 @@ ascending?: boolean
 }
 }
 /**
- * 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 automatically.
- * 
- * 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.
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Read Shopping Cart** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 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 automatically.
+ * 
+ * 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "PATCH /api/checkout/pub/orderForm/:orderFormId/profile": {
@@ -9746,10 +9762,10 @@ identifier?: (null | string)
  */
 isPercentual?: boolean
 /**
- * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
- * - `type` indicates whether the tag refers to a discount or tax.
- * - `where` specifies the context, either price or shipping.
- * - `identifier` is the promotion ID.
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
  * - `calculationId` is a hash that may vary with each price calculation.
  */
 name?: string
@@ -10598,30 +10614,33 @@ ascending?: boolean
 }
 /**
  * Retrieves 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).
- * 
- * >⚠️ 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.
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Shopping Cart Full Access** |
- * 
- * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
- * 
- * | **Role** | **Resource** | 
- * | --------------- | ----------------- | 
- * | Checkout Admin | Shopping Cart Full Access |
- * 
- * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).
- * 
+ * 
+ * 
+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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Shopping Cart Full Access** |
+ * 
+ * You can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):
+ * 
+ * | **Role** | **Resource** | 
+ * | --------------- | ----------------- | 
+ * | Checkout Admin | Shopping Cart Full Access |
+ * 
+ * >❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm).
+ * 
  * To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
  */
 "GET /api/checkout/pub/profiles": {
@@ -10781,24 +10800,25 @@ 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.
- * 
- * >⚠️ 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.
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Read Shopping Cart** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 
+ * 
+> 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "POST /api/checkout/pub/orderForm/:orderFormId/attachments/clientProfileData": {
@@ -11167,10 +11187,10 @@ identifier?: (null | string)
  */
 isPercentual?: boolean
 /**
- * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
- * - `type` indicates whether the tag refers to a discount or tax.
- * - `where` specifies the context, either price or shipping.
- * - `identifier` is the promotion ID.
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
  * - `calculationId` is a hash that may vary with each price calculation.
  */
 name?: string
@@ -12018,26 +12038,27 @@ ascending?: 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.
- * 
- * >⚠️ 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.
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Read Shopping Cart** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 
+ * 
+> 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "POST /api/checkout/pub/orderForm/:orderFormId/attachments/shippingData": {
@@ -12433,10 +12454,10 @@ identifier?: (null | string)
  */
 isPercentual?: boolean
 /**
- * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
- * - `type` indicates whether the tag refers to a discount or tax.
- * - `where` specifies the context, either price or shipping.
- * - `identifier` is the promotion ID.
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
  * - `calculationId` is a hash that may vary with each price calculation.
  */
 name?: string
@@ -13284,22 +13305,23 @@ ascending?: boolean
 }
 }
 /**
- * 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.
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Read Shopping Cart** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 
+ * 
+> This request has a time out of 12 seconds.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "POST /api/checkout/pub/orderForm/:orderFormId/attachments/clientPreferencesData": {
@@ -13625,10 +13647,10 @@ identifier?: (null | string)
  */
 isPercentual?: boolean
 /**
- * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
- * - `type` indicates whether the tag refers to a discount or tax.
- * - `where` specifies the context, either price or shipping.
- * - `identifier` is the promotion ID.
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
  * - `calculationId` is a hash that may vary with each price calculation.
  */
 name?: string
@@ -14476,22 +14498,23 @@ ascending?: boolean
 }
 }
 /**
- * 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.
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Read Shopping Cart** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 
+ * 
+> This request has a time out of 12 seconds.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "POST /api/checkout/pub/orderForm/:orderFormId/attachments/marketingData": {
@@ -14504,8 +14527,9 @@ individualShippingEstimates?: boolean
 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
 /**
@@ -14843,10 +14867,10 @@ identifier?: (null | string)
  */
 isPercentual?: boolean
 /**
- * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
- * - `type` indicates whether the tag refers to a discount or tax.
- * - `where` specifies the context, either price or shipping.
- * - `identifier` is the promotion ID.
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
  * - `calculationId` is a hash that may vary with each price calculation.
  */
 name?: string
@@ -15694,22 +15718,23 @@ ascending?: boolean
 }
 }
 /**
- * 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.
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Read Shopping Cart** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 
+ * 
+> This request has a time out of 12 seconds.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "POST /api/checkout/pub/orderForm/:orderFormId/attachments/paymentData": {
@@ -16068,10 +16093,10 @@ identifier?: (null | string)
  */
 isPercentual?: boolean
 /**
- * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
- * - `type` indicates whether the tag refers to a discount or tax.
- * - `where` specifies the context, either price or shipping.
- * - `identifier` is the promotion ID.
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
  * - `calculationId` is a hash that may vary with each price calculation.
  */
 name?: string
@@ -16919,22 +16944,23 @@ ascending?: 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.
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Read Shopping Cart** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 
+ * 
+> This request has a time out of 12 seconds.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "POST /api/checkout/pub/orderForm/:orderFormId/attachments/merchantContextData": {
@@ -16963,22 +16989,23 @@ salesAssociateId?: string
 }
 }
 /**
- * Attaches invoice data to the cart.
- * 
+ * Attaches invoice data to the 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.
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Read Shopping Cart** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 
+ * 
+> This request has a time out of 12 seconds.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "POST /api/checkout/pub/orderForm/:orderFormId/attachments/invoiceData": {
@@ -17336,10 +17363,10 @@ identifier?: (null | string)
  */
 isPercentual?: boolean
 /**
- * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
- * - `type` indicates whether the tag refers to a discount or tax.
- * - `where` specifies the context, either price or shipping.
- * - `identifier` is the promotion ID.
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
  * - `calculationId` is a hash that may vary with each price calculation.
  */
 name?: string
@@ -18188,23 +18215,25 @@ ascending?: boolean
 }
 /**
  * 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`).
- * 
- * 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.
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Read Shopping Cart** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 
+ * 
+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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "PUT /api/checkout/pub/orderForm/:orderFormId/customData/:appId": {
@@ -18526,10 +18555,10 @@ identifier?: (null | string)
  */
 isPercentual?: boolean
 /**
- * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
- * - `type` indicates whether the tag refers to a discount or tax.
- * - `where` specifies the context, either price or shipping.
- * - `identifier` is the promotion ID.
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
  * - `calculationId` is a hash that may vary with each price calculation.
  */
 name?: string
@@ -19378,23 +19407,25 @@ ascending?: boolean
 }
 /**
  * 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).
- * 
- * 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.
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Read Shopping Cart** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 
+ * 
+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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "PUT /api/checkout/pub/orderForm/:orderFormId/customData/:appId/:appFieldName": {
@@ -19716,10 +19747,10 @@ identifier?: (null | string)
  */
 isPercentual?: boolean
 /**
- * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
- * - `type` indicates whether the tag refers to a discount or tax.
- * - `where` specifies the context, either price or shipping.
- * - `identifier` is the promotion ID.
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
  * - `calculationId` is a hash that may vary with each price calculation.
  */
 name?: string
@@ -20568,21 +20599,23 @@ ascending?: boolean
 }
 /**
  * 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.
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Read Shopping Cart** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 
+ * 
+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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "DELETE /api/checkout/pub/orderForm/:orderFormId/customData/:appId/:appFieldName": {
@@ -20898,10 +20931,10 @@ identifier?: (null | string)
  */
 isPercentual?: boolean
 /**
- * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
- * - `type` indicates whether the tag refers to a discount or tax.
- * - `where` specifies the context, either price or shipping.
- * - `identifier` is the promotion ID.
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
  * - `calculationId` is a hash that may vary with each price calculation.
  */
 name?: string
@@ -21750,21 +21783,23 @@ ascending?: boolean
 }
 /**
  * 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.
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Save OrderForm Configuration** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 
+ * 
+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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Save OrderForm Configuration** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "GET /api/checkout/pvt/configuration/orderForm": {
@@ -21860,32 +21895,38 @@ 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
 }
 }
 /**
  * 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).
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Save OrderForm Configuration** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 
+ * 
+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).
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Save OrderForm Configuration** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "POST /api/checkout/pvt/configuration/orderForm": {
@@ -21970,13 +22011,13 @@ maskFirstPurchaseData?: boolean
  */
 maskStateOnAddress?: 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.
- * - `null`: no purchases are validated with reCAPTCHA. The same as `never`.
- * - `"always"`: every purchase is validated with reCAPTCHA.
+ * 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.
+ * - `null`: no purchases are validated with reCAPTCHA. The same as `never`.
+ * - `"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?: (null | string)
@@ -21988,19 +22029,20 @@ paymentSystemToCheckFirstInstallment?: string
 }
 /**
  * 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.
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Save OrderForm Configuration** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 
+ * 
+> The default period for this window is of 2 days, but it can be configured by the request Update window to change seller.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Save OrderForm Configuration** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "GET /api/checkout/pvt/configuration/window-to-change-seller": {
@@ -22013,19 +22055,20 @@ individualShippingEstimates?: boolean
 }
 /**
  * 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.
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Save OrderForm Configuration** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 
+ * 
+> It is possible to check the current window using the request Get window to change seller.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Save OrderForm Configuration** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "POST /api/checkout/pvt/configuration/window-to-change-seller": {
@@ -22046,24 +22089,24 @@ waitingTime: number
 }
 }
 /**
- * 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.
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Read Shopping Cart** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "POST /api/checkout/pub/orderForm/:orderFormId/messages/clear": {
@@ -22381,10 +22424,10 @@ identifier?: (null | string)
  */
 isPercentual?: boolean
 /**
- * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
- * - `type` indicates whether the tag refers to a discount or tax.
- * - `where` specifies the context, either price or shipping.
- * - `identifier` is the promotion ID.
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
  * - `calculationId` is a hash that may vary with each price calculation.
  */
 name?: string
@@ -23188,24 +23231,26 @@ 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`.
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Read Shopping Cart** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 
+ * 
+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`.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "GET /api/checkout/pub/orderForm/:orderFormId/installments": {
@@ -23298,24 +23343,27 @@ paymentGroupName?: (null | string)
 }
 /**
  * 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"}.
- * 
- * For more information on multiple coupons, access the [coupons tutorial](https://help.vtex.com/en/tutorial/creating-a-coupon-beta--7lMk3MmhNp2IEccyGApxU).
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Read Shopping Cart** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 
+ * 
+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).
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "POST /api/checkout/pub/orderForm/:orderFormId/coupons": {
@@ -23633,10 +23681,10 @@ identifier?: (null | string)
  */
 isPercentual?: boolean
 /**
- * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
- * - `type` indicates whether the tag refers to a discount or tax.
- * - `where` specifies the context, either price or shipping.
- * - `identifier` is the promotion ID.
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
  * - `calculationId` is a hash that may vary with each price calculation.
  */
 name?: string
@@ -24466,11 +24514,12 @@ 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.
- * 
- * ## Permissions
- * 
+ * 
+ * 
+The pickup points returned are not necessarily all active ones. Make sure to validate the information consumed by integrations.
+ * 
+ * ## Permissions
+ * 
  * This endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).
  */
 "GET /api/checkout/pub/pickup-points": {
@@ -24621,12 +24670,12 @@ ClosingTime?: string
 }
 }
 /**
- * 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.
- * 
- * ## Permissions
- * 
+ * 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.
+ * 
+ * ## Permissions
+ * 
  * This endpoint does not require [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).
  */
 "GET /api/checkout/pub/postal-code/:countryCode/:postalCode": {
@@ -24684,19 +24733,20 @@ geoCoordinates?: number[]
 }
 /**
  * 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.
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Read Shopping Cart** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 
+ * 
+After the creation of an order with this request, you have five minutes to send payment information and then request payment processing.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Read Shopping Cart** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "POST /api/checkout/pub/orderForm/:orderFormId/transaction": {
@@ -25029,10 +25079,10 @@ identifier?: (null | string)
  */
 isPercentual?: boolean
 /**
- * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
- * - `type` indicates whether the tag refers to a discount or tax.
- * - `where` specifies the context, either price or shipping.
- * - `identifier` is the promotion ID.
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
  * - `calculationId` is a hash that may vary with each price calculation.
  */
 name?: string
@@ -25880,20 +25930,20 @@ ascending?: boolean
 }
 }
 /**
- * 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).
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Orders Full Access** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 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).
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Orders Full Access** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "PUT /api/checkout/pub/orders": {
@@ -25987,10 +26037,10 @@ identifier?: (null | string)
  */
 isPercentual?: boolean
 /**
- * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
- * - `type` indicates whether the tag refers to a discount or tax.
- * - `where` specifies the context, either price or shipping.
- * - `identifier` is the promotion ID.
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
  * - `calculationId` is a hash that may vary with each price calculation.
  */
 name?: string
@@ -26018,10 +26068,12 @@ 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: (null | {
 /**
@@ -26079,8 +26131,9 @@ isCorporate?: boolean
 shippingData: (null | {
 /**
  * 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?: (null | {
 /**
@@ -26688,10 +26741,10 @@ identifier?: (null | string)
  */
 isPercentual?: boolean
 /**
- * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
- * - `type` indicates whether the tag refers to a discount or tax.
- * - `where` specifies the context, either price or shipping.
- * - `identifier` is the promotion ID.
+ * Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where:
+ * - `type` indicates whether the tag refers to a discount or tax.
+ * - `where` specifies the context, either price or shipping.
+ * - `identifier` is the promotion ID.
  * - `calculationId` is a hash that may vary with each price calculation.
  */
 name?: string
@@ -27448,19 +27501,20 @@ 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.
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Save Order Configuration** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 
+ * 
+> 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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Save Order Configuration** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "POST /api/checkout/pub/gatewayCallback/:orderGroup": {
@@ -27473,24 +27527,28 @@ individualShippingEstimates?: boolean
 }
 /**
  * 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.
- * 
- * ## Permissions
- * 
- * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
- * 
- * | **Product** | **Category** | **Resource** |
- * | --------------- | ----------------- | ----------------- |
- * | Checkout | CheckoutResources | **Shopping Cart Full Access** |
- * 
- * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
- * 
+ * 
+ * 
+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.
+ * 
+ * ## Permissions
+ * 
+ * Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:
+ * 
+ * | **Product** | **Category** | **Resource** |
+ * | --------------- | ----------------- | ----------------- |
+ * | Checkout | CheckoutResources | **Shopping Cart Full Access** |
+ * 
+ * There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).
+ * 
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "GET /api/checkout/pub/regions/:regionId": {
@@ -27546,7 +27604,7 @@ export interface PaymentConfiguration {
  */
 requiresAuthenticationForPreAuthorizedPaymentOption: boolean
 /**
- * By default (when `false`), on a multi-seller purchase is on the run, a simple intersection with installments options configured by every seller will be available. When `true`, this option allows a more complex but flexible installment option, since it considers max installments of every seller configuration, even if those don't match. Installment values ​​may not be equal in this case.
+ * By default (when `false`), on a multi-seller purchase is on the run, a simple intersection with installments options configured by every seller will be available. When `true`, this option allows a more complex but flexible installment option, since it considers max installments of every seller configuration, even if those don't match. Installment values may not be equal in this case.
  */
 allowInstallmentsMerge?: boolean
 /**
diff --git a/vtex/utils/openapi/vcs.openapi.gen.ts b/vtex/utils/openapi/vcs.openapi.gen.ts
index 951447922..cfef8069d 100644
--- a/vtex/utils/openapi/vcs.openapi.gen.ts
+++ b/vtex/utils/openapi/vcs.openapi.gen.ts
@@ -724,6 +724,10 @@ searchParams: {
  * Names of the fields that will be returned per document, separated by a comma `,`. It is possible to fetch all fields using `_all` as the value of this query parameter. However, in order to avoid permission errors, we strongly recommend informing only the names of the exact fields that will be used.
  */
 _fields?: string
+/**
+ * Name of the [schema](https://developers.vtex.com/docs/guides/master-data-schema-lifecycle) that the document complies with.  This field is required when using `_where` or `_fields` query parameters.
+ */
+_schema?: string
 /**
  * Specification of filters.
  */
@@ -849,6 +853,12 @@ to?: number
  * Create a new document
  */
 "POST /api/dataentities/:acronym/documents": {
+searchParams: {
+/**
+ * Name of the [schema](https://developers.vtex.com/docs/guides/master-data-schema-lifecycle) that the document complies with.  This field is required when using `_where` or `_fields` query parameters.
+ */
+_schema?: string
+}
 body: {
 anyProperty?: string
 }
@@ -878,6 +888,12 @@ DocumentId?: string
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "PATCH /api/dataentities/:acronym/documents": {
+searchParams: {
+/**
+ * Name of the [schema](https://developers.vtex.com/docs/guides/master-data-schema-lifecycle) that the document complies with.  This field is required when using `_where` or `_fields` query parameters.
+ */
+_schema?: string
+}
 body: {
 /**
  * Unique identifier of the document to be created.
@@ -915,6 +931,10 @@ searchParams: {
  * Names of the fields that will be returned per document, separated by a comma `,`. It is possible to fetch all fields using `_all` as the value of this query parameter. However, in order to avoid permission errors, we strongly recommend informing only the names of the exact fields that will be used.
  */
 _fields?: string
+/**
+ * Name of the [schema](https://developers.vtex.com/docs/guides/master-data-schema-lifecycle) that the document complies with.  This field is required when using `_where` or `_fields` query parameters.
+ */
+_schema?: string
 }
 response: Document
 }
@@ -963,6 +983,12 @@ response: Document
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "PUT /api/dataentities/:acronym/documents/:id": {
+searchParams: {
+/**
+ * Name of the [schema](https://developers.vtex.com/docs/guides/master-data-schema-lifecycle) that the document complies with.  This field is required when using `_where` or `_fields` query parameters.
+ */
+_schema?: string
+}
 /**
  * Object with document fields and their respective values.
  */
@@ -991,7 +1017,12 @@ body: {
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "DELETE /api/dataentities/:acronym/documents/:id": {
-
+searchParams: {
+/**
+ * Name of the [schema](https://developers.vtex.com/docs/guides/master-data-schema-lifecycle) that the document complies with.  This field is required when using `_where` or `_fields` query parameters.
+ */
+_schema?: string
+}
 }
 /**
  * Updates a subset of fields of a document, without impacting the other fields.
@@ -1013,6 +1044,12 @@ body: {
  * >❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.
  */
 "PATCH /api/dataentities/:acronym/documents/:id": {
+searchParams: {
+/**
+ * Name of the [schema](https://developers.vtex.com/docs/guides/master-data-schema-lifecycle) that the document complies with.  This field is required when using `_where` or `_fields` query parameters.
+ */
+_schema?: string
+}
 /**
  * Object with the fields to be updated and their respective values.
  */
diff --git a/vtex/utils/openapi/vcs.openapi.json b/vtex/utils/openapi/vcs.openapi.json
index a6e4c62c0..7c72d4ba6 100644
--- a/vtex/utils/openapi/vcs.openapi.json
+++ b/vtex/utils/openapi/vcs.openapi.json
@@ -971,6 +971,17 @@
               "example": "email,firstName,document"
             }
           },
+          {
+            "name": "_schema",
+            "in": "query",
+            "description": "Name of the [schema](https://developers.vtex.com/docs/guides/master-data-schema-lifecycle) that the document complies with.  This field is required when using `_where` or `_fields` query parameters.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "string",
+              "example": "schema"
+            }
+          },
           {
             "name": "_where",
             "in": "query",
@@ -1557,6 +1568,17 @@
             "schema": {
               "type": "string"
             }
+          },
+          {
+            "name": "_schema",
+            "in": "query",
+            "description": "Name of the [schema](https://developers.vtex.com/docs/guides/master-data-schema-lifecycle) that the document complies with.  This field is required when using `_where` or `_fields` query parameters.",
+            "required": false,
+            "style": "form",
+            "schema": {
+              "type": "string",
+              "example": "schema"
+            }
           }
         ],
         "requestBody": {
@@ -1614,6 +1636,9 @@
           },
           {
             "$ref": "#/components/parameters/acronym"
+          },
+          {
+            "$ref": "#/components/parameters/_schema"
           }
         ],
         "requestBody": {
@@ -1685,6 +1710,9 @@
           },
           {
             "$ref": "#/components/parameters/fields"
+          },
+          {
+            "$ref": "#/components/parameters/_schema"
           }
         ],
         "responses": {
@@ -1745,6 +1773,9 @@
           },
           {
             "$ref": "#/components/parameters/id"
+          },
+          {
+            "$ref": "#/components/parameters/_schema"
           }
         ],
         "requestBody": {
@@ -1810,6 +1841,9 @@
           },
           {
             "$ref": "#/components/parameters/id"
+          },
+          {
+            "$ref": "#/components/parameters/_schema"
           }
         ],
         "requestBody": {
@@ -1851,6 +1885,9 @@
           },
           {
             "$ref": "#/components/parameters/id"
+          },
+          {
+            "$ref": "#/components/parameters/_schema"
           }
         ],
         "responses": {
@@ -39205,4 +39242,4 @@
     },
     "tags": []
   }
-}
\ No newline at end of file
+}
diff --git a/vtex/utils/orderForm.ts b/vtex/utils/orderForm.ts
index a54d89b2d..01c4df192 100644
--- a/vtex/utils/orderForm.ts
+++ b/vtex/utils/orderForm.ts
@@ -1,4 +1,4 @@
-import { Cookie, getCookies } from "std/http/mod.ts";
+import { Cookie, getCookies, getSetCookies } from "std/http/mod.ts";
 import { stringify } from "./cookies.ts";
 import { MarketingData } from "./types.ts";
 
@@ -10,10 +10,22 @@ interface ParseCookieOptions {
   };
 }
 
-export const parseCookie = (
-  headers: Headers,
-  options?: ParseCookieOptions,
+export const getCheckoutVtexCookie = (headers: Headers) => {
+  const cookies = getSetCookies(headers);
+  return cookies.find((cookie) => cookie.name === VTEX_CHECKOUT_COOKIE)?.value;
+};
+
+export const safelySetCheckoutVtexCookie = (
+  cookieString: string,
+  orderFormId: string,
 ) => {
+  if (cookieString.includes(VTEX_CHECKOUT_COOKIE)) {
+    return cookieString;
+  }
+  return `${cookieString}; ${VTEX_CHECKOUT_COOKIE}=${orderFormId}`;
+};
+
+export const parseCookie = (headers: Headers, options?: ParseCookieOptions) => {
   const cookies = getCookies(headers);
   const ofidCookie = options?.overwrite?.orderformId
     ? `__ofid=${options.overwrite.orderformId}`
diff --git a/vtex/utils/segment.ts b/vtex/utils/segment.ts
index 59ffe0f75..75e7f21cf 100644
--- a/vtex/utils/segment.ts
+++ b/vtex/utils/segment.ts
@@ -6,6 +6,7 @@ import { removeNonLatin1Chars } from "../../utils/normalize.ts";
 const SEGMENT_COOKIE_NAME = "vtex_segment";
 const SALES_CHANNEL_COOKIE = "VTEXSC";
 const SEGMENT = Symbol("segment");
+const ORDER_FORM_ID = Symbol("orderFormId");
 
 export interface WrappedSegment {
   payload: Partial<Segment>;
@@ -67,6 +68,14 @@ export const getSegmentFromBag = (
   ctx: AppContext,
 ): WrappedSegment => ctx?.bag?.get(SEGMENT);
 
+export const getOrderFormIdFromBag = (
+  ctx: AppContext,
+): Promise<string | undefined> | undefined => ctx?.bag?.get(ORDER_FORM_ID);
+
+export const setOrderFormIdInBag = (
+  ctx: AppContext,
+  orderFormId: Promise<string | undefined>,
+) => ctx?.bag?.set(ORDER_FORM_ID, orderFormId);
 /**
  * Stable serialization.
  *
diff --git a/website/components/Image.tsx b/website/components/Image.tsx
index adb1f885d..271e2b321 100644
--- a/website/components/Image.tsx
+++ b/website/components/Image.tsx
@@ -5,8 +5,11 @@ import { Manifest } from "../manifest.gen.ts";
 
 export const PATH: `/live/invoke/${keyof Manifest["loaders"]}` =
   "/live/invoke/website/loaders/image.ts";
-const DECO_CACHE_URL = "https://assets.decocache.com/";
-const S3_URL = "https://deco-sites-assets.s3.sa-east-1.amazonaws.com/";
+const ASSET_URLS_TO_REPLACE = [
+  "https://assets.decocache.com/",
+  "https://deco-sites-assets.s3.sa-east-1.amazonaws.com/",
+  "https://data.decoassets.com/",
+];
 
 export type SetEarlyHint = (hint: string) => void;
 export type Props =
@@ -109,6 +112,29 @@ const optimizeVTEX = (opts: OptimizationOptions) => {
   return src.href;
 };
 
+const optimizeWake = (opts: OptimizationOptions) => {
+  const { originalSrc, width, height } = opts;
+
+  const url = new URL(originalSrc);
+  url.searchParams.set("w", `${width}`);
+  url.searchParams.set("h", `${height}`);
+
+  return url.href;
+};
+
+const optimizeMagento = (opts: OptimizationOptions) => {
+  const { originalSrc, width, height } = opts;
+
+  const url = new URL(originalSrc);
+  url.searchParams.set("width", `${width}`);
+  url.searchParams.set("height", `${height}`);
+  url.searchParams.set("canvas", `${width}:${height}`);
+  url.searchParams.set("optimize", "low");
+  url.searchParams.set("fit", opts.fit === "cover" ? "" : "bounds");
+
+  return url.href;
+};
+
 export const getOptimizedMediaUrl = (opts: OptimizationOptions) => {
   const { originalSrc, width, height, fit } = opts;
 
@@ -117,6 +143,14 @@ export const getOptimizedMediaUrl = (opts: OptimizationOptions) => {
   }
 
   if (!isImageOptmizationEnabled()) {
+    if (originalSrc.includes("media/catalog/product")) {
+      return optimizeMagento(opts);
+    }
+
+    if (originalSrc.includes("fbitsstatic.net/img/")) {
+      return optimizeWake(opts);
+    }
+
     if (originalSrc.startsWith("https://cdn.vnda.")) {
       return optmizeVNDA(opts);
     }
@@ -152,13 +186,11 @@ export const getOptimizedMediaUrl = (opts: OptimizationOptions) => {
   height && params.set("height", `${height}`);
 
   if (isAzionAssetsEnabled()) {
-    const imageSource = originalSrc
-      .replace(DECO_CACHE_URL, "")
-      .replace(
-        S3_URL,
-        "",
-      )
-      .split("?")[0];
+    const originalSrc = ASSET_URLS_TO_REPLACE.reduce(
+      (acc, url) => acc.replace(url, ""),
+      opts.originalSrc,
+    );
+    const imageSource = originalSrc.split("?")[0];
     // src is being passed separately to avoid URL encoding issues
     return `https://deco-assets.decoazn.com/image?${params}&src=${imageSource}`;
   }
@@ -229,12 +261,6 @@ export const getEarlyHintFromSrcProps = (srcProps: {
 const Image = forwardRef<HTMLImageElement, Props>((props, ref) => {
   const { preload, loading = "lazy" } = props;
 
-  if (!props.height) {
-    console.warn(
-      `Missing height. This image will NOT be optimized: ${props.src}`,
-    );
-  }
-
   const shouldSetEarlyHint = !!props.setEarlyHint && preload;
   const srcSet = props.srcSet ??
     getSrcSet(
diff --git a/website/components/_Controls.tsx b/website/components/_Controls.tsx
index ec7918795..12c5dc2c5 100644
--- a/website/components/_Controls.tsx
+++ b/website/components/_Controls.tsx
@@ -1,10 +1,7 @@
 import { Head } from "$fresh/runtime.ts";
-import { DomInspectorActivators } from "https://deno.land/x/inspect_vscode@0.2.1/inspector.ts";
-import { DomInspector } from "https://deno.land/x/inspect_vscode@0.2.1/mod.ts";
 import { Page } from "../../commerce/types.ts";
 import { useScriptAsDataURI } from "@deco/deco/hooks";
-import { context, type Flag, type Site } from "@deco/deco";
-const IS_LOCALHOST = context.deploymentId === undefined;
+import { type Flag, type Site } from "@deco/deco";
 interface Live {
   page?: Page;
   site: Site;
@@ -23,16 +20,6 @@ type EditorEvent = {
     script: string;
   };
 };
-const domInspectorModule = IS_LOCALHOST
-  ? `
-const DomInspectorActivators = {
-  Backquote: {
-    label: "\` (backtick) or Ctrl + X",
-    matchEvent: (event) => event.code === "Backquote" || (event.ctrlKey && event.key === "x"),
-  },
-};
-${DomInspector.toString()}`
-  : "";
 const snippet = (live: Live) => {
   const onKeydown = (event: KeyboardEvent) => {
     // in case loaded in iframe, avoid redirecting to editor while in editor
@@ -80,16 +67,6 @@ const snippet = (live: Live) => {
       }
     }
   };
-  //@ts-ignore: "DomInspector not available"
-  const _inspector = typeof DomInspector !== "undefined" &&
-    //@ts-ignore: "DomInspector not available"
-    new DomInspector(document.body, {
-      outline: "1px dashed #2fd080",
-      backgroundColor: "rgba(47, 208, 128, 0.33)",
-      backgroundBlendMode: "multiply",
-      activator: DomInspectorActivators.Backquote,
-      path: "/live/inspect",
-    });
   /** Setup global variables */
   globalThis.window.LIVE = { ...globalThis.window.LIVE, ...live };
   /** Setup listeners */
@@ -114,11 +91,6 @@ function LiveControls(
           avoidRedirectingToEditor,
         })}
       />
-      <script
-        dangerouslySetInnerHTML={{
-          __html: domInspectorModule,
-        }}
-      />
     </Head>
   );
 }
diff --git a/website/matchers/always.ts b/website/matchers/always.ts
index 44a2ff365..6f393b424 100644
--- a/website/matchers/always.ts
+++ b/website/matchers/always.ts
@@ -8,3 +8,5 @@ const MatchAlways = () => {
 };
 
 export default MatchAlways;
+
+export const cacheable = true;
diff --git a/website/matchers/date.ts b/website/matchers/date.ts
index 1d13dad3a..f05309a2a 100644
--- a/website/matchers/date.ts
+++ b/website/matchers/date.ts
@@ -25,3 +25,5 @@ const MatchDate = (props: Props) => {
 };
 
 export default MatchDate;
+
+export const cacheable = true;
diff --git a/website/matchers/never.ts b/website/matchers/never.ts
index 71135328e..444cc5868 100644
--- a/website/matchers/never.ts
+++ b/website/matchers/never.ts
@@ -8,3 +8,5 @@ const MatchNever = () => {
 };
 
 export default MatchNever;
+
+export const cacheable = true;

From 8dafc034fc526b4fc92fa2750a037698fa8b384e Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Wed, 21 Jan 2026 12:58:42 -0400
Subject: [PATCH 79/93] feat: add email to credentials validation api

---
 vtex/actions/credentials/validate.ts | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/vtex/actions/credentials/validate.ts b/vtex/actions/credentials/validate.ts
index e9b2145bb..3918cda00 100644
--- a/vtex/actions/credentials/validate.ts
+++ b/vtex/actions/credentials/validate.ts
@@ -13,7 +13,7 @@ export default async function action(
   props: Props,
   req: Request,
   ctx: AppContext,
-): Promise<{ valid: true; id: string } | { valid: false }> {
+): Promise<{ valid: true; id: string; email: string } | { valid: false }> {
   const { cookies } = parseCookie(req.headers, ctx.account);
   const autCookie = cookies[`VtexIdclientAutCookie_${ctx.account}`];
   const token = props.token || autCookie;
@@ -27,6 +27,7 @@ export default async function action(
     return {
       valid: response.authStatus === "Success",
       id: response.id!,
+      email: response.user!,
     };
   } catch (error) {
     if (error instanceof HttpError && error.status === 401) {

From 72b0429eeeb09596209637fd370736ee49104362 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Wed, 21 Jan 2026 13:06:49 -0400
Subject: [PATCH 80/93] feat: override orderformid to update attachment

---
 vtex/actions/cart/updateAttachment.ts | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/vtex/actions/cart/updateAttachment.ts b/vtex/actions/cart/updateAttachment.ts
index 37cf4c40b..e7bfe39db 100644
--- a/vtex/actions/cart/updateAttachment.ts
+++ b/vtex/actions/cart/updateAttachment.ts
@@ -10,6 +10,7 @@ export interface Props {
   expectedOrderFormSections?: string[];
   // deno-lint-ignore no-explicit-any
   body: any;
+  orderFormId?: string;
 }
 
 /**
@@ -26,8 +27,13 @@ const action = async (
     attachment,
     body,
     expectedOrderFormSections = DEFAULT_EXPECTED_SECTIONS,
+    orderFormId: overrideOrderFormId,
   } = props;
-  const { orderFormId } = parseCookie(req.headers);
+  const { orderFormId } = parseCookie(req.headers, {
+    overwrite: overrideOrderFormId
+      ? { orderformId: overrideOrderFormId }
+      : undefined,
+  });
 
   if (!orderFormId || orderFormId === "") {
     throw new Error("Order form ID is required");

From 758a75badcc0c404faa7dbddb0b03e56edc7eef6 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Fri, 23 Jan 2026 11:29:30 -0400
Subject: [PATCH 81/93] Squashed commit of the following:

commit 240ea15eddce324643fd1aafc34e10056d76b1ec
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Thu Jan 22 21:24:51 2026 +0000

    Update version to 0.133.26

commit 6644343ef9029a40fa168928c18963eb4edaea65
Author: guitavano <tavano62@gmail.com>
Date:   Thu Jan 22 18:24:37 2026 -0300

    optionally remove UTMs from VTEX cachekeys (#1517)

    * optionally remove UTMs from VTEX cachekeys

    * remove comments

    * coderabitai suggestion

commit ecac91e7670c0582a07e316884ffd532b935f91e
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Mon Jan 19 16:04:08 2026 +0000

    Update version to 0.133.25

commit 80b2920ce9d0b5ad031ac70f589ca92855531e5b
Author: guitavano <tavano62@gmail.com>
Date:   Mon Jan 19 13:03:53 2026 -0300

    Tavano/add cacheable matchers (#1511)

    * add cacheable matchers

    * fmt

commit dee3782d110a2ec7ba0367c6768df40735fc63b6
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Wed Jan 7 19:54:04 2026 +0000

    Update version to 0.133.24

commit 800e3a933a18d1094fab7fafae70ef98e708a8e1
Author: guitavano <tavano62@gmail.com>
Date:   Wed Jan 7 16:53:54 2026 -0300

    optmize magento (#1507)

    * optmize magento

    * fmt

commit e5f8a84e6ff320d0abc66281ee2e87513bb7ba1b
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Tue Jan 6 16:32:31 2026 +0000

    Update version to 0.133.23

commit d05f11e688209c9c66bf877f34cbb7dd27a34300
Author: guitavano <tavano62@gmail.com>
Date:   Tue Jan 6 13:32:20 2026 -0300

    fix fuzzy (#1506)

commit 30ca287c489c40eee4d9fe672020805e6744ccd6
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Tue Dec 23 21:38:11 2025 +0000

    Update version to 0.133.22

commit a42a08ec2c1042dbfe978254ce8edf78cfa7274a
Author: guitavano <tavano62@gmail.com>
Date:   Tue Dec 23 18:38:01 2025 -0300

    Refactor _Controls component by removing unused DomInspector code and related logic (#1504)

commit 9dd7e8ac668d4f4a6405b7d36392654c9d03503c
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Wed Dec 17 19:40:34 2025 +0000

    Update version to 0.133.21

commit fa0c5a8124e224955a6f266f94c0d4fa68d05376
Author: Pedro Bernardina <pedro.bernardina@guidance.dev>
Date:   Wed Dec 17 16:40:21 2025 -0300

    feat(vtex): add schema parameter to Masterdata loaders and actions (#1502)

    Co-authored-by: decobot <capy@deco.cx>

commit 05e5834a28e9c4387e9e4dc1e17385027c01d531
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Wed Dec 10 19:42:04 2025 +0000

    Update version to 0.133.20

commit 46f346d0d943cbc6158e0372d437e5952fea00a1
Author: guitavano <tavano62@gmail.com>
Date:   Wed Dec 10 16:41:51 2025 -0300

    add wake optimization for images (#1501)

    * add wake optimization for images

    * fmt

commit 2b0d58354fd49a6d7b77f7866e702631c0dbf245
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Wed Dec 10 16:27:37 2025 +0000

    Update version to 0.133.19

commit 47bb82e3c281f7621e33043f4dc8a977714d18f2
Author: guitavano <tavano62@gmail.com>
Date:   Wed Dec 10 13:27:25 2025 -0300

    remove console.warn from Image Component (#1499)

commit 6b8525b37eb0810d3d6ede922fa198d74b0dc3ce
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Wed Dec 10 16:25:05 2025 +0000

    Update version to 0.133.18

commit 3c7a7be561e4f8b51b11280a22f8abd902e06162
Author: guitavano <tavano62@gmail.com>
Date:   Wed Dec 10 13:24:53 2025 -0300

    add Vary Cookie (#1483)

    * add Vary Cookie

    * only vary cookie if includes checkout

    * clear cookie if mismatch

    * improve log

    * only clear specific orderFormIds

    * clear blocklist even if it is not mismatch

    * Add orderFormIdsToClear variable for improved cart handling

    * handling better with logged cases

    * removed clear cart cookie

    * removed custom header from checkout

    ---------

    Co-authored-by: decobot <capy@deco.cx>

commit 7f44e26f865348d7d409879a7d6025ef4aa011d0
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Wed Dec 10 15:26:23 2025 +0000

    Update version to 0.133.17

commit 535e9ac9d2c38dcce98504c41e6f377c030eb495
Author: L. Sacci <167649583+aka-sacci-ccr@users.noreply.github.com>
Date:   Wed Dec 10 12:26:11 2025 -0300

    added inventory (#1498)

    Co-authored-by: decobot <capy@deco.cx>

commit a94f6ad323e96e0059ead8146063c67d5a5af108
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Mon Dec 8 17:09:48 2025 +0000

    Update version to 0.133.16

commit c1ceeef579f9728fe1775afa49b4fd7358f5fae6
Author: guitavano <tavano62@gmail.com>
Date:   Mon Dec 8 14:09:32 2025 -0300

    add data.decoassets.com (#1496)

    * add data.decoassets.com

    * fmt

commit ecc4a9d7dc8fb1ca9bec7c1cb8ef7f8b471a14f2
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Fri Dec 5 16:56:50 2025 +0000

    Update version to 0.133.15

commit 7c8f79dd9c3a1df42113ed9be2cf9d0423bcef75
Author: L. Sacci <167649583+aka-sacci-ccr@users.noreply.github.com>
Date:   Fri Dec 5 13:56:40 2025 -0300

    feat(hubspot): update ticket tool (#1495)

    * feat(hubspot): update ticket tool

    * updated gen

    * updated gen

    ---------

    Co-authored-by: decobot <capy@deco.cx>

commit 3337db5da0239ccbe6d511dd49c415bd1a8d25ab
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Thu Dec 4 23:33:04 2025 +0000

    Update version to 0.133.14

commit e2b9abe0b470cec4132382a7bd7cebff5a0c2d60
Author: L. Sacci <167649583+aka-sacci-ccr@users.noreply.github.com>
Date:   Thu Dec 4 20:32:53 2025 -0300

    fix(hubspot): thread params (#1494)

    Co-authored-by: decobot <capy@deco.cx>

commit cd8a9ebce064275a2a8a63472957ba7a99a6c695
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Tue Dec 2 13:35:08 2025 +0000

    Update version to 0.133.13

commit 3afb7e1d18bb2762d84750dd12d07da1af435dfd
Author: L. Sacci <167649583+aka-sacci-ccr@users.noreply.github.com>
Date:   Tue Dec 2 10:34:51 2025 -0300

    fix(linx): added forcing source (#1490)

    * fix(linx): added forcing source

    * fmt

    * regen drive manifest

    ---------

    Co-authored-by: decobot <capy@deco.cx>

commit 3831358c844c05a87d9aa7e76e0f7c570348161b
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Tue Dec 2 13:33:55 2025 +0000

    Update version to 0.133.12

commit 4bfe75199415ac0ea514f13db01f32aada86c2a7
Author: L. Sacci <167649583+aka-sacci-ccr@users.noreply.github.com>
Date:   Tue Dec 2 10:33:34 2025 -0300

    fix(vtex): listingPage loader sort (#1491)

    Co-authored-by: decobot <capy@deco.cx>

commit 7fcdb230d16bb173e6a60a8510473d849268d328
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Mon Dec 1 19:01:09 2025 +0000

    Update version to 0.133.11

commit 5887e18b905bad8dc99e32e5206ca1b5e0612e1b
Author: L. Sacci <167649583+aka-sacci-ccr@users.noreply.github.com>
Date:   Mon Dec 1 16:00:55 2025 -0300

    small fix in hub client (#1492)

    * small fix in hub client

    * fix in drive manifest

    ---------

    Co-authored-by: decobot <capy@deco.cx>

commit 67f142f88d13a6201aa33ceb04b0b668ba0df379
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Thu Nov 27 05:00:50 2025 +0000

    Update version to 0.133.10

commit 3f1c594adbd1cbcc69b0590beedcf3c7ed00dae6
Author: Jonas Jesus <jonasjesus@carcara.tech>
Date:   Thu Nov 27 02:00:39 2025 -0300

    feat: add download file action for Google Drive with multiple output formats (#1489)

    - Add DownloadFileParams and DownloadFileResult interfaces in types.ts
    - Add download endpoint to Client interface in client.ts
    - Add error constants for download operations in constant.ts
    - Create new download.ts action with support for 3 output formats:
      * link: Returns webContentLink without actual file download
      * base64: Downloads file and returns as base64 string
      * blob: Downloads file and returns as ArrayBuffer
    - Update mod.ts to include new error handlers

commit 9bf0b5a14cafe7b7f601420c792388abc5c74cd9
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Tue Nov 25 19:21:39 2025 +0000

    Update version to 0.133.9

commit 52100b12c1ab7560f22e6eb9d8e7eda354f15891
Author: Renan Henrique <93907598+RenanHCosta@users.noreply.github.com>
Date:   Tue Nov 25 16:21:24 2025 -0300

    feat: VNDA productListingPage default sorting param (#1481)

    * feat: VNDA productListingPage default sorting param

    * fix: cacheKey sort precedence order

commit 278fcbfdbaa03251803a3d2b57daa6c189f1d716
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Fri Nov 21 13:43:21 2025 +0000

    Update version to 0.133.8

commit 5906a9944cec1dbf19be4f929f4f0bf27d368e3f
Author: L. Sacci <167649583+aka-sacci-ccr@users.noreply.github.com>
Date:   Fri Nov 21 10:43:10 2025 -0300

    fmt (#1485)

    Co-authored-by: decobot <capy@deco.cx>

commit 91ea12e68f0a6d9b551503a2df849e2e70cd916a
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Fri Nov 21 13:38:56 2025 +0000

    Update version to 0.133.7

commit a708ba71f19db9e42d783b1ada195825718b1ea6
Author: Rafael Oliveira <87982042+pandeiro7@users.noreply.github.com>
Date:   Fri Nov 21 10:38:40 2025 -0300

    feat: simulationBehavior productDetails (#1453)

    * feat: simulationBehavior productDetails

    * fix(pdp): simulation behaviour fallback

    ---------

    Co-authored-by: pandeiro7 <dev@tec4udigital.com>
    Co-authored-by: L. Sacci <167649583+aka-sacci-ccr@users.noreply.github.com>

commit 4fae26e3bf468b2fcf87649c9b6bd0b293c4bf4f
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Wed Nov 19 13:01:00 2025 +0000

    Update version to 0.133.6

commit 60cbaf26def11aa2f9a123b6182d63ea43fd1565
Author: Tiago Gimenes <tlgimenes@gmail.com>
Date:   Wed Nov 19 10:00:46 2025 -0300

    chore: add logs to cart (#1482)

    * add logs to cart

    * add logs to cart

commit 8ca84a8b38b40a5ca5bc6092ff171946bc5b923c
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Wed Nov 19 00:29:24 2025 +0000

    Update version to 0.133.5

commit 728a9674a9bce17d92eac560b3613c0a005601c1
Author: Marcos Candeia <marrcooos@gmail.com>
Date:   Tue Nov 18 21:29:12 2025 -0300

    Deduplicate vtex cookie (#1480)

    * Deduplicate vtex cookie

    Signed-off-by: Marcos Candeia <marrcooos@gmail.com>

    * Use cookie with orderFormId on marketing data

    Signed-off-by: Marcos Candeia <marrcooos@gmail.com>

    * Fix orderform fn

    Signed-off-by: Marcos Candeia <marrcooos@gmail.com>

    * Format ts

    Signed-off-by: Marcos Candeia <marrcooos@gmail.com>

    * Adds cache no store

    Signed-off-by: Marcos Candeia <marrcooos@gmail.com>

    ---------

    Signed-off-by: Marcos Candeia <marrcooos@gmail.com>

commit 3b1a4a55ea64b2669c496b7e80ba5b82d4d33578
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Mon Nov 17 15:03:05 2025 +0000

    Update version to 0.133.4

commit e1aa80f4f18d0a9ac919103f4c02964109f6b24d
Author: Jonas Jesus <jonasjesus@carcara.tech>
Date:   Mon Nov 17 12:02:48 2025 -0300

    Error docs (#1478)

    * fix: adjust return errors

    * fix: adjust return type to handle document retrieval errors properly

    * refactor: remove listDocuments and searchDocuments loaders to streamline document handling

    * refactor: update manifest to remove unused loaders and streamline imports

commit 89cd94c4605a8fa3805078a2b10669fc921df9af
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Mon Nov 17 14:13:49 2025 +0000

    Update version to 0.133.3

commit 09732efe362d3334fa03ee5fff69bf6bca33ff81
Author: Jonas Jesus <jonasjesus@carcara.tech>
Date:   Mon Nov 17 11:13:36 2025 -0300

    fix: adjust return errors (#1477)

    * fix: adjust return errors

    * fix: adjust return type to handle document retrieval errors properly
---
 deno.json                                     |  4 +--
 .../intelligentSearch/productDetailsPage.ts   | 10 ++++--
 vtex/loaders/intelligentSearch/productList.ts | 13 +++++---
 .../intelligentSearch/productListingPage.ts   | 13 ++++++--
 vtex/loaders/intelligentSearch/suggestions.ts | 10 ++++--
 vtex/loaders/intelligentSearch/topsearches.ts | 10 ++++--
 vtex/loaders/legacy/productDetailsPage.ts     | 13 ++++++--
 vtex/loaders/legacy/productList.ts            | 12 +++++--
 vtex/loaders/legacy/productListingPage.ts     | 12 +++++--
 vtex/loaders/legacy/relatedProductsLoader.ts  | 12 +++++--
 vtex/loaders/legacy/suggestions.ts            | 10 ++++--
 vtex/mod.ts                                   |  5 +++
 vtex/utils/segment.ts                         | 31 +++++++++++++++++++
 13 files changed, 126 insertions(+), 29 deletions(-)

diff --git a/deno.json b/deno.json
index 0ccf51d56..2351ea449 100644
--- a/deno.json
+++ b/deno.json
@@ -69,5 +69,5 @@
       ]
     }
   },
-  "version": "0.133.25"
-}
+  "version": "0.133.26"
+}
\ No newline at end of file
diff --git a/vtex/loaders/intelligentSearch/productDetailsPage.ts b/vtex/loaders/intelligentSearch/productDetailsPage.ts
index 8b519e1b7..0e593f551 100644
--- a/vtex/loaders/intelligentSearch/productDetailsPage.ts
+++ b/vtex/loaders/intelligentSearch/productDetailsPage.ts
@@ -8,7 +8,11 @@ import {
   withDefaultParams,
 } from "../../utils/intelligentSearch.ts";
 import { pageTypesToSeo } from "../../utils/legacy.ts";
-import { getSegmentFromBag, withSegmentCookie } from "../../utils/segment.ts";
+import {
+  getSegmentCacheKeyWithoutUTM,
+  getSegmentFromBag,
+  withSegmentCookie,
+} from "../../utils/segment.ts";
 import { withIsSimilarTo } from "../../utils/similars.ts";
 import { pickSku, toProductPage } from "../../utils/transform.ts";
 import type {
@@ -174,7 +178,9 @@ const loader = async (
 export const cache = "stale-while-revalidate";
 
 export const cacheKey = (props: Props, req: Request, ctx: AppContext) => {
-  const segment = getSegmentFromBag(ctx)?.token;
+  const segment = ctx.advancedConfigs?.removeUTMFromCacheKey
+    ? getSegmentCacheKeyWithoutUTM(ctx)
+    : getSegmentFromBag(ctx)?.token;
   const url = new URL(req.url);
   const skuId = url.searchParams.get("skuId") ?? "";
 
diff --git a/vtex/loaders/intelligentSearch/productList.ts b/vtex/loaders/intelligentSearch/productList.ts
index 512c2d479..e5625136b 100644
--- a/vtex/loaders/intelligentSearch/productList.ts
+++ b/vtex/loaders/intelligentSearch/productList.ts
@@ -7,7 +7,11 @@ import {
   withDefaultFacets,
   withDefaultParams,
 } from "../../utils/intelligentSearch.ts";
-import { getSegmentFromBag, withSegmentCookie } from "../../utils/segment.ts";
+import {
+  getSegmentCacheKeyWithoutUTM,
+  getSegmentFromBag,
+  withSegmentCookie,
+} from "../../utils/segment.ts";
 import { withIsSimilarTo } from "../../utils/similars.ts";
 import { getSkipSimulationBehaviorFromBag } from "../../utils/simulationBehavior.ts";
 import { sortProducts, toProduct } from "../../utils/transform.ts";
@@ -335,11 +339,12 @@ export const cacheKey = (
   ) {
     return null;
   }
-
-  const segment = getSegmentFromBag(ctx)?.token ?? "";
+  const segmentCacheKey = ctx.advancedConfigs?.removeUTMFromCacheKey
+    ? getSegmentCacheKeyWithoutUTM(ctx)
+    : getSegmentFromBag(ctx)?.token;
   const params = new URLSearchParams([
     ...getSearchParams(props, url.searchParams),
-    ["segment", segment],
+    ["segment", segmentCacheKey],
   ]);
 
   if (
diff --git a/vtex/loaders/intelligentSearch/productListingPage.ts b/vtex/loaders/intelligentSearch/productListingPage.ts
index ffb627b89..3be34eff7 100644
--- a/vtex/loaders/intelligentSearch/productListingPage.ts
+++ b/vtex/loaders/intelligentSearch/productListingPage.ts
@@ -18,7 +18,11 @@ import {
   pageTypesToBreadcrumbList,
   pageTypesToSeo,
 } from "../../utils/legacy.ts";
-import { getSegmentFromBag, withSegmentCookie } from "../../utils/segment.ts";
+import {
+  getSegmentCacheKeyWithoutUTM,
+  getSegmentFromBag,
+  withSegmentCookie,
+} from "../../utils/segment.ts";
 import { withIsSimilarTo } from "../../utils/similars.ts";
 import { getSkipSimulationBehaviorFromBag } from "../../utils/simulationBehavior.ts";
 import { slugify } from "../../utils/slugify.ts";
@@ -530,7 +534,10 @@ export const cacheKey = (props: Props, req: Request, ctx: AppContext) => {
   if (searchTerm && !cachedSearchTerms.includes(searchTerm.toLowerCase())) {
     return null;
   }
-  const segment = getSegmentFromBag(ctx)?.token ?? "";
+
+  const segment = ctx.advancedConfigs?.removeUTMFromCacheKey
+    ? getSegmentCacheKeyWithoutUTM(ctx)
+    : getSegmentFromBag(ctx)?.token;
 
   const params = new URLSearchParams([
     ["query", props.query ?? ""],
@@ -551,7 +558,7 @@ export const cacheKey = (props: Props, req: Request, ctx: AppContext) => {
         [] as string[],
       ).join("\\"),
     ],
-    ["segment", segment],
+    ["segment", segment ?? ""],
     [
       "simulationBehavior",
       getSkipSimulationBehaviorFromBag(ctx)
diff --git a/vtex/loaders/intelligentSearch/suggestions.ts b/vtex/loaders/intelligentSearch/suggestions.ts
index 910fc9c9d..7530f85d6 100644
--- a/vtex/loaders/intelligentSearch/suggestions.ts
+++ b/vtex/loaders/intelligentSearch/suggestions.ts
@@ -6,7 +6,11 @@ import {
   withDefaultFacets,
   withDefaultParams,
 } from "../../utils/intelligentSearch.ts";
-import { getSegmentFromBag, withSegmentCookie } from "../../utils/segment.ts";
+import {
+  getSegmentCacheKeyWithoutUTM,
+  getSegmentFromBag,
+  withSegmentCookie,
+} from "../../utils/segment.ts";
 import { withIsSimilarTo } from "../../utils/similars.ts";
 import { toProduct } from "../../utils/transform.ts";
 import type { AdvancedLoaderConfig } from "../../utils/types.ts";
@@ -103,7 +107,9 @@ const loaders = async (
 export const cache = "stale-while-revalidate";
 
 export const cacheKey = (props: Props, _req: Request, ctx: AppContext) => {
-  const segment = getSegmentFromBag(ctx)?.token ?? "";
+  const segment = ctx.advancedConfigs?.removeUTMFromCacheKey
+    ? getSegmentCacheKeyWithoutUTM(ctx)
+    : getSegmentFromBag(ctx)?.token;
   return `suggestions-${props.query ?? ""}-${props.count ?? 4}-${segment}`;
 };
 
diff --git a/vtex/loaders/intelligentSearch/topsearches.ts b/vtex/loaders/intelligentSearch/topsearches.ts
index 39028c40d..94bc087fb 100644
--- a/vtex/loaders/intelligentSearch/topsearches.ts
+++ b/vtex/loaders/intelligentSearch/topsearches.ts
@@ -1,5 +1,9 @@
 import { AppContext } from "../../mod.ts";
-import { getSegmentFromBag, withSegmentCookie } from "../../utils/segment.ts";
+import {
+  getSegmentCacheKeyWithoutUTM,
+  getSegmentFromBag,
+  withSegmentCookie,
+} from "../../utils/segment.ts";
 import { STALE } from "../../../utils/fetch.ts";
 import { Suggestion } from "../../../commerce/types.ts";
 
@@ -28,6 +32,8 @@ export const cache = {
 };
 
 export const cacheKey = (_props: unknown, _req: Request, ctx: AppContext) => {
-  const segment = getSegmentFromBag(ctx)?.token ?? "";
+  const segment = ctx.advancedConfigs?.removeUTMFromCacheKey
+    ? getSegmentCacheKeyWithoutUTM(ctx)
+    : getSegmentFromBag(ctx)?.token;
   return `topsearches-${segment}`;
 };
diff --git a/vtex/loaders/legacy/productDetailsPage.ts b/vtex/loaders/legacy/productDetailsPage.ts
index 54bc31fb8..7691ec71f 100644
--- a/vtex/loaders/legacy/productDetailsPage.ts
+++ b/vtex/loaders/legacy/productDetailsPage.ts
@@ -3,7 +3,11 @@ import { STALE } from "../../../utils/fetch.ts";
 import type { RequestURLParam } from "../../../website/functions/requestToParam.ts";
 import { AppContext } from "../../mod.ts";
 import { toSegmentParams } from "../../utils/legacy.ts";
-import { getSegmentFromBag, withSegmentCookie } from "../../utils/segment.ts";
+import {
+  getSegmentCacheKeyWithoutUTM,
+  getSegmentFromBag,
+  withSegmentCookie,
+} from "../../utils/segment.ts";
 import { withIsSimilarTo } from "../../utils/similars.ts";
 import { pickSku, toProductPage } from "../../utils/transform.ts";
 import type { AdvancedLoaderConfig, LegacyProduct } from "../../utils/types.ts";
@@ -118,12 +122,15 @@ export const cacheKey = (props: Props, req: Request, ctx: AppContext) => {
   if (url.searchParams.has("ft")) {
     return null;
   }
-  const segment = getSegmentFromBag(ctx)?.token ?? "";
+
+  const segment = ctx.advancedConfigs?.removeUTMFromCacheKey
+    ? getSegmentCacheKeyWithoutUTM(ctx)
+    : getSegmentFromBag(ctx)?.token;
   const skuId = url.searchParams.get("skuId") ?? "";
 
   const params = new URLSearchParams([
     ["slug", props.slug],
-    ["segment", segment],
+    ["segment", segment ?? ""],
     ["skuId", skuId],
   ]);
 
diff --git a/vtex/loaders/legacy/productList.ts b/vtex/loaders/legacy/productList.ts
index cac1715ce..12fe32f27 100644
--- a/vtex/loaders/legacy/productList.ts
+++ b/vtex/loaders/legacy/productList.ts
@@ -2,7 +2,11 @@ import type { Product } from "../../../commerce/types.ts";
 import { STALE } from "../../../utils/fetch.ts";
 import { AppContext } from "../../mod.ts";
 import { isFilterParam, toSegmentParams } from "../../utils/legacy.ts";
-import { getSegmentFromBag, withSegmentCookie } from "../../utils/segment.ts";
+import {
+  getSegmentCacheKeyWithoutUTM,
+  getSegmentFromBag,
+  withSegmentCookie,
+} from "../../utils/segment.ts";
 import { withIsSimilarTo } from "../../utils/similars.ts";
 import { sortProducts, toProduct } from "../../utils/transform.ts";
 import type { LegacyItem, LegacySort } from "../../utils/types.ts";
@@ -295,10 +299,12 @@ export const cacheKey = (
     return null;
   }
 
-  const segment = getSegmentFromBag(ctx)?.token ?? "";
+  const segment = ctx.advancedConfigs?.removeUTMFromCacheKey
+    ? getSegmentCacheKeyWithoutUTM(ctx)
+    : getSegmentFromBag(ctx)?.token;
   const params = new URLSearchParams([
     ...getSearchParams(props, url.searchParams),
-    ["segment", segment],
+    ["segment", segment ?? ""],
   ]);
 
   if (isSKUIDProps(props)) {
diff --git a/vtex/loaders/legacy/productListingPage.ts b/vtex/loaders/legacy/productListingPage.ts
index d7c23a0c6..b816282d7 100644
--- a/vtex/loaders/legacy/productListingPage.ts
+++ b/vtex/loaders/legacy/productListingPage.ts
@@ -11,7 +11,11 @@ import {
   pageTypesToSeo,
   toSegmentParams,
 } from "../../utils/legacy.ts";
-import { getSegmentFromBag, withSegmentCookie } from "../../utils/segment.ts";
+import {
+  getSegmentCacheKeyWithoutUTM,
+  getSegmentFromBag,
+  withSegmentCookie,
+} from "../../utils/segment.ts";
 import { withIsSimilarTo } from "../../utils/similars.ts";
 import { parsePageType } from "../../utils/transform.ts";
 import { legacyFacetToFilter, toProduct } from "../../utils/transform.ts";
@@ -456,7 +460,9 @@ export const cacheKey = (props: Props, req: Request, ctx: AppContext) => {
       ...url.searchParams.getAll("fq"),
     ]),
   ].sort();
-  const segment = getSegmentFromBag(ctx)?.token ?? "";
+  const segment = ctx.advancedConfigs?.removeUTMFromCacheKey
+    ? getSegmentCacheKeyWithoutUTM(ctx)
+    : getSegmentFromBag(ctx)?.token;
   const sort = (url.searchParams.get("O") as LegacySort) ??
     IS_TO_LEGACY[url.searchParams.get("sort") ?? ""] ??
     url.searchParams.get("sort") ??
@@ -479,7 +485,7 @@ export const cacheKey = (props: Props, req: Request, ctx: AppContext) => {
     ["map", props.map ?? url.searchParams.get("map") ?? ""],
     ["pageOffset", (props.pageOffset ?? 1).toString()],
     ["ignoreCaseSelected", (props.ignoreCaseSelected ?? false).toString()],
-    ["segment", segment],
+    ["segment", segment ?? ""],
   ]);
 
   url.searchParams.forEach((value, key) => {
diff --git a/vtex/loaders/legacy/relatedProductsLoader.ts b/vtex/loaders/legacy/relatedProductsLoader.ts
index 7b046697b..aa6ee538e 100644
--- a/vtex/loaders/legacy/relatedProductsLoader.ts
+++ b/vtex/loaders/legacy/relatedProductsLoader.ts
@@ -4,7 +4,11 @@ import { RequestURLParam } from "../../../website/functions/requestToParam.ts";
 import { AppContext } from "../../mod.ts";
 import { batch } from "../../utils/batch.ts";
 import { isFilterParam, toSegmentParams } from "../../utils/legacy.ts";
-import { getSegmentFromBag, withSegmentCookie } from "../../utils/segment.ts";
+import {
+  getSegmentCacheKeyWithoutUTM,
+  getSegmentFromBag,
+  withSegmentCookie,
+} from "../../utils/segment.ts";
 import { pickSku, toProduct } from "../../utils/transform.ts";
 import type { CrossSellingType } from "../../utils/types.ts";
 import productList from "./productList.ts";
@@ -165,14 +169,16 @@ export const cacheKey = (props: Props, req: Request, ctx: AppContext) => {
     return null;
   }
 
-  const segment = getSegmentFromBag(ctx)?.token || "";
+  const segment = ctx.advancedConfigs?.removeUTMFromCacheKey
+    ? getSegmentCacheKeyWithoutUTM(ctx)
+    : getSegmentFromBag(ctx)?.token;
   const params = new URLSearchParams([
     ["slug", props.slug ?? ""],
     ["id", props.id ?? ""],
     ["crossSelling", props.crossSelling],
     ["count", (props.count ?? 0).toString()],
     ["hideUnavailableItems", (props.hideUnavailableItems ?? false).toString()],
-    ["segment", segment],
+    ["segment", segment ?? ""],
   ]);
 
   url.searchParams.forEach((value, key) => {
diff --git a/vtex/loaders/legacy/suggestions.ts b/vtex/loaders/legacy/suggestions.ts
index b7cbefbec..1dbd0da35 100644
--- a/vtex/loaders/legacy/suggestions.ts
+++ b/vtex/loaders/legacy/suggestions.ts
@@ -1,6 +1,10 @@
 import { Product, Suggestion } from "../../../commerce/types.ts";
 import { AppContext } from "../../mod.ts";
-import { getSegmentFromBag, withSegmentCookie } from "../../utils/segment.ts";
+import {
+  getSegmentCacheKeyWithoutUTM,
+  getSegmentFromBag,
+  withSegmentCookie,
+} from "../../utils/segment.ts";
 
 export interface Props {
   query?: string;
@@ -85,7 +89,9 @@ const loaders = async (
 export const cache = "stale-while-revalidate";
 
 export const cacheKey = (props: Props, _req: Request, ctx: AppContext) => {
-  const segment = getSegmentFromBag(ctx)?.token ?? "";
+  const segment = ctx.advancedConfigs?.removeUTMFromCacheKey
+    ? getSegmentCacheKeyWithoutUTM(ctx)
+    : getSegmentFromBag(ctx)?.token;
   return `legacy-suggestions-${props.query ?? ""}-${
     props.count ?? 4
   }-${segment}`;
diff --git a/vtex/mod.ts b/vtex/mod.ts
index b7ad6ce70..01fe627fe 100644
--- a/vtex/mod.ts
+++ b/vtex/mod.ts
@@ -95,6 +95,11 @@ export interface Props {
   skipSimulationBehavior?: Matcher;
   advancedConfigs?: {
     doNotFetchVariantsForRelatedProducts?: boolean;
+    /**
+     * @title Remove UTM from cache key
+     * @description Remove UTM from cache key to prevent cache fragmentation.
+     */
+    removeUTMFromCacheKey?: boolean;
   };
 
   /**
diff --git a/vtex/utils/segment.ts b/vtex/utils/segment.ts
index 75e7f21cf..a89dc682c 100644
--- a/vtex/utils/segment.ts
+++ b/vtex/utils/segment.ts
@@ -76,6 +76,37 @@ export const setOrderFormIdInBag = (
   ctx: AppContext,
   orderFormId: Promise<string | undefined>,
 ) => ctx?.bag?.set(ORDER_FORM_ID, orderFormId);
+
+/**
+ * Creates a stable cache key from segment that only includes business-critical fields.
+ * Excludes marketing/tracking parameters (UTM, UTMI) to prevent cache fragmentation.
+ *
+ * Use this for cacheKey generation instead of the full segment token.
+ */
+export const getSegmentCacheKeyWithoutUTM = (ctx: AppContext): string => {
+  const segment = getSegmentFromBag(ctx)?.payload;
+
+  if (!segment) {
+    return "";
+  }
+
+  // Only include fields that affect pricing, inventory, or content
+  const cacheRelevantSegment = {
+    campaigns: segment.campaigns, // VTEX campaigns (can affect pricing)
+    channel: segment.channel, // Sales channel (affects inventory/pricing)
+    priceTables: segment.priceTables, // Price tables (affects pricing)
+    regionId: segment.regionId, // Region (can affect pricing/inventory)
+    currencyCode: segment.currencyCode, // Currency
+    cultureInfo: segment.cultureInfo, // Locale/language
+    countryCode: segment.countryCode, // Country
+    channelPrivacy: segment.channelPrivacy, // Privacy settings
+    // EXCLUDED: utm_campaign, utm_source, utm_medium (marketing only)
+    // EXCLUDED: utmi_campaign, utmi_page, utmi_part (VTEX tracking only)
+  };
+
+  // Stable serialization for consistent cache keys
+  return btoa(JSON.stringify(cacheRelevantSegment));
+};
 /**
  * Stable serialization.
  *

From 807fe6dbc26c043d404c21752cd1cd1dd28e579e Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Tue, 3 Feb 2026 17:14:57 -0400
Subject: [PATCH 82/93] Squashed commit of the following:

commit bf65ac1d07d4d49a0c06b2971fb70c6820e1d611
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Thu Jan 29 20:53:35 2026 +0000

    Update version to 0.133.28

commit 895bae5c2cf5b128008d241bf74c504bc770e10c
Author: guitavano <tavano62@gmail.com>
Date:   Thu Jan 29 17:53:10 2026 -0300

    Tavano/add cache for review (#1518)

    * add 1 hour cache for review

    * fmt

commit 01c481c3362b4d3eee272f7e8759bf19a0dccca6
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Mon Jan 26 14:51:48 2026 +0000

    Update version to 0.133.27

commit 328771e79173a322e6bc4e52376f94836035d2f1
Author: Renan Henrique <93907598+RenanHCosta@users.noreply.github.com>
Date:   Mon Jan 26 11:51:34 2026 -0300

    fix: blog posts term filter (#1509)

    * fix: blog posts term filter

    * fix(fmt): Update blog/core/handlePosts.ts

    Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

    * fix(fmt): run deno fmt

    ---------

    Co-authored-by: decobot <capy@deco.cx>
    Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

commit 240ea15eddce324643fd1aafc34e10056d76b1ec
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Thu Jan 22 21:24:51 2026 +0000

    Update version to 0.133.26

commit 6644343ef9029a40fa168928c18963eb4edaea65
Author: guitavano <tavano62@gmail.com>
Date:   Thu Jan 22 18:24:37 2026 -0300

    optionally remove UTMs from VTEX cachekeys (#1517)

    * optionally remove UTMs from VTEX cachekeys

    * remove comments

    * coderabitai suggestion

commit ecac91e7670c0582a07e316884ffd532b935f91e
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Mon Jan 19 16:04:08 2026 +0000

    Update version to 0.133.25

commit 80b2920ce9d0b5ad031ac70f589ca92855531e5b
Author: guitavano <tavano62@gmail.com>
Date:   Mon Jan 19 13:03:53 2026 -0300

    Tavano/add cacheable matchers (#1511)

    * add cacheable matchers

    * fmt

commit dee3782d110a2ec7ba0367c6768df40735fc63b6
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Wed Jan 7 19:54:04 2026 +0000

    Update version to 0.133.24

commit 800e3a933a18d1094fab7fafae70ef98e708a8e1
Author: guitavano <tavano62@gmail.com>
Date:   Wed Jan 7 16:53:54 2026 -0300

    optmize magento (#1507)

    * optmize magento

    * fmt

commit e5f8a84e6ff320d0abc66281ee2e87513bb7ba1b
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Tue Jan 6 16:32:31 2026 +0000

    Update version to 0.133.23

commit d05f11e688209c9c66bf877f34cbb7dd27a34300
Author: guitavano <tavano62@gmail.com>
Date:   Tue Jan 6 13:32:20 2026 -0300

    fix fuzzy (#1506)

commit 30ca287c489c40eee4d9fe672020805e6744ccd6
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Tue Dec 23 21:38:11 2025 +0000

    Update version to 0.133.22

commit a42a08ec2c1042dbfe978254ce8edf78cfa7274a
Author: guitavano <tavano62@gmail.com>
Date:   Tue Dec 23 18:38:01 2025 -0300

    Refactor _Controls component by removing unused DomInspector code and related logic (#1504)

commit 9dd7e8ac668d4f4a6405b7d36392654c9d03503c
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Wed Dec 17 19:40:34 2025 +0000

    Update version to 0.133.21

commit fa0c5a8124e224955a6f266f94c0d4fa68d05376
Author: Pedro Bernardina <pedro.bernardina@guidance.dev>
Date:   Wed Dec 17 16:40:21 2025 -0300

    feat(vtex): add schema parameter to Masterdata loaders and actions (#1502)

    Co-authored-by: decobot <capy@deco.cx>

commit 05e5834a28e9c4387e9e4dc1e17385027c01d531
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Wed Dec 10 19:42:04 2025 +0000

    Update version to 0.133.20

commit 46f346d0d943cbc6158e0372d437e5952fea00a1
Author: guitavano <tavano62@gmail.com>
Date:   Wed Dec 10 16:41:51 2025 -0300

    add wake optimization for images (#1501)

    * add wake optimization for images

    * fmt

commit 2b0d58354fd49a6d7b77f7866e702631c0dbf245
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Wed Dec 10 16:27:37 2025 +0000

    Update version to 0.133.19

commit 47bb82e3c281f7621e33043f4dc8a977714d18f2
Author: guitavano <tavano62@gmail.com>
Date:   Wed Dec 10 13:27:25 2025 -0300

    remove console.warn from Image Component (#1499)

commit 6b8525b37eb0810d3d6ede922fa198d74b0dc3ce
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Wed Dec 10 16:25:05 2025 +0000

    Update version to 0.133.18

commit 3c7a7be561e4f8b51b11280a22f8abd902e06162
Author: guitavano <tavano62@gmail.com>
Date:   Wed Dec 10 13:24:53 2025 -0300

    add Vary Cookie (#1483)

    * add Vary Cookie

    * only vary cookie if includes checkout

    * clear cookie if mismatch

    * improve log

    * only clear specific orderFormIds

    * clear blocklist even if it is not mismatch

    * Add orderFormIdsToClear variable for improved cart handling

    * handling better with logged cases

    * removed clear cart cookie

    * removed custom header from checkout

    ---------

    Co-authored-by: decobot <capy@deco.cx>

commit 7f44e26f865348d7d409879a7d6025ef4aa011d0
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Wed Dec 10 15:26:23 2025 +0000

    Update version to 0.133.17

commit 535e9ac9d2c38dcce98504c41e6f377c030eb495
Author: L. Sacci <167649583+aka-sacci-ccr@users.noreply.github.com>
Date:   Wed Dec 10 12:26:11 2025 -0300

    added inventory (#1498)

    Co-authored-by: decobot <capy@deco.cx>

commit a94f6ad323e96e0059ead8146063c67d5a5af108
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Mon Dec 8 17:09:48 2025 +0000

    Update version to 0.133.16

commit c1ceeef579f9728fe1775afa49b4fd7358f5fae6
Author: guitavano <tavano62@gmail.com>
Date:   Mon Dec 8 14:09:32 2025 -0300

    add data.decoassets.com (#1496)

    * add data.decoassets.com

    * fmt

commit ecc4a9d7dc8fb1ca9bec7c1cb8ef7f8b471a14f2
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Fri Dec 5 16:56:50 2025 +0000

    Update version to 0.133.15

commit 7c8f79dd9c3a1df42113ed9be2cf9d0423bcef75
Author: L. Sacci <167649583+aka-sacci-ccr@users.noreply.github.com>
Date:   Fri Dec 5 13:56:40 2025 -0300

    feat(hubspot): update ticket tool (#1495)

    * feat(hubspot): update ticket tool

    * updated gen

    * updated gen

    ---------

    Co-authored-by: decobot <capy@deco.cx>

commit 3337db5da0239ccbe6d511dd49c415bd1a8d25ab
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Thu Dec 4 23:33:04 2025 +0000

    Update version to 0.133.14

commit e2b9abe0b470cec4132382a7bd7cebff5a0c2d60
Author: L. Sacci <167649583+aka-sacci-ccr@users.noreply.github.com>
Date:   Thu Dec 4 20:32:53 2025 -0300

    fix(hubspot): thread params (#1494)

    Co-authored-by: decobot <capy@deco.cx>

commit cd8a9ebce064275a2a8a63472957ba7a99a6c695
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Tue Dec 2 13:35:08 2025 +0000

    Update version to 0.133.13

commit 3afb7e1d18bb2762d84750dd12d07da1af435dfd
Author: L. Sacci <167649583+aka-sacci-ccr@users.noreply.github.com>
Date:   Tue Dec 2 10:34:51 2025 -0300

    fix(linx): added forcing source (#1490)

    * fix(linx): added forcing source

    * fmt

    * regen drive manifest

    ---------

    Co-authored-by: decobot <capy@deco.cx>

commit 3831358c844c05a87d9aa7e76e0f7c570348161b
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Tue Dec 2 13:33:55 2025 +0000

    Update version to 0.133.12

commit 4bfe75199415ac0ea514f13db01f32aada86c2a7
Author: L. Sacci <167649583+aka-sacci-ccr@users.noreply.github.com>
Date:   Tue Dec 2 10:33:34 2025 -0300

    fix(vtex): listingPage loader sort (#1491)

    Co-authored-by: decobot <capy@deco.cx>

commit 7fcdb230d16bb173e6a60a8510473d849268d328
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Mon Dec 1 19:01:09 2025 +0000

    Update version to 0.133.11

commit 5887e18b905bad8dc99e32e5206ca1b5e0612e1b
Author: L. Sacci <167649583+aka-sacci-ccr@users.noreply.github.com>
Date:   Mon Dec 1 16:00:55 2025 -0300

    small fix in hub client (#1492)

    * small fix in hub client

    * fix in drive manifest

    ---------

    Co-authored-by: decobot <capy@deco.cx>

commit 67f142f88d13a6201aa33ceb04b0b668ba0df379
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Thu Nov 27 05:00:50 2025 +0000

    Update version to 0.133.10

commit 3f1c594adbd1cbcc69b0590beedcf3c7ed00dae6
Author: Jonas Jesus <jonasjesus@carcara.tech>
Date:   Thu Nov 27 02:00:39 2025 -0300

    feat: add download file action for Google Drive with multiple output formats (#1489)

    - Add DownloadFileParams and DownloadFileResult interfaces in types.ts
    - Add download endpoint to Client interface in client.ts
    - Add error constants for download operations in constant.ts
    - Create new download.ts action with support for 3 output formats:
      * link: Returns webContentLink without actual file download
      * base64: Downloads file and returns as base64 string
      * blob: Downloads file and returns as ArrayBuffer
    - Update mod.ts to include new error handlers

commit 9bf0b5a14cafe7b7f601420c792388abc5c74cd9
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Tue Nov 25 19:21:39 2025 +0000

    Update version to 0.133.9

commit 52100b12c1ab7560f22e6eb9d8e7eda354f15891
Author: Renan Henrique <93907598+RenanHCosta@users.noreply.github.com>
Date:   Tue Nov 25 16:21:24 2025 -0300

    feat: VNDA productListingPage default sorting param (#1481)

    * feat: VNDA productListingPage default sorting param

    * fix: cacheKey sort precedence order

commit 278fcbfdbaa03251803a3d2b57daa6c189f1d716
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Fri Nov 21 13:43:21 2025 +0000

    Update version to 0.133.8

commit 5906a9944cec1dbf19be4f929f4f0bf27d368e3f
Author: L. Sacci <167649583+aka-sacci-ccr@users.noreply.github.com>
Date:   Fri Nov 21 10:43:10 2025 -0300

    fmt (#1485)

    Co-authored-by: decobot <capy@deco.cx>

commit 91ea12e68f0a6d9b551503a2df849e2e70cd916a
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Fri Nov 21 13:38:56 2025 +0000

    Update version to 0.133.7

commit a708ba71f19db9e42d783b1ada195825718b1ea6
Author: Rafael Oliveira <87982042+pandeiro7@users.noreply.github.com>
Date:   Fri Nov 21 10:38:40 2025 -0300

    feat: simulationBehavior productDetails (#1453)

    * feat: simulationBehavior productDetails

    * fix(pdp): simulation behaviour fallback

    ---------

    Co-authored-by: pandeiro7 <dev@tec4udigital.com>
    Co-authored-by: L. Sacci <167649583+aka-sacci-ccr@users.noreply.github.com>

commit 4fae26e3bf468b2fcf87649c9b6bd0b293c4bf4f
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Wed Nov 19 13:01:00 2025 +0000

    Update version to 0.133.6

commit 60cbaf26def11aa2f9a123b6182d63ea43fd1565
Author: Tiago Gimenes <tlgimenes@gmail.com>
Date:   Wed Nov 19 10:00:46 2025 -0300

    chore: add logs to cart (#1482)

    * add logs to cart

    * add logs to cart

commit 8ca84a8b38b40a5ca5bc6092ff171946bc5b923c
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Wed Nov 19 00:29:24 2025 +0000

    Update version to 0.133.5

commit 728a9674a9bce17d92eac560b3613c0a005601c1
Author: Marcos Candeia <marrcooos@gmail.com>
Date:   Tue Nov 18 21:29:12 2025 -0300

    Deduplicate vtex cookie (#1480)

    * Deduplicate vtex cookie

    Signed-off-by: Marcos Candeia <marrcooos@gmail.com>

    * Use cookie with orderFormId on marketing data

    Signed-off-by: Marcos Candeia <marrcooos@gmail.com>

    * Fix orderform fn

    Signed-off-by: Marcos Candeia <marrcooos@gmail.com>

    * Format ts

    Signed-off-by: Marcos Candeia <marrcooos@gmail.com>

    * Adds cache no store

    Signed-off-by: Marcos Candeia <marrcooos@gmail.com>

    ---------

    Signed-off-by: Marcos Candeia <marrcooos@gmail.com>

commit 3b1a4a55ea64b2669c496b7e80ba5b82d4d33578
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Mon Nov 17 15:03:05 2025 +0000

    Update version to 0.133.4

commit e1aa80f4f18d0a9ac919103f4c02964109f6b24d
Author: Jonas Jesus <jonasjesus@carcara.tech>
Date:   Mon Nov 17 12:02:48 2025 -0300

    Error docs (#1478)

    * fix: adjust return errors

    * fix: adjust return type to handle document retrieval errors properly

    * refactor: remove listDocuments and searchDocuments loaders to streamline document handling

    * refactor: update manifest to remove unused loaders and streamline imports

commit 89cd94c4605a8fa3805078a2b10669fc921df9af
Author: decobot <github-actions[bot]@users.noreply.github.com>
Date:   Mon Nov 17 14:13:49 2025 +0000

    Update version to 0.133.3

commit 09732efe362d3334fa03ee5fff69bf6bca33ff81
Author: Jonas Jesus <jonasjesus@carcara.tech>
Date:   Mon Nov 17 11:13:36 2025 -0300

    fix: adjust return errors (#1477)

    * fix: adjust return errors

    * fix: adjust return type to handle document retrieval errors properly
---
 blog/core/handlePosts.ts        | 2 +-
 deno.json                       | 4 ++--
 power-reviews/loaders/review.ts | 8 ++++++++
 3 files changed, 11 insertions(+), 3 deletions(-)

diff --git a/blog/core/handlePosts.ts b/blog/core/handlePosts.ts
index 9d8859d46..0a045687f 100644
--- a/blog/core/handlePosts.ts
+++ b/blog/core/handlePosts.ts
@@ -179,7 +179,7 @@ const filterPosts = (
     return filterRelatedPosts(posts, slug);
   }
 
-  return posts;
+  return term ? filterPostsByTerm(posts, term) : posts;
 };
 
 /**
diff --git a/deno.json b/deno.json
index 2351ea449..dfc0ae9ed 100644
--- a/deno.json
+++ b/deno.json
@@ -69,5 +69,5 @@
       ]
     }
   },
-  "version": "0.133.26"
-}
\ No newline at end of file
+  "version": "0.133.28"
+}
diff --git a/power-reviews/loaders/review.ts b/power-reviews/loaders/review.ts
index ff9cc1f6c..1060821b4 100644
--- a/power-reviews/loaders/review.ts
+++ b/power-reviews/loaders/review.ts
@@ -101,3 +101,11 @@ export default async function getReviewProduct(
     aggregateRating,
   };
 }
+
+export const cache = {
+  maxAge: 60 * 60, // 1 hour
+};
+
+export const cacheKey = (props: Props) => {
+  return JSON.stringify(props);
+};

From 6e50b4bf0c8f9dc9402ae646b3d3a99dc6945bf7 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Thu, 26 Feb 2026 13:42:10 -0400
Subject: [PATCH 83/93] chore: ignore warn for assets.decocache.com domains

---
 website/components/Image.tsx | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/website/components/Image.tsx b/website/components/Image.tsx
index 3b5ca0439..d89074c14 100644
--- a/website/components/Image.tsx
+++ b/website/components/Image.tsx
@@ -217,7 +217,8 @@ export const getOptimizedMediaUrl = (opts: OptimizationOptions) => {
       canShowWarning() &&
       !originalSrc.startsWith(
         "https://ozksgdmyrqcxcwhnbepg.supabase.co/storage",
-      )
+      ) &&
+      !originalSrc.startsWith("https://assets.decocache.com")
     ) {
       console.warn(
         `The following image ${originalSrc} requires automatic image optimization, but it's currently disabled. This may incur in additional costs. Please contact deco.cx for more information.`,

From b05cf9021aed203005ff0f7e47b2c5f97b749b5e Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Thu, 26 Feb 2026 13:44:04 -0400
Subject: [PATCH 84/93] chore: ignore warn for more domains

---
 website/components/Image.tsx | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/website/components/Image.tsx b/website/components/Image.tsx
index d89074c14..dcce160f8 100644
--- a/website/components/Image.tsx
+++ b/website/components/Image.tsx
@@ -178,6 +178,13 @@ const optimizeMagento = (opts: OptimizationOptions) => {
   return url.href;
 };
 
+const DECO_DOMAINS = [
+  "https://ozksgdmyrqcxcwhnbepg.supabase.co/storage",
+  "https://assets.decocache.com",
+  "https://data.decoassets.com",
+  "https://deco-sites-assets.s3",
+];
+
 export const getOptimizedMediaUrl = (opts: OptimizationOptions) => {
   const { originalSrc, width, height, fit, quality } = opts;
 
@@ -215,10 +222,7 @@ export const getOptimizedMediaUrl = (opts: OptimizationOptions) => {
 
     if (
       canShowWarning() &&
-      !originalSrc.startsWith(
-        "https://ozksgdmyrqcxcwhnbepg.supabase.co/storage",
-      ) &&
-      !originalSrc.startsWith("https://assets.decocache.com")
+      !DECO_DOMAINS.some((domain) => originalSrc.startsWith(domain))
     ) {
       console.warn(
         `The following image ${originalSrc} requires automatic image optimization, but it's currently disabled. This may incur in additional costs. Please contact deco.cx for more information.`,

From 086a22a800cbe3a00db64cca009310e956600e4d Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Thu, 26 Feb 2026 13:49:11 -0400
Subject: [PATCH 85/93] docs: document diff between feat/myaccountvtex and main

Add a markdown report with commit/file stats and changed file list to make branch review and handoff easier.

Made-with: Cursor
---
 DIFF_MAIN_feat-myaccountvtex.md | 133 ++++++++++++++++++++++++++++++++
 1 file changed, 133 insertions(+)
 create mode 100644 DIFF_MAIN_feat-myaccountvtex.md

diff --git a/DIFF_MAIN_feat-myaccountvtex.md b/DIFF_MAIN_feat-myaccountvtex.md
new file mode 100644
index 000000000..3163daa0e
--- /dev/null
+++ b/DIFF_MAIN_feat-myaccountvtex.md
@@ -0,0 +1,133 @@
+# Diff da branch vs main
+
+## Escopo
+
+- Branch atual: `feat/myaccountvtex`
+- Base comparada: `main`
+- Merge-base: `c7753c351d58ee313444cf4e10435cb675116b2c`
+- Data da coleta: 2026-02-26
+
+## Resumo rapido
+
+- Commits a frente da `main`: **92**
+- Arquivos alterados: **69**
+- Status: **44 modificados** e **25 novos**
+- Delta total: **109094 insercoes** e **30657 remocoes**
+
+## Onde mudou mais
+
+- `vtex`: 51 arquivos
+- `power-reviews`: 5 arquivos
+- `website`: 5 arquivos
+- `htmx`: 2 arquivos
+- Outros (`commerce`, `linx`, `shopify`, `vnda`, `wake`, `wap`): 1 arquivo cada
+
+## Pontos de maior impacto (linhas alteradas)
+
+> Observacao: grande parte do volume esta em arquivos OpenAPI gerados.
+
+| Arquivo | Delta |
+| --- | ---: |
+| `vtex/utils/openapi/checkout.openapi.json` | +43725 / -0 |
+| `vtex/utils/openapi/vcs.openapi.json` | +14251 / -22819 |
+| `vtex/utils/openapi/checkout.openapi.gen.ts` | +27614 / -0 |
+| `vtex/utils/openapi/logistics.openapi.json` | +12352 / -0 |
+| `vtex/utils/openapi/vcs.openapi.gen.ts` | +243 / -7310 |
+| `vtex/utils/openapi/logistics.openapi.gen.ts` | +6088 / -0 |
+| `vtex/utils/openapi/vtexid.openapi.json` | +2088 / -0 |
+| `vtex/utils/openapi/vtexid.openapi.gen.ts` | +594 / -0 |
+| `vtex/loaders/intelligentSearch/productListingPage.ts` | +259 / -155 |
+| `vtex/manifest.gen.ts` | +216 / -182 |
+
+## Mudancas relevantes fora de OpenAPI
+
+- `vtex/loaders/intelligentSearch/productListingPage.ts`: ajustes grandes na logica de PLP e parametros (pickup point, zip-code, filtros, etc.)
+- `vtex/actions/*` e `vtex/loaders/*`: varias adicoes de endpoints para address, sessions, payments, orders, profile e credentials.
+- `vtex/utils/types.ts`: expansao de tipos e contratos.
+- `website/components/Image.tsx` e `website/components/Picture.tsx`: ajustes no pipeline de imagem/render.
+- `website/components/Seo.tsx` e `website/utils/html.ts`: alteracoes em SEO e tratamento de HTML.
+- `power-reviews/*`: novo loader `productReviews` e adaptacoes em listagem/detalhe.
+
+## Arquivos alterados (name-status)
+
+```text
+M	commerce/types.ts
+M	htmx/mod.ts
+M	htmx/sections/htmx.tsx
+M	linx/loaders/product/listingPage.ts
+M	power-reviews/loaders/productDetailsPage.ts
+M	power-reviews/loaders/productListingPage.ts
+A	power-reviews/loaders/productReviews.ts
+M	power-reviews/manifest.gen.ts
+M	power-reviews/mod.ts
+M	shopify/loaders/ProductListingPage.ts
+M	vnda/loaders/productListingPage.ts
+M	vtex/actions/address/create.ts
+A	vtex/actions/address/createAddress.ts
+A	vtex/actions/address/deleteAddress.ts
+M	vtex/actions/address/update.ts
+A	vtex/actions/address/updateAddress.ts
+M	vtex/actions/cart/updateAttachment.ts
+A	vtex/actions/credentials/validate.ts
+A	vtex/actions/masterdata/updatePartialDocument.ts
+M	vtex/actions/newsletter/updateNewsletterOptIn.ts
+A	vtex/actions/payments/delete.ts
+A	vtex/actions/profile/newsletterProfile.ts
+A	vtex/actions/sessions/delete.ts
+A	vtex/loaders/address/getAddressByZIP.ts
+A	vtex/loaders/address/list.ts
+M	vtex/loaders/cart.ts
+M	vtex/loaders/categories/tree.ts
+M	vtex/loaders/config.ts
+M	vtex/loaders/intelligentSearch/productList.ts
+M	vtex/loaders/intelligentSearch/productListingPage.ts
+A	vtex/loaders/intelligentSearch/searches.ts
+M	vtex/loaders/legacy/productList.ts
+M	vtex/loaders/legacy/productListingPage.ts
+A	vtex/loaders/logistics/listHolidays.ts
+M	vtex/loaders/logistics/listPickupPointsByLocation.ts
+M	vtex/loaders/orders/getById.ts
+M	vtex/loaders/orders/list.ts
+A	vtex/loaders/orders/order.ts
+A	vtex/loaders/payments/info.ts
+A	vtex/loaders/payments/userPayments.ts
+A	vtex/loaders/profile/passwordLastUpdate.ts
+A	vtex/loaders/sessions/info.ts
+M	vtex/loaders/user.ts
+M	vtex/manifest.gen.ts
+M	vtex/middleware.ts
+M	vtex/mod.ts
+M	vtex/utils/client.ts
+M	vtex/utils/intelligentSearch.ts
+M	vtex/utils/legacy.ts
+A	vtex/utils/openapi/checkout.openapi.gen.ts
+A	vtex/utils/openapi/checkout.openapi.json
+A	vtex/utils/openapi/logistics.openapi.gen.ts
+A	vtex/utils/openapi/logistics.openapi.json
+M	vtex/utils/openapi/vcs.openapi.gen.ts
+M	vtex/utils/openapi/vcs.openapi.json
+A	vtex/utils/openapi/vtexid.openapi.gen.ts
+A	vtex/utils/openapi/vtexid.openapi.json
+M	vtex/utils/orderForm.ts
+M	vtex/utils/segment.ts
+A	vtex/utils/simulationBehavior.ts
+M	vtex/utils/types.ts
+M	vtex/utils/vtexId.ts
+M	wake/loaders/productListingPage.ts
+M	wap/loaders/productListingPage.ts
+M	website/components/Events.tsx
+M	website/components/Image.tsx
+M	website/components/Picture.tsx
+M	website/components/Seo.tsx
+M	website/utils/html.ts
+```
+
+## Comandos usados para gerar este documento
+
+```bash
+git rev-list --count main..HEAD
+git merge-base main HEAD
+git diff --shortstat main...HEAD
+git diff --name-status main...HEAD
+git diff --numstat main...HEAD
+```

From 2e6188bd082253e8514d504162bd65cea2e802a0 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Thu, 5 Mar 2026 11:06:37 -0400
Subject: [PATCH 86/93] remove simulation behavior a/b related code

---
 vtex/loaders/intelligentSearch/productList.ts | 17 +--------
 .../intelligentSearch/productListingPage.ts   | 21 ++++-------
 vtex/mod.ts                                   | 16 --------
 vtex/utils/simulationBehavior.ts              | 37 -------------------
 4 files changed, 10 insertions(+), 81 deletions(-)
 delete mode 100644 vtex/utils/simulationBehavior.ts

diff --git a/vtex/loaders/intelligentSearch/productList.ts b/vtex/loaders/intelligentSearch/productList.ts
index e5625136b..b00a942f1 100644
--- a/vtex/loaders/intelligentSearch/productList.ts
+++ b/vtex/loaders/intelligentSearch/productList.ts
@@ -13,7 +13,6 @@ import {
   withSegmentCookie,
 } from "../../utils/segment.ts";
 import { withIsSimilarTo } from "../../utils/similars.ts";
-import { getSkipSimulationBehaviorFromBag } from "../../utils/simulationBehavior.ts";
 import { sortProducts, toProduct } from "../../utils/transform.ts";
 import type {
   Item,
@@ -214,14 +213,8 @@ const loader = async (
   req: Request,
   ctx: AppContext,
 ): Promise<Product[] | null> => {
-  const _props = expandedProps.props ??
+  const props = expandedProps.props ??
     (expandedProps as unknown as Props["props"]);
-  const props = {
-    ..._props,
-    simulationBehavior: getSkipSimulationBehaviorFromBag(ctx)
-      ? "skip"
-      : _props.simulationBehavior || "default",
-  };
   const { vcsDeprecated } = ctx;
   const { url } = req;
   const segment = getSegmentFromBag(ctx);
@@ -319,14 +312,8 @@ export const cacheKey = (
   req: Request,
   ctx: AppContext,
 ) => {
-  const _props = expandedProps.props ??
+  const props = expandedProps.props ??
     (expandedProps as unknown as Props["props"]);
-  const props = {
-    ..._props,
-    simulationBehavior: getSkipSimulationBehaviorFromBag(ctx)
-      ? "skip"
-      : _props.simulationBehavior || "default",
-  };
 
   const url = new URL(req.url);
 
diff --git a/vtex/loaders/intelligentSearch/productListingPage.ts b/vtex/loaders/intelligentSearch/productListingPage.ts
index 3be34eff7..a985bc7e3 100644
--- a/vtex/loaders/intelligentSearch/productListingPage.ts
+++ b/vtex/loaders/intelligentSearch/productListingPage.ts
@@ -24,7 +24,6 @@ import {
   withSegmentCookie,
 } from "../../utils/segment.ts";
 import { withIsSimilarTo } from "../../utils/similars.ts";
-import { getSkipSimulationBehaviorFromBag } from "../../utils/simulationBehavior.ts";
 import { slugify } from "../../utils/slugify.ts";
 import {
   filtersFromURL,
@@ -165,17 +164,15 @@ export interface Props {
   simulationBehavior?: SimulationBehavior;
 }
 
-const searchArgsOf = (props: Props, url: URL, ctx: AppContext) => {
+const searchArgsOf = (props: Props, url: URL) => {
   const hideUnavailableItems = url.searchParams.has("hideUnavailableItems")
     ? url.searchParams.get("hideUnavailableItems") === "true"
     : props.hideUnavailableItems;
-  const simulationBehavior = getSkipSimulationBehaviorFromBag(ctx)
-    ? "skip" as const
-    : (url.searchParams.get("simulationBehavior") as
-      | "skip"
-      | "default"
-      | "only1P") ||
-      props.simulationBehavior || "default";
+  const simulationBehavior = (url.searchParams.get("simulationBehavior") as
+    | "skip"
+    | "default"
+    | "only1P") ||
+    props.simulationBehavior || "default";
   const countFromSearchParams = url.searchParams.get("PS");
   const count = Number(countFromSearchParams ?? props.count ?? 12);
   const query = props.query ?? url.searchParams.get("q") ?? "";
@@ -303,7 +300,6 @@ const loader = async (
     const { selectedFacets: baseSelectedFacets, page, ...args } = searchArgsOf(
       props,
       url,
-      ctx,
     );
     let pathToUse = url.href.replace(url.origin, "");
 
@@ -561,9 +557,8 @@ export const cacheKey = (props: Props, req: Request, ctx: AppContext) => {
     ["segment", segment ?? ""],
     [
       "simulationBehavior",
-      getSkipSimulationBehaviorFromBag(ctx)
-        ? "skip"
-        : props.simulationBehavior || "default",
+      url.searchParams.get("simulationBehavior") || props.simulationBehavior ||
+      "default",
     ],
     [
       "zipcode",
diff --git a/vtex/mod.ts b/vtex/mod.ts
index 01fe627fe..82d55519f 100644
--- a/vtex/mod.ts
+++ b/vtex/mod.ts
@@ -3,10 +3,8 @@ import {
   type AppContext as AC,
   type AppMiddlewareContext as AMC,
   type AppRuntime,
-  asResolved,
   type ManifestOf,
 } from "@deco/deco";
-import { Matcher } from "@deco/deco/blocks";
 import { Suggestion } from "../commerce/types.ts";
 import { Markdown } from "../decohub/components/Markdown.tsx";
 import { createGraphqlClient } from "../utils/graphql.ts";
@@ -89,10 +87,6 @@ export interface Props {
    * @hide true
    */
   platform: "vtex";
-  /**
-   * @title Skip Simulation Behavior
-   */
-  skipSimulationBehavior?: Matcher;
   advancedConfigs?: {
     doNotFetchVariantsForRelatedProducts?: boolean;
     /**
@@ -244,13 +238,3 @@ export const preview = async (props: AppRuntime) => {
     },
   };
 };
-export const onBeforeResolveProps = (props: Props) => {
-  const skipSimulationBehavior = props.skipSimulationBehavior
-    ? asResolved(props.skipSimulationBehavior, false)
-    : undefined;
-
-  return {
-    ...props,
-    skipSimulationBehavior,
-  };
-};
diff --git a/vtex/utils/simulationBehavior.ts b/vtex/utils/simulationBehavior.ts
deleted file mode 100644
index 5ffce3b8d..000000000
--- a/vtex/utils/simulationBehavior.ts
+++ /dev/null
@@ -1,37 +0,0 @@
-import { Resolved } from "@deco/deco";
-import { Matcher } from "@deco/deco/blocks";
-import { AppContext, AppMiddlewareContext } from "../mod.ts";
-
-const SKIP_SIMULATION_BEHAVIOR_KEY = Symbol("skipSimulationBehavior");
-
-export function getSkipSimulationBehaviorFromBag(ctx: AppContext) {
-  return ctx.bag.get(SKIP_SIMULATION_BEHAVIOR_KEY);
-}
-
-export function setSkipSimulationBehaviorToBag(
-  ctx: AppMiddlewareContext,
-  skipSimulationBehavior: boolean,
-) {
-  ctx.bag.set(SKIP_SIMULATION_BEHAVIOR_KEY, skipSimulationBehavior);
-}
-
-export async function resolveSkipSimulationBehavior(
-  ctx: AppMiddlewareContext,
-  req: Request,
-) {
-  const { __resolveType, ...props } = ctx
-    .skipSimulationBehavior as unknown as Resolved<Matcher> || {};
-  if (!__resolveType) {
-    return false;
-  }
-  const skipSimulationBehavior = await ctx.invoke(
-    // @ts-ignore	ignore
-    __resolveType,
-    props,
-  ) as Matcher;
-  return skipSimulationBehavior({
-    request: req,
-    siteId: 0,
-    device: ctx.device,
-  });
-}

From 7dc601480ed1a11d2f24bdb51ed14c51e2f8ad23 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Thu, 5 Mar 2026 11:10:22 -0400
Subject: [PATCH 87/93] update changes document

---
 DIFF_MAIN_feat-myaccountvtex.md | 64 +++++++++++++++++++--------------
 1 file changed, 37 insertions(+), 27 deletions(-)

diff --git a/DIFF_MAIN_feat-myaccountvtex.md b/DIFF_MAIN_feat-myaccountvtex.md
index 3163daa0e..9ed47935f 100644
--- a/DIFF_MAIN_feat-myaccountvtex.md
+++ b/DIFF_MAIN_feat-myaccountvtex.md
@@ -4,53 +4,65 @@
 
 - Branch atual: `feat/myaccountvtex`
 - Base comparada: `main`
-- Merge-base: `c7753c351d58ee313444cf4e10435cb675116b2c`
-- Data da coleta: 2026-02-26
+- Merge-base: `dd694199d49625184876bf6b422a8e886c9d1387`
+- Data da coleta: 2026-03-05
 
 ## Resumo rapido
 
-- Commits a frente da `main`: **92**
-- Arquivos alterados: **69**
-- Status: **44 modificados** e **25 novos**
-- Delta total: **109094 insercoes** e **30657 remocoes**
+- Commits a frente da `main`: **96**
+- Arquivos alterados: **70**
+- Status: **45 modificados** e **25 novos**
+- Delta total: **109137 insercoes** e **30651 remocoes**
 
 ## Onde mudou mais
 
-- `vtex`: 51 arquivos
+- `vtex`: 49 arquivos
 - `power-reviews`: 5 arquivos
 - `website`: 5 arquivos
+- `blog`: 2 arquivos
 - `htmx`: 2 arquivos
 - Outros (`commerce`, `linx`, `shopify`, `vnda`, `wake`, `wap`): 1 arquivo cada
+- Raiz do repo: 1 arquivo (`DIFF_MAIN_feat-myaccountvtex.md`)
 
 ## Pontos de maior impacto (linhas alteradas)
 
 > Observacao: grande parte do volume esta em arquivos OpenAPI gerados.
 
-| Arquivo | Delta |
-| --- | ---: |
-| `vtex/utils/openapi/checkout.openapi.json` | +43725 / -0 |
-| `vtex/utils/openapi/vcs.openapi.json` | +14251 / -22819 |
-| `vtex/utils/openapi/checkout.openapi.gen.ts` | +27614 / -0 |
-| `vtex/utils/openapi/logistics.openapi.json` | +12352 / -0 |
-| `vtex/utils/openapi/vcs.openapi.gen.ts` | +243 / -7310 |
-| `vtex/utils/openapi/logistics.openapi.gen.ts` | +6088 / -0 |
-| `vtex/utils/openapi/vtexid.openapi.json` | +2088 / -0 |
-| `vtex/utils/openapi/vtexid.openapi.gen.ts` | +594 / -0 |
-| `vtex/loaders/intelligentSearch/productListingPage.ts` | +259 / -155 |
-| `vtex/manifest.gen.ts` | +216 / -182 |
+| Arquivo                                                |           Delta |
+| ------------------------------------------------------ | --------------: |
+| `vtex/utils/openapi/checkout.openapi.json`             |     +43725 / -0 |
+| `vtex/utils/openapi/vcs.openapi.json`                  | +14251 / -22819 |
+| `vtex/utils/openapi/checkout.openapi.gen.ts`           |     +27614 / -0 |
+| `vtex/utils/openapi/logistics.openapi.json`            |     +12352 / -0 |
+| `vtex/utils/openapi/vcs.openapi.gen.ts`                |    +243 / -7310 |
+| `vtex/utils/openapi/logistics.openapi.gen.ts`          |      +6088 / -0 |
+| `vtex/utils/openapi/vtexid.openapi.json`               |      +2088 / -0 |
+| `vtex/utils/openapi/vtexid.openapi.gen.ts`             |       +594 / -0 |
+| `vtex/loaders/intelligentSearch/productListingPage.ts` |     +250 / -151 |
+| `vtex/manifest.gen.ts`                                 |     +216 / -182 |
+| `vtex/utils/types.ts`                                  |       +205 / -5 |
 
 ## Mudancas relevantes fora de OpenAPI
 
-- `vtex/loaders/intelligentSearch/productListingPage.ts`: ajustes grandes na logica de PLP e parametros (pickup point, zip-code, filtros, etc.)
-- `vtex/actions/*` e `vtex/loaders/*`: varias adicoes de endpoints para address, sessions, payments, orders, profile e credentials.
-- `vtex/utils/types.ts`: expansao de tipos e contratos.
-- `website/components/Image.tsx` e `website/components/Picture.tsx`: ajustes no pipeline de imagem/render.
-- `website/components/Seo.tsx` e `website/utils/html.ts`: alteracoes em SEO e tratamento de HTML.
-- `power-reviews/*`: novo loader `productReviews` e adaptacoes em listagem/detalhe.
+- `vtex/loaders/intelligentSearch/productListingPage.ts`: ajustes grandes na
+  logica de PLP e parametros (pickup point, zip-code, filtros, etc.).
+- `vtex/actions/*` e `vtex/loaders/*`: adicao/expansao de endpoints para
+  address, sessions, payments, orders, profile e credentials.
+- `vtex/utils/types.ts`: expansao de contratos e tipos.
+- `website/components/Image.tsx` e `website/components/Picture.tsx`: ajustes no
+  pipeline de imagem/render.
+- `website/components/Seo.tsx` e `website/utils/html.ts`: alteracoes em SEO e
+  tratamento de HTML.
+- `power-reviews/*`: novo loader `productReviews` e adaptacoes em
+  listagem/detalhe.
+- `blog/*`: ajustes em `handlePosts` e `Template`.
 
 ## Arquivos alterados (name-status)
 
 ```text
+A	DIFF_MAIN_feat-myaccountvtex.md
+M	blog/core/handlePosts.ts
+M	blog/sections/Template.tsx
 M	commerce/types.ts
 M	htmx/mod.ts
 M	htmx/sections/htmx.tsx
@@ -79,7 +91,6 @@ A	vtex/loaders/address/list.ts
 M	vtex/loaders/cart.ts
 M	vtex/loaders/categories/tree.ts
 M	vtex/loaders/config.ts
-M	vtex/loaders/intelligentSearch/productList.ts
 M	vtex/loaders/intelligentSearch/productListingPage.ts
 A	vtex/loaders/intelligentSearch/searches.ts
 M	vtex/loaders/legacy/productList.ts
@@ -110,7 +121,6 @@ A	vtex/utils/openapi/vtexid.openapi.gen.ts
 A	vtex/utils/openapi/vtexid.openapi.json
 M	vtex/utils/orderForm.ts
 M	vtex/utils/segment.ts
-A	vtex/utils/simulationBehavior.ts
 M	vtex/utils/types.ts
 M	vtex/utils/vtexId.ts
 M	wake/loaders/productListingPage.ts

From 38058e82a47713bcb7022b7d0a56a2a923d96709 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Thu, 5 Mar 2026 11:27:57 -0400
Subject: [PATCH 88/93] Enhance simulation behavior handling across intelligent
 search loaders. Introduce simulationBehavior property in Props interface and
 update loaders to utilize advancedConfigs for default values.

---
 .../intelligentSearch/productDetailsPage.ts   |  6 +++--
 vtex/loaders/intelligentSearch/productList.ts |  6 +++++
 .../intelligentSearch/productListingPage.ts   |  5 ++++
 vtex/loaders/intelligentSearch/suggestions.ts | 26 ++++++++++++++++---
 vtex/mod.ts                                   |  8 +++++-
 5 files changed, 45 insertions(+), 6 deletions(-)

diff --git a/vtex/loaders/intelligentSearch/productDetailsPage.ts b/vtex/loaders/intelligentSearch/productDetailsPage.ts
index 0e593f551..e3bc36f4e 100644
--- a/vtex/loaders/intelligentSearch/productDetailsPage.ts
+++ b/vtex/loaders/intelligentSearch/productDetailsPage.ts
@@ -115,7 +115,8 @@ const loader = async (
     query,
     count: 1,
     locale,
-    simulationBehavior: props.simulationBehavior ?? "default",
+    simulationBehavior: props.simulationBehavior ??
+      ctx.advancedConfigs?.simulationBehavior ?? "default",
   });
   const { products: [product] } = await vcsDeprecated
     ["GET /api/io/_v/api/intelligent-search/product_search/*facets"]({
@@ -136,7 +137,8 @@ const loader = async (
     const params = withDefaultParams({
       query: `sku:${sku.kitItems.join(";")}`,
       count: sku.kitItems.length,
-      simulationBehavior: props.simulationBehavior ?? "default",
+      simulationBehavior: props.simulationBehavior ??
+        ctx.advancedConfigs?.simulationBehavior ?? "default",
     });
 
     const result = await vcsDeprecated
diff --git a/vtex/loaders/intelligentSearch/productList.ts b/vtex/loaders/intelligentSearch/productList.ts
index b00a942f1..022561347 100644
--- a/vtex/loaders/intelligentSearch/productList.ts
+++ b/vtex/loaders/intelligentSearch/productList.ts
@@ -221,6 +221,9 @@ const loader = async (
   const locale = segment?.payload?.cultureInfo ??
     ctx.defaultSegment?.cultureInfo ?? "pt-BR";
 
+  props.simulationBehavior = props.simulationBehavior ||
+    ctx.advancedConfigs?.simulationBehavior || "default";
+
   const { selectedFacets, ...args } = fromProps({ props });
   const params = withDefaultParams({ ...args, locale });
   const facets = withDefaultFacets(selectedFacets, ctx);
@@ -315,6 +318,9 @@ export const cacheKey = (
   const props = expandedProps.props ??
     (expandedProps as unknown as Props["props"]);
 
+  props.simulationBehavior = props.simulationBehavior ||
+    ctx.advancedConfigs?.simulationBehavior || "default";
+
   const url = new URL(req.url);
 
   const searchTerm = url.searchParams.get("q");
diff --git a/vtex/loaders/intelligentSearch/productListingPage.ts b/vtex/loaders/intelligentSearch/productListingPage.ts
index a985bc7e3..946b981ae 100644
--- a/vtex/loaders/intelligentSearch/productListingPage.ts
+++ b/vtex/loaders/intelligentSearch/productListingPage.ts
@@ -297,6 +297,10 @@ const loader = async (
     span?.setAttribute("url", url.href);
     const segment = getSegmentFromBag(ctx);
     const currentPageoffset = props.pageOffset ?? 1;
+
+    props.simulationBehavior = props.simulationBehavior ||
+      ctx.advancedConfigs?.simulationBehavior || "default";
+
     const { selectedFacets: baseSelectedFacets, page, ...args } = searchArgsOf(
       props,
       url,
@@ -558,6 +562,7 @@ export const cacheKey = (props: Props, req: Request, ctx: AppContext) => {
     [
       "simulationBehavior",
       url.searchParams.get("simulationBehavior") || props.simulationBehavior ||
+      ctx.advancedConfigs?.simulationBehavior ||
       "default",
     ],
     [
diff --git a/vtex/loaders/intelligentSearch/suggestions.ts b/vtex/loaders/intelligentSearch/suggestions.ts
index 7530f85d6..db6fe3c76 100644
--- a/vtex/loaders/intelligentSearch/suggestions.ts
+++ b/vtex/loaders/intelligentSearch/suggestions.ts
@@ -13,7 +13,10 @@ import {
 } from "../../utils/segment.ts";
 import { withIsSimilarTo } from "../../utils/similars.ts";
 import { toProduct } from "../../utils/transform.ts";
-import type { AdvancedLoaderConfig } from "../../utils/types.ts";
+import type {
+  AdvancedLoaderConfig,
+  SimulationBehavior,
+} from "../../utils/types.ts";
 
 export interface Props {
   query?: string;
@@ -33,6 +36,11 @@ export interface Props {
    * @description Further change loader behaviour
    */
   advancedConfigs?: AdvancedLoaderConfig;
+  /**
+   * @title Simulation Behavior
+   * @description Defines the simulation behavior.
+   */
+  simulationBehavior?: SimulationBehavior;
 }
 
 /**
@@ -69,7 +77,13 @@ const loaders = async (
 
   const productSearch = () => {
     const facets = withDefaultFacets([], ctx);
-    const params = withDefaultParams({ query, count: count ?? 4, locale });
+    const params = withDefaultParams({
+      query,
+      count: count ?? 4,
+      locale,
+      simulationBehavior: props.simulationBehavior ??
+        ctx.advancedConfigs?.simulationBehavior ?? "default",
+    });
 
     return vcsDeprecated
       ["GET /api/io/_v/api/intelligent-search/product_search/*facets"]({
@@ -110,7 +124,13 @@ export const cacheKey = (props: Props, _req: Request, ctx: AppContext) => {
   const segment = ctx.advancedConfigs?.removeUTMFromCacheKey
     ? getSegmentCacheKeyWithoutUTM(ctx)
     : getSegmentFromBag(ctx)?.token;
-  return `suggestions-${props.query ?? ""}-${props.count ?? 4}-${segment}`;
+
+  const query = props.query ?? "";
+  const count = props.count ?? 4;
+  const simulationBehavior = props.simulationBehavior ??
+    ctx.advancedConfigs?.simulationBehavior ?? "default";
+
+  return `suggestions-${query}-${count}-${simulationBehavior}-${segment}`;
 };
 
 export default loaders;
diff --git a/vtex/mod.ts b/vtex/mod.ts
index 82d55519f..7d741dc2d 100644
--- a/vtex/mod.ts
+++ b/vtex/mod.ts
@@ -21,7 +21,7 @@ import { OpenAPI as API } from "./utils/openapi/api.openapi.gen.ts";
 import { OpenAPI as MY } from "./utils/openapi/my.openapi.gen.ts";
 import { OpenAPI as VPAY } from "./utils/openapi/payments.openapi.gen.ts";
 import { OpenAPI as SUB } from "./utils/openapi/subscriptions.openapi.gen.ts";
-import { VCS } from "./utils/types.ts";
+import { SimulationBehavior, VCS } from "./utils/types.ts";
 
 import { Segment } from "./utils/types.ts";
 
@@ -94,6 +94,12 @@ export interface Props {
      * @description Remove UTM from cache key to prevent cache fragmentation.
      */
     removeUTMFromCacheKey?: boolean;
+    /**
+     * @title Simulation Behavior
+     * @description Defines the default simulation behavior value.
+     * @default default
+     */
+    simulationBehavior?: SimulationBehavior;
   };
 
   /**

From 9b830dabf3141eb9652ebc46ac4593dc872a05f5 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Tue, 10 Mar 2026 16:20:00 -0400
Subject: [PATCH 89/93] refactor: remove deprecated apis from vtex app

---
 commerce/types.ts                          |  35 --
 vtex/actions/address/createAddress.ts      |  67 ----
 vtex/actions/address/deleteAddress.ts      |  58 ---
 vtex/actions/address/updateAddress.ts      |  92 -----
 vtex/actions/payments/delete.ts            |  39 --
 vtex/actions/profile/newsletterProfile.ts  |  60 ---
 vtex/loaders/address/getAddressByZIP.ts    |  59 ---
 vtex/loaders/address/list.ts               |  86 -----
 vtex/loaders/orders/order.ts               |  51 ---
 vtex/loaders/payments/info.ts              |  55 ---
 vtex/loaders/payments/userPayments.ts      |  53 ---
 vtex/loaders/profile/passwordLastUpdate.ts |  36 --
 vtex/loaders/sessions/info.ts              |  68 ----
 vtex/loaders/user.ts                       |  19 +-
 vtex/manifest.gen.ts                       | 408 ++++++++++-----------
 15 files changed, 196 insertions(+), 990 deletions(-)
 delete mode 100644 vtex/actions/address/createAddress.ts
 delete mode 100644 vtex/actions/address/deleteAddress.ts
 delete mode 100644 vtex/actions/address/updateAddress.ts
 delete mode 100644 vtex/actions/payments/delete.ts
 delete mode 100644 vtex/actions/profile/newsletterProfile.ts
 delete mode 100644 vtex/loaders/address/getAddressByZIP.ts
 delete mode 100644 vtex/loaders/address/list.ts
 delete mode 100644 vtex/loaders/orders/order.ts
 delete mode 100644 vtex/loaders/payments/info.ts
 delete mode 100644 vtex/loaders/payments/userPayments.ts
 delete mode 100644 vtex/loaders/profile/passwordLastUpdate.ts
 delete mode 100644 vtex/loaders/sessions/info.ts

diff --git a/commerce/types.ts b/commerce/types.ts
index 16012d88f..05fa5d060 100644
--- a/commerce/types.ts
+++ b/commerce/types.ts
@@ -415,23 +415,6 @@ export interface Person extends Omit<Thing, "@type"> {
   telephone?: string;
   /** The birth date of the person. */
   birthDate?: string;
-  /** User's corporate name */
-  corporateName?: string;
-  /** User's corporate document */
-  corporateDocument?: string;
-  /** User's corporate trade name */
-  tradeName?: string;
-  /** User's business phone */
-  businessPhone?: string;
-  /** Whether the user is a corporation or not */
-  isCorporate?: boolean;
-  /** Custom fields */
-  customFields?: CustomFields[];
-}
-
-interface CustomFields {
-  key: string;
-  value: string;
 }
 
 // NON SCHEMA.ORG Compliant. Should be removed ASAP
@@ -622,24 +605,6 @@ export interface PostalAddress extends Omit<ContactPoint, "@type"> {
   longitude?: number;
 }
 
-export interface PostalAddressVTEX extends Omit<ContactPoint, "@type"> {
-  "@type": "PostalAddress";
-  /** The country. For example, USA. You can also provide the two-letter ISO 3166-1 alpha-2 country code. */
-  addressCountry?: string;
-  /** The locality in which the street address is, and which is in the region. For example, Mountain View. */
-  addressLocality?: string;
-  /** The region in which the locality is, and which is in the country. For example, California. */
-  addressRegion?: string;
-  /** The postal code. For example, 94043. */
-  postalCode?: string;
-  /** The street address. For example, 1600 Amphitheatre Pkwy. */
-  streetAddress?: string;
-  receiverName: string | null;
-  addressName?: string;
-  complement: string | null;
-  addressId: string;
-}
-
 export interface LocationFeatureSpecification
   extends Omit<PropertyValue, "@type"> {
   "@type": "LocationFeatureSpecification";
diff --git a/vtex/actions/address/createAddress.ts b/vtex/actions/address/createAddress.ts
deleted file mode 100644
index af849c53a..000000000
--- a/vtex/actions/address/createAddress.ts
+++ /dev/null
@@ -1,67 +0,0 @@
-import { AppContext } from "../../mod.ts";
-import { parseCookie } from "../../utils/vtexId.ts";
-
-interface AddressInput {
-  name?: string;
-  addressName: string;
-  addressType?: string;
-  city?: string;
-  complement?: string;
-  country?: string;
-  geoCoordinates?: number[];
-  neighborhood?: string;
-  number?: string;
-  postalCode?: string;
-  receiverName?: string;
-  reference?: string;
-  state?: string;
-  street?: string;
-}
-
-interface SavedAddress {
-  id: string;
-  cacheId: string;
-}
-
-async function action(
-  props: AddressInput,
-  req: Request,
-  ctx: AppContext,
-): Promise<
-  | SavedAddress
-  | null
-> {
-  const { io } = ctx;
-  const { cookie } = parseCookie(req.headers, ctx.account);
-
-  const mutation = `
-  mutation SaveAddress($address: AddressInput!) {
-    saveAddress(address: $address) @context(provider: "vtex.store-graphql") {
-      id
-      cacheId
-    }
-  }`;
-
-  try {
-    const { saveAddress: savedAddress } = await io.query<
-      { saveAddress: SavedAddress },
-      { address: AddressInput }
-    >(
-      {
-        query: mutation,
-        operationName: "SaveAddress",
-        variables: {
-          address: props,
-        },
-      },
-      { headers: { cookie } },
-    );
-
-    return savedAddress;
-  } catch (error) {
-    console.error("Error saving address:", error);
-    return null;
-  }
-}
-
-export default action;
diff --git a/vtex/actions/address/deleteAddress.ts b/vtex/actions/address/deleteAddress.ts
deleted file mode 100644
index 760afd133..000000000
--- a/vtex/actions/address/deleteAddress.ts
+++ /dev/null
@@ -1,58 +0,0 @@
-import { AppContext } from "../../mod.ts";
-import { parseCookie } from "../../utils/vtexId.ts";
-
-interface DeleteAddress {
-  addressId: string;
-}
-
-interface AddressInput {
-  addressId: string;
-}
-
-async function action(
-  { addressId }: AddressInput,
-  req: Request,
-  ctx: AppContext,
-) {
-  const { io } = ctx;
-  const { cookie } = parseCookie(req.headers, ctx.account);
-
-  const mutation = `
-  mutation DeleteAddress($addressId: String) {
-    deleteAddress(id: $addressId) {
-      cacheId
-      addresses: address {
-        addressId: id
-        addressType
-        addressName
-        city
-        complement
-        country
-        neighborhood
-        number
-        postalCode
-        geoCoordinates
-        receiverName
-        reference
-        state
-        street
-      }
-    }
-  }`;
-
-  try {
-    return await io.query<DeleteAddress, { addressId: string }>(
-      {
-        query: mutation,
-        operationName: "DeleteAddress",
-        variables: { addressId },
-      },
-      { headers: { cookie } },
-    );
-  } catch (error) {
-    console.error("Error deleting address:", error);
-    return null;
-  }
-}
-
-export default action;
diff --git a/vtex/actions/address/updateAddress.ts b/vtex/actions/address/updateAddress.ts
deleted file mode 100644
index 136ed41bc..000000000
--- a/vtex/actions/address/updateAddress.ts
+++ /dev/null
@@ -1,92 +0,0 @@
-import { PostalAddressVTEX } from "../../../commerce/types.ts";
-import { AppContext } from "../../mod.ts";
-import { parseCookie } from "../../utils/vtexId.ts";
-
-interface Address {
-  name?: string;
-  addressName?: string;
-  addressType?: string;
-  city?: string;
-  complement: string | null;
-  country?: string;
-  geoCoordinates?: number[];
-  neighborhood?: string;
-  number?: string;
-  postalCode?: string;
-  receiverName: string | null;
-  reference?: string;
-  state?: string;
-  street?: string;
-  addressId: string;
-}
-
-async function action(
-  props: Address,
-  req: Request,
-  ctx: AppContext,
-): Promise<
-  | PostalAddressVTEX
-  | null
-> {
-  const { io } = ctx;
-  const { cookie } = parseCookie(req.headers, ctx.account);
-  const { addressId, ...addressFields } = props;
-
-  const mutation = `
-    mutation UpdateAddress($addressId: String!, $addressFields: AddressInput) {
-      updateAddress(id: $addressId, fields: $addressFields)
-        @context(provider: "vtex.store-graphql") {
-        cacheId
-        addresses: address {
-          addressId: id
-          addressType
-          addressName
-          city
-          complement
-          country
-          neighborhood
-          number
-          postalCode
-          geoCoordinates
-          receiverName
-          reference
-          state
-          street
-        }
-      }
-    }
-  `;
-
-  try {
-    const { updateAddress: updatedAddress } = await io.query<
-      { updateAddress: Address },
-      { addressId: string; addressFields: Omit<Address, "addressId"> }
-    >(
-      {
-        query: mutation,
-        operationName: "UpdateAddress",
-        variables: {
-          addressId,
-          addressFields,
-        },
-      },
-      { headers: { cookie } },
-    );
-
-    return {
-      "@type": "PostalAddress",
-      addressCountry: updatedAddress?.country,
-      addressLocality: updatedAddress?.city,
-      addressRegion: updatedAddress?.state,
-      postalCode: updatedAddress?.postalCode,
-      streetAddress: updatedAddress?.street,
-      receiverName: updatedAddress?.receiverName,
-      complement: updatedAddress?.complement,
-      addressId: updatedAddress?.addressId,
-    };
-  } catch (error) {
-    console.error("Error updating address:", error);
-    return null;
-  }
-}
-export default action;
diff --git a/vtex/actions/payments/delete.ts b/vtex/actions/payments/delete.ts
deleted file mode 100644
index 341ecee37..000000000
--- a/vtex/actions/payments/delete.ts
+++ /dev/null
@@ -1,39 +0,0 @@
-import { AppContext } from "../../mod.ts";
-import { parseCookie } from "../../utils/vtexId.ts";
-
-export interface DeleteCard {
-  deletePaymentToken: boolean;
-}
-
-interface Props {
-  id: string;
-}
-
-async function loader(
-  { id }: Props,
-  req: Request,
-  ctx: AppContext,
-): Promise<DeleteCard | null> {
-  const { io } = ctx;
-  const { cookie, payload } = parseCookie(req.headers, ctx.account);
-
-  if (!payload?.sub || !payload?.userId) {
-    return null;
-  }
-
-  const mutation = `mutation DeleteCreditCardToken($tokenId: ID!) {
-    deletePaymentToken(tokenId: $tokenId) @context(provider: "vtex.my-cards-graphql@2.x")
-  }`;
-
-  try {
-    return await io.query<DeleteCard, { tokenId: string }>({
-      query: mutation,
-      variables: { tokenId: id },
-    }, { headers: { cookie } });
-  } catch (e) {
-    console.error(e);
-    return null;
-  }
-}
-
-export default loader;
diff --git a/vtex/actions/profile/newsletterProfile.ts b/vtex/actions/profile/newsletterProfile.ts
deleted file mode 100644
index 1f14b6403..000000000
--- a/vtex/actions/profile/newsletterProfile.ts
+++ /dev/null
@@ -1,60 +0,0 @@
-import { AppContext } from "../../mod.ts";
-import { parseCookie } from "../../utils/vtexId.ts";
-
-interface NewsletterInput {
-  email: string;
-  isNewsletterOptIn: boolean;
-}
-
-const newsletterProfile = async (
-  props: NewsletterInput,
-  req: Request,
-  ctx: AppContext,
-): Promise<boolean | null> => {
-  const { io } = ctx;
-  const { cookie } = parseCookie(req.headers, ctx.account);
-
-  if (!props?.email) {
-    console.error("User profile not found or email is missing:", props.email);
-    return null;
-  }
-
-  const mutation = `
-    mutation SubscribeNewsletter($email: String!, $isNewsletterOptIn: Boolean!) {
-      subscribeNewsletter(email: $email, isNewsletterOptIn: $isNewsletterOptIn) 
-      @context(provider: "vtex.store-graphql@2.x")
-    }
-  `;
-
-  const variables = {
-    email: props.email,
-    isNewsletterOptIn: props.isNewsletterOptIn,
-  };
-
-  try {
-    await io.query<{ subscribeNewsletter: boolean }, unknown>(
-      {
-        query: mutation,
-        operationName: "SubscribeNewsletter",
-        variables,
-      },
-      {
-        headers: {
-          cookie,
-        },
-      },
-    );
-
-    const result = await ctx.invoke("vtex/loaders/user.ts");
-    const newsletterField = result?.customFields?.find((field) =>
-      field.key === "isNewsletterOptIn"
-    );
-
-    return newsletterField?.value === "true";
-  } catch (error) {
-    console.error("Error subscribing to newsletter:", error);
-    return null;
-  }
-};
-
-export default newsletterProfile;
diff --git a/vtex/loaders/address/getAddressByZIP.ts b/vtex/loaders/address/getAddressByZIP.ts
deleted file mode 100644
index 0eac4ac00..000000000
--- a/vtex/loaders/address/getAddressByZIP.ts
+++ /dev/null
@@ -1,59 +0,0 @@
-import { AppContext } from "../../mod.ts";
-
-interface Props {
-  /**
-   * @description User country code. Ex: USA
-   */
-  countryCode: string;
-  /**
-   * @description User postal code.
-   */
-  postalCode: string;
-}
-
-interface AddressByPostalCode {
-  postalCode: string;
-  city: string;
-  state: string;
-  country: string;
-  street: string | null;
-  number: string | null;
-  neighborhood: string | null;
-  complement: string | null;
-  reference: string | null;
-  geoCoordinates: number[] | null;
-}
-
-export default async function loader(
-  props: Props,
-  _req: Request,
-  ctx: AppContext,
-): Promise<AddressByPostalCode> {
-  const { countryCode, postalCode } = props;
-  const { vcs } = ctx;
-
-  try {
-    const addressByPostalCode = await vcs
-      ["GET /api/checkout/pub/postal-code/:countryCode/:postalCode"]({
-        countryCode,
-        postalCode,
-      })
-      .then((r) => r.json()) as AddressByPostalCode;
-
-    return addressByPostalCode;
-  } catch (error) {
-    console.error(error);
-    return {
-      postalCode: "",
-      city: "",
-      state: "",
-      country: "",
-      street: null,
-      number: null,
-      neighborhood: null,
-      complement: null,
-      reference: null,
-      geoCoordinates: [],
-    };
-  }
-}
diff --git a/vtex/loaders/address/list.ts b/vtex/loaders/address/list.ts
deleted file mode 100644
index eaadbba7b..000000000
--- a/vtex/loaders/address/list.ts
+++ /dev/null
@@ -1,86 +0,0 @@
-import { Address } from "../../utils/types.ts";
-import { PostalAddressVTEX } from "../../../commerce/types.ts";
-import { parseCookie } from "../../utils/vtexId.ts";
-import { AppContext } from "../../mod.ts";
-
-export interface User {
-  id: string;
-  userId: string;
-  email: string;
-  firstName?: string;
-  lastName?: string;
-  profilePicture?: string;
-  gender?: string;
-  document?: string;
-  homePhone?: string;
-  birthDate?: string;
-  corporateDocument?: string;
-  corporateName?: string;
-  tradeName?: string;
-  businessPhone?: string;
-  isCorporate?: boolean;
-  customFields?: { key: string; value: string }[];
-}
-
-async function loader(
-  _props: unknown,
-  req: Request,
-  ctx: AppContext,
-): Promise<
-  PostalAddressVTEX[] | null
-> {
-  const { io } = ctx;
-  const { cookie, payload } = parseCookie(req.headers, ctx.account);
-
-  if (!payload?.sub || !payload?.userId) {
-    return null;
-  }
-
-  const query = `query Addresses @context(scope: "private") {
-    profile {
-      cacheId
-      addresses: address {
-        addressId: id
-        addressType
-        addressName
-        city
-        complement
-        country
-        neighborhood
-        number
-        postalCode
-        geoCoordinates
-        receiverName
-        state
-        street
-      }
-    }
-  }`;
-
-  try {
-    const { profile } = await io.query<
-      { profile: { addresses: Address[] } },
-      null
-    >(
-      { query },
-      { headers: { cookie } },
-    );
-
-    return profile?.addresses?.map((address) => ({
-      "@type": "PostalAddress",
-      addressCountry: address?.country,
-      addressLocality: address?.city,
-      addressRegion: address?.state,
-      postalCode: address?.postalCode,
-      streetAddress: address?.street,
-      receiverName: address?.receiverName,
-      addressName: address?.addressName,
-      complement: address?.complement,
-      addressId: address?.addressId,
-    }));
-  } catch (_) {
-    return null;
-  }
-}
-
-export default loader;
diff --git a/vtex/loaders/orders/order.ts b/vtex/loaders/orders/order.ts
deleted file mode 100644
index 6000037cf..000000000
--- a/vtex/loaders/orders/order.ts
+++ /dev/null
@@ -1,51 +0,0 @@
-import { HttpError } from "@deco/deco";
-import { RequestURLParam } from "../../../website/functions/requestToParam.ts";
-import { AppContext } from "../../mod.ts";
-import { Userorderdetails } from "../../utils/openapi/vcs.openapi.gen.ts";
-import { parseCookie } from "../../utils/vtexId.ts";
-
-export interface Props {
-  slug: RequestURLParam;
-}
-
-export default async function loader(
-  props: Props,
-  req: Request,
-  ctx: AppContext,
-): Promise<Userorderdetails | null> {
-  const { vcs } = ctx;
-  const { cookie } = parseCookie(req.headers, ctx.account);
-
-  const { slug } = props;
-
-  const user = await ctx.invoke.vtex.loaders.user();
-  if (!user?.email) {
-    throw new HttpError(new Response("Unauthorized", { status: 403 }));
-  }
-
-  const response = await vcs["GET /api/oms/user/orders/:orderId"](
-    {
-      orderId: slug.includes("-") ? slug : slug + "-01",
-      clientEmail: user.email,
-    },
-    {
-      headers: {
-        cookie,
-      },
-    },
-  );
-
-  if (!response.ok) {
-    throw new Error(
-      `Failed to get order: ${response.status} ${response.statusText}`,
-    );
-  }
-
-  const order = await response.json();
-
-  if (order.clientProfileData?.email !== user.email) {
-    throw new HttpError(new Response("Unauthorized", { status: 403 }));
-  }
-
-  return order;
-}
diff --git a/vtex/loaders/payments/info.ts b/vtex/loaders/payments/info.ts
deleted file mode 100644
index 3390d23fd..000000000
--- a/vtex/loaders/payments/info.ts
+++ /dev/null
@@ -1,55 +0,0 @@
-import { AppContext } from "../../mod.ts";
-import { parseCookie } from "../../utils/vtexId.ts";
-
-const query = `query getPaymentSystems {
-  paymentSystems {
-    name
-    groupName
-    requiresDocument
-    displayDocument
-    validator {
-      regex
-      mask
-      cardCodeMask
-      cardCodeRegex
-    }
-  }
-}`;
-
-export interface PaymentSystem {
-  name: string;
-  groupName: string;
-  requiresDocument: boolean;
-  displayDocument: boolean;
-  validator: {
-    regex: string | null;
-    mask: string | null;
-    cardCodeMask: string | null;
-    cardCodeRegex: string | null;
-  };
-}
-
-export default async function loader(
-  _props: unknown,
-  req: Request,
-  ctx: AppContext,
-) {
-  const { io } = ctx;
-  const { cookie, payload } = parseCookie(req.headers, ctx.account);
-
-  if (!payload?.sub || !payload?.userId) {
-    return null;
-  }
-
-  try {
-    const data = await io.query<{ paymentSystems: PaymentSystem[] }, null>(
-      { query },
-      { headers: { cookie } },
-    );
-
-    return data.paymentSystems;
-  } catch (e) {
-    console.error(e);
-    return null;
-  }
-}
diff --git a/vtex/loaders/payments/userPayments.ts b/vtex/loaders/payments/userPayments.ts
deleted file mode 100644
index 256b84fe4..000000000
--- a/vtex/loaders/payments/userPayments.ts
+++ /dev/null
@@ -1,53 +0,0 @@
-import { AppContext } from "../../mod.ts";
-import { parseCookie } from "../../utils/vtexId.ts";
-
-export interface Payment {
-  accountStatus: string | null;
-  cardNumber: string;
-  expirationDate: string;
-  id: string;
-  isExpired: boolean;
-  paymentSystem: string;
-  paymentSystemName: string;
-}
-
-async function loader(
-  _props: unknown,
-  req: Request,
-  ctx: AppContext,
-): Promise<Payment[] | null> {
-  const { io } = ctx;
-  const { cookie, payload } = parseCookie(req.headers, ctx.account);
-
-  if (!payload?.sub || !payload?.userId) {
-    return null;
-  }
-
-  const query = `query getUserPayments {
-      profile {
-        payments {
-          accountStatus
-          cardNumber
-          expirationDate
-          id
-          isExpired
-          paymentSystem
-          paymentSystemName
-        }
-      }
-  }`;
-
-  try {
-    const data = await io.query<{ profile: { payments: Payment[] } }, null>(
-      { query },
-      { headers: { cookie } },
-    );
-
-    return data.profile.payments;
-  } catch (e) {
-    console.error(e);
-    return null;
-  }
-}
-
-export default loader;
diff --git a/vtex/loaders/profile/passwordLastUpdate.ts b/vtex/loaders/profile/passwordLastUpdate.ts
deleted file mode 100644
index f7ca8adc4..000000000
--- a/vtex/loaders/profile/passwordLastUpdate.ts
+++ /dev/null
@@ -1,36 +0,0 @@
-import { AppContext } from "../../mod.ts";
-import { parseCookie } from "../../utils/vtexId.ts";
-
-export interface ProfilePassword {
-  passwordLastUpdate?: PasswordLastUpdate;
-}
-
-export type PasswordLastUpdate = string | null;
-
-async function loader(
-  _props: unknown,
-  req: Request,
-  ctx: AppContext,
-): Promise<PasswordLastUpdate | null> {
-  const { io } = ctx;
-  const { cookie, payload } = parseCookie(req.headers, ctx.account);
-
-  if (!payload?.sub || !payload?.userId) {
-    return null;
-  }
-
-  const query = `query getUserProfile { profile { passwordLastUpdate }}`;
-
-  try {
-    const { profile } = await io.query<{ profile: ProfilePassword }, null>(
-      { query },
-      { headers: { cookie } },
-    );
-
-    return profile.passwordLastUpdate ?? null;
-  } catch (_) {
-    return null;
-  }
-}
-
-export default loader;
diff --git a/vtex/loaders/sessions/info.ts b/vtex/loaders/sessions/info.ts
deleted file mode 100644
index 1739fd41c..000000000
--- a/vtex/loaders/sessions/info.ts
+++ /dev/null
@@ -1,68 +0,0 @@
-import { AppContext } from "../../mod.ts";
-import { parseCookie } from "../../utils/vtexId.ts";
-
-export interface LoginSessionInfo {
-  currentLoginSessionId: string;
-  loginSessions: LoginSession[];
-}
-
-export interface LoginSession {
-  id: string;
-  cacheId: string;
-  deviceType: string;
-  lastAccess: string;
-  city: string;
-  fullAddress: string;
-  ip: string;
-  browser: string;
-  os: string;
-  firstAccess: string;
-}
-
-async function loader(
-  _props: unknown,
-  req: Request,
-  ctx: AppContext,
-): Promise<LoginSessionInfo | null> {
-  const { io } = ctx;
-  const { cookie, payload } = parseCookie(req.headers, ctx.account);
-
-  if (!payload?.sub || !payload?.userId) {
-    return null;
-  }
-
-  const query = `query getUserSessions {
-      loginSessionsInfo {
-        currentLoginSessionId
-        loginSessions {
-          id
-          cacheId
-          deviceType
-          lastAccess
-          city
-          fullAddress
-          ip
-          browser
-          os
-          firstAccess
-        }
-      }
-    }`;
-
-  try {
-    const data = await io.query<
-      { loginSessionsInfo: LoginSessionInfo },
-      null
-    >(
-      { query },
-      { headers: { cookie } },
-    );
-
-    return data.loginSessionsInfo;
-  } catch (e) {
-    console.error(e);
-    return null;
-  }
-}
-
-export default loader;
diff --git a/vtex/loaders/user.ts b/vtex/loaders/user.ts
index 29694ebca..715407c44 100644
--- a/vtex/loaders/user.ts
+++ b/vtex/loaders/user.ts
@@ -2,7 +2,7 @@ import { Person } from "../../commerce/types.ts";
 import { AppContext } from "../mod.ts";
 import { parseCookie } from "../utils/vtexId.ts";
 
-export interface User {
+interface User {
   id: string;
   userId: string;
   email: string;
@@ -12,13 +12,8 @@ export interface User {
   gender?: string;
   document?: string;
   homePhone?: string;
-  birthDate?: string;
-  corporateDocument?: string;
-  corporateName?: string;
-  tradeName?: string;
   businessPhone?: string;
-  isCorporate?: boolean;
-  customFields?: { key: string; value: string }[];
+  birthDate?: string;
 }
 
 /**
@@ -38,7 +33,7 @@ async function loader(
   }
 
   const query =
-    `query getUserProfile { profile(customFields: "isNewsletterOptIn") { id userId email firstName lastName profilePicture gender document homePhone birthDate corporateDocument corporateName tradeName businessPhone isCorporate customFields { key value } }}`;
+    "query getUserProfile { profile { id userId email firstName lastName profilePicture gender document homePhone businessPhone birthDate }}";
 
   try {
     const { profile: user } = await io.query<{ profile: User }, null>(
@@ -55,14 +50,8 @@ async function loader(
       gender: user?.gender === "female"
         ? "https://schema.org/Female"
         : "https://schema.org/Male",
-      telephone: user?.homePhone,
+      telephone: user?.homePhone ?? user?.businessPhone,
       birthDate: user?.birthDate,
-      corporateName: user?.corporateName,
-      tradeName: user?.tradeName,
-      corporateDocument: user?.corporateDocument,
-      businessPhone: user?.businessPhone,
-      isCorporate: user?.isCorporate,
-      customFields: user?.customFields,
     };
   } catch (_) {
     return null;
diff --git a/vtex/manifest.gen.ts b/vtex/manifest.gen.ts
index 8b2c73196..966737f15 100644
--- a/vtex/manifest.gen.ts
+++ b/vtex/manifest.gen.ts
@@ -3,116 +3,104 @@
 // This file is automatically updated during development when running `dev.ts`.
 
 import * as $$$$$$$$$0 from "./actions/address/create.ts";
-import * as $$$$$$$$$1 from "./actions/address/createAddress.ts";
-import * as $$$$$$$$$2 from "./actions/address/delete.ts";
-import * as $$$$$$$$$3 from "./actions/address/deleteAddress.ts";
-import * as $$$$$$$$$4 from "./actions/address/update.ts";
-import * as $$$$$$$$$5 from "./actions/address/updateAddress.ts";
-import * as $$$$$$$$$6 from "./actions/analytics/sendEvent.ts";
-import * as $$$$$$$$$7 from "./actions/authentication/accessKeySignIn.ts";
-import * as $$$$$$$$$8 from "./actions/authentication/classicSignIn.ts";
-import * as $$$$$$$$$9 from "./actions/authentication/logout.ts";
-import * as $$$$$$$$$10 from "./actions/authentication/recoveryPassword.ts";
-import * as $$$$$$$$$11 from "./actions/authentication/refreshToken.ts";
-import * as $$$$$$$$$12 from "./actions/authentication/resetPassword.ts";
-import * as $$$$$$$$$13 from "./actions/authentication/sendEmailVerification.ts";
-import * as $$$$$$$$$14 from "./actions/authentication/startAuthentication.ts";
-import * as $$$$$$$$$15 from "./actions/cart/addItems.ts";
-import * as $$$$$$$$$16 from "./actions/cart/addOfferings.ts";
-import * as $$$$$$$$$17 from "./actions/cart/clearOrderformMessages.ts";
-import * as $$$$$$$$$18 from "./actions/cart/getInstallment.ts";
-import * as $$$$$$$$$19 from "./actions/cart/removeItemAttachment.ts";
-import * as $$$$$$$$$20 from "./actions/cart/removeItems.ts";
-import * as $$$$$$$$$21 from "./actions/cart/removeOffering.ts";
-import * as $$$$$$$$$22 from "./actions/cart/simulation.ts";
-import * as $$$$$$$$$23 from "./actions/cart/updateAttachment.ts";
-import * as $$$$$$$$$24 from "./actions/cart/updateCoupons.ts";
-import * as $$$$$$$$$25 from "./actions/cart/updateGifts.ts";
-import * as $$$$$$$$$26 from "./actions/cart/updateItemAttachment.ts";
-import * as $$$$$$$$$27 from "./actions/cart/updateItemPrice.ts";
-import * as $$$$$$$$$28 from "./actions/cart/updateItems.ts";
-import * as $$$$$$$$$29 from "./actions/cart/updateProfile.ts";
-import * as $$$$$$$$$30 from "./actions/cart/updateUser.ts";
-import * as $$$$$$$$$31 from "./actions/credentials/validate.ts";
-import * as $$$$$$$$$32 from "./actions/masterdata/createDocument.ts";
-import * as $$$$$$$$$33 from "./actions/masterdata/updateDocument.ts";
-import * as $$$$$$$$$34 from "./actions/masterdata/updatePartialDocument.ts";
-import * as $$$$$$$$$35 from "./actions/newsletter/subscribe.ts";
-import * as $$$$$$$$$36 from "./actions/newsletter/updateNewsletterOptIn.ts";
-import * as $$$$$$$$$37 from "./actions/notifyme.ts";
-import * as $$$$$$$$$38 from "./actions/orders/cancel.ts";
-import * as $$$$$$$$$39 from "./actions/payment/deletePaymentToken.ts";
-import * as $$$$$$$$$40 from "./actions/payments/delete.ts";
-import * as $$$$$$$$$41 from "./actions/profile/newsletterProfile.ts";
-import * as $$$$$$$$$42 from "./actions/profile/updateProfile.ts";
-import * as $$$$$$$$$43 from "./actions/review/submit.ts";
-import * as $$$$$$$$$44 from "./actions/session/createSession.ts";
-import * as $$$$$$$$$45 from "./actions/session/deleteSession.ts";
-import * as $$$$$$$$$46 from "./actions/session/editSession.ts";
-import * as $$$$$$$$$47 from "./actions/sessions/delete.ts";
-import * as $$$$$$$$$48 from "./actions/trigger.ts";
-import * as $$$$$$$$$49 from "./actions/wishlist/addItem.ts";
-import * as $$$$$$$$$50 from "./actions/wishlist/removeItem.ts";
+import * as $$$$$$$$$1 from "./actions/address/delete.ts";
+import * as $$$$$$$$$2 from "./actions/address/update.ts";
+import * as $$$$$$$$$3 from "./actions/analytics/sendEvent.ts";
+import * as $$$$$$$$$4 from "./actions/authentication/accessKeySignIn.ts";
+import * as $$$$$$$$$5 from "./actions/authentication/classicSignIn.ts";
+import * as $$$$$$$$$6 from "./actions/authentication/logout.ts";
+import * as $$$$$$$$$7 from "./actions/authentication/recoveryPassword.ts";
+import * as $$$$$$$$$8 from "./actions/authentication/refreshToken.ts";
+import * as $$$$$$$$$9 from "./actions/authentication/resetPassword.ts";
+import * as $$$$$$$$$10 from "./actions/authentication/sendEmailVerification.ts";
+import * as $$$$$$$$$11 from "./actions/authentication/startAuthentication.ts";
+import * as $$$$$$$$$12 from "./actions/cart/addItems.ts";
+import * as $$$$$$$$$13 from "./actions/cart/addOfferings.ts";
+import * as $$$$$$$$$14 from "./actions/cart/clearOrderformMessages.ts";
+import * as $$$$$$$$$15 from "./actions/cart/getInstallment.ts";
+import * as $$$$$$$$$16 from "./actions/cart/removeItemAttachment.ts";
+import * as $$$$$$$$$17 from "./actions/cart/removeItems.ts";
+import * as $$$$$$$$$18 from "./actions/cart/removeOffering.ts";
+import * as $$$$$$$$$19 from "./actions/cart/simulation.ts";
+import * as $$$$$$$$$20 from "./actions/cart/updateAttachment.ts";
+import * as $$$$$$$$$21 from "./actions/cart/updateCoupons.ts";
+import * as $$$$$$$$$22 from "./actions/cart/updateGifts.ts";
+import * as $$$$$$$$$23 from "./actions/cart/updateItemAttachment.ts";
+import * as $$$$$$$$$24 from "./actions/cart/updateItemPrice.ts";
+import * as $$$$$$$$$25 from "./actions/cart/updateItems.ts";
+import * as $$$$$$$$$26 from "./actions/cart/updateProfile.ts";
+import * as $$$$$$$$$27 from "./actions/cart/updateUser.ts";
+import * as $$$$$$$$$28 from "./actions/credentials/validate.ts";
+import * as $$$$$$$$$29 from "./actions/masterdata/createDocument.ts";
+import * as $$$$$$$$$30 from "./actions/masterdata/updateDocument.ts";
+import * as $$$$$$$$$31 from "./actions/masterdata/updatePartialDocument.ts";
+import * as $$$$$$$$$32 from "./actions/newsletter/subscribe.ts";
+import * as $$$$$$$$$33 from "./actions/newsletter/updateNewsletterOptIn.ts";
+import * as $$$$$$$$$34 from "./actions/notifyme.ts";
+import * as $$$$$$$$$35 from "./actions/orders/cancel.ts";
+import * as $$$$$$$$$36 from "./actions/payment/deletePaymentToken.ts";
+import * as $$$$$$$$$37 from "./actions/profile/updateProfile.ts";
+import * as $$$$$$$$$38 from "./actions/review/submit.ts";
+import * as $$$$$$$$$39 from "./actions/session/createSession.ts";
+import * as $$$$$$$$$40 from "./actions/session/deleteSession.ts";
+import * as $$$$$$$$$41 from "./actions/session/editSession.ts";
+import * as $$$$$$$$$42 from "./actions/sessions/delete.ts";
+import * as $$$$$$$$$43 from "./actions/trigger.ts";
+import * as $$$$$$$$$44 from "./actions/wishlist/addItem.ts";
+import * as $$$$$$$$$45 from "./actions/wishlist/removeItem.ts";
 import * as $$$$0 from "./handlers/sitemap.ts";
 import * as $$$0 from "./loaders/address/getAddressByPostalCode.ts";
-import * as $$$1 from "./loaders/address/getAddressByZIP.ts";
-import * as $$$2 from "./loaders/address/getUserAddresses.ts";
-import * as $$$3 from "./loaders/address/list.ts";
-import * as $$$4 from "./loaders/cart.ts";
-import * as $$$5 from "./loaders/categories/tree.ts";
-import * as $$$6 from "./loaders/collections/list.ts";
-import * as $$$7 from "./loaders/config.ts";
-import * as $$$8 from "./loaders/intelligentSearch/productDetailsPage.ts";
-import * as $$$9 from "./loaders/intelligentSearch/productList.ts";
-import * as $$$10 from "./loaders/intelligentSearch/productListingPage.ts";
-import * as $$$11 from "./loaders/intelligentSearch/productSearchValidator.ts";
-import * as $$$12 from "./loaders/intelligentSearch/searches.ts";
-import * as $$$13 from "./loaders/intelligentSearch/suggestions.ts";
-import * as $$$14 from "./loaders/intelligentSearch/topsearches.ts";
-import * as $$$15 from "./loaders/legacy/brands.ts";
-import * as $$$16 from "./loaders/legacy/pageType.ts";
-import * as $$$17 from "./loaders/legacy/productDetailsPage.ts";
-import * as $$$18 from "./loaders/legacy/productList.ts";
-import * as $$$19 from "./loaders/legacy/productListingPage.ts";
-import * as $$$20 from "./loaders/legacy/relatedProductsLoader.ts";
-import * as $$$21 from "./loaders/legacy/suggestions.ts";
-import * as $$$22 from "./loaders/logistics/getSalesChannelById.ts";
-import * as $$$23 from "./loaders/logistics/listHolidays.ts";
-import * as $$$24 from "./loaders/logistics/listPickupPoints.ts";
-import * as $$$25 from "./loaders/logistics/listPickupPointsByLocation.ts";
-import * as $$$26 from "./loaders/logistics/listSalesChannelById.ts";
-import * as $$$27 from "./loaders/logistics/listStockByStore.ts";
-import * as $$$28 from "./loaders/masterdata/searchDocuments.ts";
-import * as $$$29 from "./loaders/navbar.ts";
-import * as $$$30 from "./loaders/options/productIdByTerm.ts";
-import * as $$$31 from "./loaders/orders/getById.ts";
-import * as $$$32 from "./loaders/orders/list.ts";
-import * as $$$33 from "./loaders/orders/order.ts";
-import * as $$$34 from "./loaders/orders/orderplaced.ts";
-import * as $$$35 from "./loaders/paths/PDPDefaultPath.ts";
-import * as $$$36 from "./loaders/paths/PLPDefaultPath.ts";
-import * as $$$37 from "./loaders/payment/paymentSystems.ts";
-import * as $$$38 from "./loaders/payment/userPayments.ts";
-import * as $$$39 from "./loaders/payments/info.ts";
-import * as $$$40 from "./loaders/payments/userPayments.ts";
-import * as $$$41 from "./loaders/product/extend.ts";
-import * as $$$42 from "./loaders/product/extensions/detailsPage.ts";
-import * as $$$43 from "./loaders/product/extensions/list.ts";
-import * as $$$44 from "./loaders/product/extensions/listingPage.ts";
-import * as $$$45 from "./loaders/product/extensions/suggestions.ts";
-import * as $$$46 from "./loaders/product/wishlist.ts";
-import * as $$$47 from "./loaders/profile/getCurrentProfile.ts";
-import * as $$$48 from "./loaders/profile/getProfileByEmail.ts";
-import * as $$$49 from "./loaders/profile/passwordLastUpdate.ts";
-import * as $$$50 from "./loaders/promotion/getPromotionById.ts";
-import * as $$$51 from "./loaders/proxy.ts";
-import * as $$$52 from "./loaders/session/getSession.ts";
-import * as $$$53 from "./loaders/session/getUserSessions.ts";
-import * as $$$54 from "./loaders/sessions/info.ts";
-import * as $$$55 from "./loaders/user.ts";
-import * as $$$56 from "./loaders/wishlist.ts";
-import * as $$$57 from "./loaders/workflow/product.ts";
-import * as $$$58 from "./loaders/workflow/products.ts";
+import * as $$$1 from "./loaders/address/getUserAddresses.ts";
+import * as $$$2 from "./loaders/cart.ts";
+import * as $$$3 from "./loaders/categories/tree.ts";
+import * as $$$4 from "./loaders/collections/list.ts";
+import * as $$$5 from "./loaders/config.ts";
+import * as $$$6 from "./loaders/intelligentSearch/productDetailsPage.ts";
+import * as $$$7 from "./loaders/intelligentSearch/productList.ts";
+import * as $$$8 from "./loaders/intelligentSearch/productListingPage.ts";
+import * as $$$9 from "./loaders/intelligentSearch/productSearchValidator.ts";
+import * as $$$10 from "./loaders/intelligentSearch/searches.ts";
+import * as $$$11 from "./loaders/intelligentSearch/suggestions.ts";
+import * as $$$12 from "./loaders/intelligentSearch/topsearches.ts";
+import * as $$$13 from "./loaders/legacy/brands.ts";
+import * as $$$14 from "./loaders/legacy/pageType.ts";
+import * as $$$15 from "./loaders/legacy/productDetailsPage.ts";
+import * as $$$16 from "./loaders/legacy/productList.ts";
+import * as $$$17 from "./loaders/legacy/productListingPage.ts";
+import * as $$$18 from "./loaders/legacy/relatedProductsLoader.ts";
+import * as $$$19 from "./loaders/legacy/suggestions.ts";
+import * as $$$20 from "./loaders/logistics/getSalesChannelById.ts";
+import * as $$$21 from "./loaders/logistics/listHolidays.ts";
+import * as $$$22 from "./loaders/logistics/listPickupPoints.ts";
+import * as $$$23 from "./loaders/logistics/listPickupPointsByLocation.ts";
+import * as $$$24 from "./loaders/logistics/listSalesChannelById.ts";
+import * as $$$25 from "./loaders/logistics/listStockByStore.ts";
+import * as $$$26 from "./loaders/masterdata/searchDocuments.ts";
+import * as $$$27 from "./loaders/navbar.ts";
+import * as $$$28 from "./loaders/options/productIdByTerm.ts";
+import * as $$$29 from "./loaders/orders/getById.ts";
+import * as $$$30 from "./loaders/orders/list.ts";
+import * as $$$31 from "./loaders/orders/orderplaced.ts";
+import * as $$$32 from "./loaders/paths/PDPDefaultPath.ts";
+import * as $$$33 from "./loaders/paths/PLPDefaultPath.ts";
+import * as $$$34 from "./loaders/payment/paymentSystems.ts";
+import * as $$$35 from "./loaders/payment/userPayments.ts";
+import * as $$$36 from "./loaders/product/extend.ts";
+import * as $$$37 from "./loaders/product/extensions/detailsPage.ts";
+import * as $$$38 from "./loaders/product/extensions/list.ts";
+import * as $$$39 from "./loaders/product/extensions/listingPage.ts";
+import * as $$$40 from "./loaders/product/extensions/suggestions.ts";
+import * as $$$41 from "./loaders/product/wishlist.ts";
+import * as $$$42 from "./loaders/profile/getCurrentProfile.ts";
+import * as $$$43 from "./loaders/profile/getProfileByEmail.ts";
+import * as $$$44 from "./loaders/promotion/getPromotionById.ts";
+import * as $$$45 from "./loaders/proxy.ts";
+import * as $$$46 from "./loaders/session/getSession.ts";
+import * as $$$47 from "./loaders/session/getUserSessions.ts";
+import * as $$$48 from "./loaders/user.ts";
+import * as $$$49 from "./loaders/wishlist.ts";
+import * as $$$50 from "./loaders/workflow/product.ts";
+import * as $$$51 from "./loaders/workflow/products.ts";
 import * as $$$$$$0 from "./sections/Analytics/Vtex.tsx";
 import * as $$$$$$$$$$0 from "./workflows/events.ts";
 import * as $$$$$$$$$$1 from "./workflows/product/index.ts";
@@ -120,64 +108,57 @@ import * as $$$$$$$$$$1 from "./workflows/product/index.ts";
 const manifest = {
   "loaders": {
     "vtex/loaders/address/getAddressByPostalCode.ts": $$$0,
-    "vtex/loaders/address/getAddressByZIP.ts": $$$1,
-    "vtex/loaders/address/getUserAddresses.ts": $$$2,
-    "vtex/loaders/address/list.ts": $$$3,
-    "vtex/loaders/cart.ts": $$$4,
-    "vtex/loaders/categories/tree.ts": $$$5,
-    "vtex/loaders/collections/list.ts": $$$6,
-    "vtex/loaders/config.ts": $$$7,
-    "vtex/loaders/intelligentSearch/productDetailsPage.ts": $$$8,
-    "vtex/loaders/intelligentSearch/productList.ts": $$$9,
-    "vtex/loaders/intelligentSearch/productListingPage.ts": $$$10,
-    "vtex/loaders/intelligentSearch/productSearchValidator.ts": $$$11,
-    "vtex/loaders/intelligentSearch/searches.ts": $$$12,
-    "vtex/loaders/intelligentSearch/suggestions.ts": $$$13,
-    "vtex/loaders/intelligentSearch/topsearches.ts": $$$14,
-    "vtex/loaders/legacy/brands.ts": $$$15,
-    "vtex/loaders/legacy/pageType.ts": $$$16,
-    "vtex/loaders/legacy/productDetailsPage.ts": $$$17,
-    "vtex/loaders/legacy/productList.ts": $$$18,
-    "vtex/loaders/legacy/productListingPage.ts": $$$19,
-    "vtex/loaders/legacy/relatedProductsLoader.ts": $$$20,
-    "vtex/loaders/legacy/suggestions.ts": $$$21,
-    "vtex/loaders/logistics/getSalesChannelById.ts": $$$22,
-    "vtex/loaders/logistics/listHolidays.ts": $$$23,
-    "vtex/loaders/logistics/listPickupPoints.ts": $$$24,
-    "vtex/loaders/logistics/listPickupPointsByLocation.ts": $$$25,
-    "vtex/loaders/logistics/listSalesChannelById.ts": $$$26,
-    "vtex/loaders/logistics/listStockByStore.ts": $$$27,
-    "vtex/loaders/masterdata/searchDocuments.ts": $$$28,
-    "vtex/loaders/navbar.ts": $$$29,
-    "vtex/loaders/options/productIdByTerm.ts": $$$30,
-    "vtex/loaders/orders/getById.ts": $$$31,
-    "vtex/loaders/orders/list.ts": $$$32,
-    "vtex/loaders/orders/order.ts": $$$33,
-    "vtex/loaders/orders/orderplaced.ts": $$$34,
-    "vtex/loaders/paths/PDPDefaultPath.ts": $$$35,
-    "vtex/loaders/paths/PLPDefaultPath.ts": $$$36,
-    "vtex/loaders/payment/paymentSystems.ts": $$$37,
-    "vtex/loaders/payment/userPayments.ts": $$$38,
-    "vtex/loaders/payments/info.ts": $$$39,
-    "vtex/loaders/payments/userPayments.ts": $$$40,
-    "vtex/loaders/product/extend.ts": $$$41,
-    "vtex/loaders/product/extensions/detailsPage.ts": $$$42,
-    "vtex/loaders/product/extensions/list.ts": $$$43,
-    "vtex/loaders/product/extensions/listingPage.ts": $$$44,
-    "vtex/loaders/product/extensions/suggestions.ts": $$$45,
-    "vtex/loaders/product/wishlist.ts": $$$46,
-    "vtex/loaders/profile/getCurrentProfile.ts": $$$47,
-    "vtex/loaders/profile/getProfileByEmail.ts": $$$48,
-    "vtex/loaders/profile/passwordLastUpdate.ts": $$$49,
-    "vtex/loaders/promotion/getPromotionById.ts": $$$50,
-    "vtex/loaders/proxy.ts": $$$51,
-    "vtex/loaders/session/getSession.ts": $$$52,
-    "vtex/loaders/session/getUserSessions.ts": $$$53,
-    "vtex/loaders/sessions/info.ts": $$$54,
-    "vtex/loaders/user.ts": $$$55,
-    "vtex/loaders/wishlist.ts": $$$56,
-    "vtex/loaders/workflow/product.ts": $$$57,
-    "vtex/loaders/workflow/products.ts": $$$58,
+    "vtex/loaders/address/getUserAddresses.ts": $$$1,
+    "vtex/loaders/cart.ts": $$$2,
+    "vtex/loaders/categories/tree.ts": $$$3,
+    "vtex/loaders/collections/list.ts": $$$4,
+    "vtex/loaders/config.ts": $$$5,
+    "vtex/loaders/intelligentSearch/productDetailsPage.ts": $$$6,
+    "vtex/loaders/intelligentSearch/productList.ts": $$$7,
+    "vtex/loaders/intelligentSearch/productListingPage.ts": $$$8,
+    "vtex/loaders/intelligentSearch/productSearchValidator.ts": $$$9,
+    "vtex/loaders/intelligentSearch/searches.ts": $$$10,
+    "vtex/loaders/intelligentSearch/suggestions.ts": $$$11,
+    "vtex/loaders/intelligentSearch/topsearches.ts": $$$12,
+    "vtex/loaders/legacy/brands.ts": $$$13,
+    "vtex/loaders/legacy/pageType.ts": $$$14,
+    "vtex/loaders/legacy/productDetailsPage.ts": $$$15,
+    "vtex/loaders/legacy/productList.ts": $$$16,
+    "vtex/loaders/legacy/productListingPage.ts": $$$17,
+    "vtex/loaders/legacy/relatedProductsLoader.ts": $$$18,
+    "vtex/loaders/legacy/suggestions.ts": $$$19,
+    "vtex/loaders/logistics/getSalesChannelById.ts": $$$20,
+    "vtex/loaders/logistics/listHolidays.ts": $$$21,
+    "vtex/loaders/logistics/listPickupPoints.ts": $$$22,
+    "vtex/loaders/logistics/listPickupPointsByLocation.ts": $$$23,
+    "vtex/loaders/logistics/listSalesChannelById.ts": $$$24,
+    "vtex/loaders/logistics/listStockByStore.ts": $$$25,
+    "vtex/loaders/masterdata/searchDocuments.ts": $$$26,
+    "vtex/loaders/navbar.ts": $$$27,
+    "vtex/loaders/options/productIdByTerm.ts": $$$28,
+    "vtex/loaders/orders/getById.ts": $$$29,
+    "vtex/loaders/orders/list.ts": $$$30,
+    "vtex/loaders/orders/orderplaced.ts": $$$31,
+    "vtex/loaders/paths/PDPDefaultPath.ts": $$$32,
+    "vtex/loaders/paths/PLPDefaultPath.ts": $$$33,
+    "vtex/loaders/payment/paymentSystems.ts": $$$34,
+    "vtex/loaders/payment/userPayments.ts": $$$35,
+    "vtex/loaders/product/extend.ts": $$$36,
+    "vtex/loaders/product/extensions/detailsPage.ts": $$$37,
+    "vtex/loaders/product/extensions/list.ts": $$$38,
+    "vtex/loaders/product/extensions/listingPage.ts": $$$39,
+    "vtex/loaders/product/extensions/suggestions.ts": $$$40,
+    "vtex/loaders/product/wishlist.ts": $$$41,
+    "vtex/loaders/profile/getCurrentProfile.ts": $$$42,
+    "vtex/loaders/profile/getProfileByEmail.ts": $$$43,
+    "vtex/loaders/promotion/getPromotionById.ts": $$$44,
+    "vtex/loaders/proxy.ts": $$$45,
+    "vtex/loaders/session/getSession.ts": $$$46,
+    "vtex/loaders/session/getUserSessions.ts": $$$47,
+    "vtex/loaders/user.ts": $$$48,
+    "vtex/loaders/wishlist.ts": $$$49,
+    "vtex/loaders/workflow/product.ts": $$$50,
+    "vtex/loaders/workflow/products.ts": $$$51,
   },
   "handlers": {
     "vtex/handlers/sitemap.ts": $$$$0,
@@ -187,56 +168,51 @@ const manifest = {
   },
   "actions": {
     "vtex/actions/address/create.ts": $$$$$$$$$0,
-    "vtex/actions/address/createAddress.ts": $$$$$$$$$1,
-    "vtex/actions/address/delete.ts": $$$$$$$$$2,
-    "vtex/actions/address/deleteAddress.ts": $$$$$$$$$3,
-    "vtex/actions/address/update.ts": $$$$$$$$$4,
-    "vtex/actions/address/updateAddress.ts": $$$$$$$$$5,
-    "vtex/actions/analytics/sendEvent.ts": $$$$$$$$$6,
-    "vtex/actions/authentication/accessKeySignIn.ts": $$$$$$$$$7,
-    "vtex/actions/authentication/classicSignIn.ts": $$$$$$$$$8,
-    "vtex/actions/authentication/logout.ts": $$$$$$$$$9,
-    "vtex/actions/authentication/recoveryPassword.ts": $$$$$$$$$10,
-    "vtex/actions/authentication/refreshToken.ts": $$$$$$$$$11,
-    "vtex/actions/authentication/resetPassword.ts": $$$$$$$$$12,
-    "vtex/actions/authentication/sendEmailVerification.ts": $$$$$$$$$13,
-    "vtex/actions/authentication/startAuthentication.ts": $$$$$$$$$14,
-    "vtex/actions/cart/addItems.ts": $$$$$$$$$15,
-    "vtex/actions/cart/addOfferings.ts": $$$$$$$$$16,
-    "vtex/actions/cart/clearOrderformMessages.ts": $$$$$$$$$17,
-    "vtex/actions/cart/getInstallment.ts": $$$$$$$$$18,
-    "vtex/actions/cart/removeItemAttachment.ts": $$$$$$$$$19,
-    "vtex/actions/cart/removeItems.ts": $$$$$$$$$20,
-    "vtex/actions/cart/removeOffering.ts": $$$$$$$$$21,
-    "vtex/actions/cart/simulation.ts": $$$$$$$$$22,
-    "vtex/actions/cart/updateAttachment.ts": $$$$$$$$$23,
-    "vtex/actions/cart/updateCoupons.ts": $$$$$$$$$24,
-    "vtex/actions/cart/updateGifts.ts": $$$$$$$$$25,
-    "vtex/actions/cart/updateItemAttachment.ts": $$$$$$$$$26,
-    "vtex/actions/cart/updateItemPrice.ts": $$$$$$$$$27,
-    "vtex/actions/cart/updateItems.ts": $$$$$$$$$28,
-    "vtex/actions/cart/updateProfile.ts": $$$$$$$$$29,
-    "vtex/actions/cart/updateUser.ts": $$$$$$$$$30,
-    "vtex/actions/credentials/validate.ts": $$$$$$$$$31,
-    "vtex/actions/masterdata/createDocument.ts": $$$$$$$$$32,
-    "vtex/actions/masterdata/updateDocument.ts": $$$$$$$$$33,
-    "vtex/actions/masterdata/updatePartialDocument.ts": $$$$$$$$$34,
-    "vtex/actions/newsletter/subscribe.ts": $$$$$$$$$35,
-    "vtex/actions/newsletter/updateNewsletterOptIn.ts": $$$$$$$$$36,
-    "vtex/actions/notifyme.ts": $$$$$$$$$37,
-    "vtex/actions/orders/cancel.ts": $$$$$$$$$38,
-    "vtex/actions/payment/deletePaymentToken.ts": $$$$$$$$$39,
-    "vtex/actions/payments/delete.ts": $$$$$$$$$40,
-    "vtex/actions/profile/newsletterProfile.ts": $$$$$$$$$41,
-    "vtex/actions/profile/updateProfile.ts": $$$$$$$$$42,
-    "vtex/actions/review/submit.ts": $$$$$$$$$43,
-    "vtex/actions/session/createSession.ts": $$$$$$$$$44,
-    "vtex/actions/session/deleteSession.ts": $$$$$$$$$45,
-    "vtex/actions/session/editSession.ts": $$$$$$$$$46,
-    "vtex/actions/sessions/delete.ts": $$$$$$$$$47,
-    "vtex/actions/trigger.ts": $$$$$$$$$48,
-    "vtex/actions/wishlist/addItem.ts": $$$$$$$$$49,
-    "vtex/actions/wishlist/removeItem.ts": $$$$$$$$$50,
+    "vtex/actions/address/delete.ts": $$$$$$$$$1,
+    "vtex/actions/address/update.ts": $$$$$$$$$2,
+    "vtex/actions/analytics/sendEvent.ts": $$$$$$$$$3,
+    "vtex/actions/authentication/accessKeySignIn.ts": $$$$$$$$$4,
+    "vtex/actions/authentication/classicSignIn.ts": $$$$$$$$$5,
+    "vtex/actions/authentication/logout.ts": $$$$$$$$$6,
+    "vtex/actions/authentication/recoveryPassword.ts": $$$$$$$$$7,
+    "vtex/actions/authentication/refreshToken.ts": $$$$$$$$$8,
+    "vtex/actions/authentication/resetPassword.ts": $$$$$$$$$9,
+    "vtex/actions/authentication/sendEmailVerification.ts": $$$$$$$$$10,
+    "vtex/actions/authentication/startAuthentication.ts": $$$$$$$$$11,
+    "vtex/actions/cart/addItems.ts": $$$$$$$$$12,
+    "vtex/actions/cart/addOfferings.ts": $$$$$$$$$13,
+    "vtex/actions/cart/clearOrderformMessages.ts": $$$$$$$$$14,
+    "vtex/actions/cart/getInstallment.ts": $$$$$$$$$15,
+    "vtex/actions/cart/removeItemAttachment.ts": $$$$$$$$$16,
+    "vtex/actions/cart/removeItems.ts": $$$$$$$$$17,
+    "vtex/actions/cart/removeOffering.ts": $$$$$$$$$18,
+    "vtex/actions/cart/simulation.ts": $$$$$$$$$19,
+    "vtex/actions/cart/updateAttachment.ts": $$$$$$$$$20,
+    "vtex/actions/cart/updateCoupons.ts": $$$$$$$$$21,
+    "vtex/actions/cart/updateGifts.ts": $$$$$$$$$22,
+    "vtex/actions/cart/updateItemAttachment.ts": $$$$$$$$$23,
+    "vtex/actions/cart/updateItemPrice.ts": $$$$$$$$$24,
+    "vtex/actions/cart/updateItems.ts": $$$$$$$$$25,
+    "vtex/actions/cart/updateProfile.ts": $$$$$$$$$26,
+    "vtex/actions/cart/updateUser.ts": $$$$$$$$$27,
+    "vtex/actions/credentials/validate.ts": $$$$$$$$$28,
+    "vtex/actions/masterdata/createDocument.ts": $$$$$$$$$29,
+    "vtex/actions/masterdata/updateDocument.ts": $$$$$$$$$30,
+    "vtex/actions/masterdata/updatePartialDocument.ts": $$$$$$$$$31,
+    "vtex/actions/newsletter/subscribe.ts": $$$$$$$$$32,
+    "vtex/actions/newsletter/updateNewsletterOptIn.ts": $$$$$$$$$33,
+    "vtex/actions/notifyme.ts": $$$$$$$$$34,
+    "vtex/actions/orders/cancel.ts": $$$$$$$$$35,
+    "vtex/actions/payment/deletePaymentToken.ts": $$$$$$$$$36,
+    "vtex/actions/profile/updateProfile.ts": $$$$$$$$$37,
+    "vtex/actions/review/submit.ts": $$$$$$$$$38,
+    "vtex/actions/session/createSession.ts": $$$$$$$$$39,
+    "vtex/actions/session/deleteSession.ts": $$$$$$$$$40,
+    "vtex/actions/session/editSession.ts": $$$$$$$$$41,
+    "vtex/actions/sessions/delete.ts": $$$$$$$$$42,
+    "vtex/actions/trigger.ts": $$$$$$$$$43,
+    "vtex/actions/wishlist/addItem.ts": $$$$$$$$$44,
+    "vtex/actions/wishlist/removeItem.ts": $$$$$$$$$45,
   },
   "workflows": {
     "vtex/workflows/events.ts": $$$$$$$$$$0,

From d55a6a885a8561d4aa7ef538bf6aed486cf4d658 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Tue, 10 Mar 2026 16:42:38 -0400
Subject: [PATCH 90/93] refactor: remove unused action

---
 vtex/actions/sessions/delete.ts | 39 ---------------------------------
 1 file changed, 39 deletions(-)
 delete mode 100644 vtex/actions/sessions/delete.ts

diff --git a/vtex/actions/sessions/delete.ts b/vtex/actions/sessions/delete.ts
deleted file mode 100644
index e55b77e31..000000000
--- a/vtex/actions/sessions/delete.ts
+++ /dev/null
@@ -1,39 +0,0 @@
-import { AppContext } from "../../mod.ts";
-import { parseCookie } from "../../utils/vtexId.ts";
-
-export interface DeleteSession {
-  logOutFromSession: string;
-}
-
-interface Props {
-  sessionId: string;
-}
-
-async function loader(
-  { sessionId }: Props,
-  req: Request,
-  ctx: AppContext,
-): Promise<DeleteSession | null> {
-  const { io } = ctx;
-  const { cookie, payload } = parseCookie(req.headers, ctx.account);
-
-  if (!payload?.sub || !payload?.userId) {
-    return null;
-  }
-
-  const mutation = `mutation LogOutFromSession($sessionId: ID) {
-    logOutFromSession(sessionId: $sessionId) @context(provider: "vtex.store-graphql@2.x")
-  }`;
-
-  try {
-    return await io.query<DeleteSession, { sessionId: string }>({
-      query: mutation,
-      variables: { sessionId },
-    }, { headers: { cookie } });
-  } catch (e) {
-    console.error(e);
-    return null;
-  }
-}
-
-export default loader;

From 78d3c3f7c3a821866db30ee79a5cd6506cb9100b Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Tue, 10 Mar 2026 16:42:50 -0400
Subject: [PATCH 91/93] feat: add IS correaction api

---
 vtex/loaders/intelligentSearch/correction.ts |  28 +++
 vtex/manifest.gen.ts                         | 200 +++++++++----------
 vtex/utils/client.ts                         |   9 +-
 vtex/utils/types.ts                          |   9 +
 4 files changed, 145 insertions(+), 101 deletions(-)
 create mode 100644 vtex/loaders/intelligentSearch/correction.ts

diff --git a/vtex/loaders/intelligentSearch/correction.ts b/vtex/loaders/intelligentSearch/correction.ts
new file mode 100644
index 000000000..975153691
--- /dev/null
+++ b/vtex/loaders/intelligentSearch/correction.ts
@@ -0,0 +1,28 @@
+import type { AppContext } from "../../mod.ts";
+import { getSegmentFromBag } from "../../utils/segment.ts";
+import type { CorrectionSearchResult } from "../../utils/types.ts";
+
+interface Props {
+  query: string;
+}
+
+export default async function loader(
+  props: Props,
+  _req: Request,
+  ctx: AppContext,
+): Promise<CorrectionSearchResult> {
+  const { vcsDeprecated } = ctx;
+  const segment = getSegmentFromBag(ctx);
+  const locale = segment?.payload?.cultureInfo ??
+    ctx.defaultSegment?.cultureInfo ?? "pt-BR";
+
+  const correction = await vcsDeprecated
+    ["GET /api/io/_v/api/intelligent-search/correction_search"]({
+      query: props.query,
+      locale,
+    });
+
+  const data = await correction.json();
+
+  return data;
+}
diff --git a/vtex/manifest.gen.ts b/vtex/manifest.gen.ts
index 966737f15..31a433cc9 100644
--- a/vtex/manifest.gen.ts
+++ b/vtex/manifest.gen.ts
@@ -44,10 +44,9 @@ import * as $$$$$$$$$38 from "./actions/review/submit.ts";
 import * as $$$$$$$$$39 from "./actions/session/createSession.ts";
 import * as $$$$$$$$$40 from "./actions/session/deleteSession.ts";
 import * as $$$$$$$$$41 from "./actions/session/editSession.ts";
-import * as $$$$$$$$$42 from "./actions/sessions/delete.ts";
-import * as $$$$$$$$$43 from "./actions/trigger.ts";
-import * as $$$$$$$$$44 from "./actions/wishlist/addItem.ts";
-import * as $$$$$$$$$45 from "./actions/wishlist/removeItem.ts";
+import * as $$$$$$$$$42 from "./actions/trigger.ts";
+import * as $$$$$$$$$43 from "./actions/wishlist/addItem.ts";
+import * as $$$$$$$$$44 from "./actions/wishlist/removeItem.ts";
 import * as $$$$0 from "./handlers/sitemap.ts";
 import * as $$$0 from "./loaders/address/getAddressByPostalCode.ts";
 import * as $$$1 from "./loaders/address/getUserAddresses.ts";
@@ -55,52 +54,53 @@ import * as $$$2 from "./loaders/cart.ts";
 import * as $$$3 from "./loaders/categories/tree.ts";
 import * as $$$4 from "./loaders/collections/list.ts";
 import * as $$$5 from "./loaders/config.ts";
-import * as $$$6 from "./loaders/intelligentSearch/productDetailsPage.ts";
-import * as $$$7 from "./loaders/intelligentSearch/productList.ts";
-import * as $$$8 from "./loaders/intelligentSearch/productListingPage.ts";
-import * as $$$9 from "./loaders/intelligentSearch/productSearchValidator.ts";
-import * as $$$10 from "./loaders/intelligentSearch/searches.ts";
-import * as $$$11 from "./loaders/intelligentSearch/suggestions.ts";
-import * as $$$12 from "./loaders/intelligentSearch/topsearches.ts";
-import * as $$$13 from "./loaders/legacy/brands.ts";
-import * as $$$14 from "./loaders/legacy/pageType.ts";
-import * as $$$15 from "./loaders/legacy/productDetailsPage.ts";
-import * as $$$16 from "./loaders/legacy/productList.ts";
-import * as $$$17 from "./loaders/legacy/productListingPage.ts";
-import * as $$$18 from "./loaders/legacy/relatedProductsLoader.ts";
-import * as $$$19 from "./loaders/legacy/suggestions.ts";
-import * as $$$20 from "./loaders/logistics/getSalesChannelById.ts";
-import * as $$$21 from "./loaders/logistics/listHolidays.ts";
-import * as $$$22 from "./loaders/logistics/listPickupPoints.ts";
-import * as $$$23 from "./loaders/logistics/listPickupPointsByLocation.ts";
-import * as $$$24 from "./loaders/logistics/listSalesChannelById.ts";
-import * as $$$25 from "./loaders/logistics/listStockByStore.ts";
-import * as $$$26 from "./loaders/masterdata/searchDocuments.ts";
-import * as $$$27 from "./loaders/navbar.ts";
-import * as $$$28 from "./loaders/options/productIdByTerm.ts";
-import * as $$$29 from "./loaders/orders/getById.ts";
-import * as $$$30 from "./loaders/orders/list.ts";
-import * as $$$31 from "./loaders/orders/orderplaced.ts";
-import * as $$$32 from "./loaders/paths/PDPDefaultPath.ts";
-import * as $$$33 from "./loaders/paths/PLPDefaultPath.ts";
-import * as $$$34 from "./loaders/payment/paymentSystems.ts";
-import * as $$$35 from "./loaders/payment/userPayments.ts";
-import * as $$$36 from "./loaders/product/extend.ts";
-import * as $$$37 from "./loaders/product/extensions/detailsPage.ts";
-import * as $$$38 from "./loaders/product/extensions/list.ts";
-import * as $$$39 from "./loaders/product/extensions/listingPage.ts";
-import * as $$$40 from "./loaders/product/extensions/suggestions.ts";
-import * as $$$41 from "./loaders/product/wishlist.ts";
-import * as $$$42 from "./loaders/profile/getCurrentProfile.ts";
-import * as $$$43 from "./loaders/profile/getProfileByEmail.ts";
-import * as $$$44 from "./loaders/promotion/getPromotionById.ts";
-import * as $$$45 from "./loaders/proxy.ts";
-import * as $$$46 from "./loaders/session/getSession.ts";
-import * as $$$47 from "./loaders/session/getUserSessions.ts";
-import * as $$$48 from "./loaders/user.ts";
-import * as $$$49 from "./loaders/wishlist.ts";
-import * as $$$50 from "./loaders/workflow/product.ts";
-import * as $$$51 from "./loaders/workflow/products.ts";
+import * as $$$6 from "./loaders/intelligentSearch/correction.ts";
+import * as $$$7 from "./loaders/intelligentSearch/productDetailsPage.ts";
+import * as $$$8 from "./loaders/intelligentSearch/productList.ts";
+import * as $$$9 from "./loaders/intelligentSearch/productListingPage.ts";
+import * as $$$10 from "./loaders/intelligentSearch/productSearchValidator.ts";
+import * as $$$11 from "./loaders/intelligentSearch/searches.ts";
+import * as $$$12 from "./loaders/intelligentSearch/suggestions.ts";
+import * as $$$13 from "./loaders/intelligentSearch/topsearches.ts";
+import * as $$$14 from "./loaders/legacy/brands.ts";
+import * as $$$15 from "./loaders/legacy/pageType.ts";
+import * as $$$16 from "./loaders/legacy/productDetailsPage.ts";
+import * as $$$17 from "./loaders/legacy/productList.ts";
+import * as $$$18 from "./loaders/legacy/productListingPage.ts";
+import * as $$$19 from "./loaders/legacy/relatedProductsLoader.ts";
+import * as $$$20 from "./loaders/legacy/suggestions.ts";
+import * as $$$21 from "./loaders/logistics/getSalesChannelById.ts";
+import * as $$$22 from "./loaders/logistics/listHolidays.ts";
+import * as $$$23 from "./loaders/logistics/listPickupPoints.ts";
+import * as $$$24 from "./loaders/logistics/listPickupPointsByLocation.ts";
+import * as $$$25 from "./loaders/logistics/listSalesChannelById.ts";
+import * as $$$26 from "./loaders/logistics/listStockByStore.ts";
+import * as $$$27 from "./loaders/masterdata/searchDocuments.ts";
+import * as $$$28 from "./loaders/navbar.ts";
+import * as $$$29 from "./loaders/options/productIdByTerm.ts";
+import * as $$$30 from "./loaders/orders/getById.ts";
+import * as $$$31 from "./loaders/orders/list.ts";
+import * as $$$32 from "./loaders/orders/orderplaced.ts";
+import * as $$$33 from "./loaders/paths/PDPDefaultPath.ts";
+import * as $$$34 from "./loaders/paths/PLPDefaultPath.ts";
+import * as $$$35 from "./loaders/payment/paymentSystems.ts";
+import * as $$$36 from "./loaders/payment/userPayments.ts";
+import * as $$$37 from "./loaders/product/extend.ts";
+import * as $$$38 from "./loaders/product/extensions/detailsPage.ts";
+import * as $$$39 from "./loaders/product/extensions/list.ts";
+import * as $$$40 from "./loaders/product/extensions/listingPage.ts";
+import * as $$$41 from "./loaders/product/extensions/suggestions.ts";
+import * as $$$42 from "./loaders/product/wishlist.ts";
+import * as $$$43 from "./loaders/profile/getCurrentProfile.ts";
+import * as $$$44 from "./loaders/profile/getProfileByEmail.ts";
+import * as $$$45 from "./loaders/promotion/getPromotionById.ts";
+import * as $$$46 from "./loaders/proxy.ts";
+import * as $$$47 from "./loaders/session/getSession.ts";
+import * as $$$48 from "./loaders/session/getUserSessions.ts";
+import * as $$$49 from "./loaders/user.ts";
+import * as $$$50 from "./loaders/wishlist.ts";
+import * as $$$51 from "./loaders/workflow/product.ts";
+import * as $$$52 from "./loaders/workflow/products.ts";
 import * as $$$$$$0 from "./sections/Analytics/Vtex.tsx";
 import * as $$$$$$$$$$0 from "./workflows/events.ts";
 import * as $$$$$$$$$$1 from "./workflows/product/index.ts";
@@ -113,52 +113,53 @@ const manifest = {
     "vtex/loaders/categories/tree.ts": $$$3,
     "vtex/loaders/collections/list.ts": $$$4,
     "vtex/loaders/config.ts": $$$5,
-    "vtex/loaders/intelligentSearch/productDetailsPage.ts": $$$6,
-    "vtex/loaders/intelligentSearch/productList.ts": $$$7,
-    "vtex/loaders/intelligentSearch/productListingPage.ts": $$$8,
-    "vtex/loaders/intelligentSearch/productSearchValidator.ts": $$$9,
-    "vtex/loaders/intelligentSearch/searches.ts": $$$10,
-    "vtex/loaders/intelligentSearch/suggestions.ts": $$$11,
-    "vtex/loaders/intelligentSearch/topsearches.ts": $$$12,
-    "vtex/loaders/legacy/brands.ts": $$$13,
-    "vtex/loaders/legacy/pageType.ts": $$$14,
-    "vtex/loaders/legacy/productDetailsPage.ts": $$$15,
-    "vtex/loaders/legacy/productList.ts": $$$16,
-    "vtex/loaders/legacy/productListingPage.ts": $$$17,
-    "vtex/loaders/legacy/relatedProductsLoader.ts": $$$18,
-    "vtex/loaders/legacy/suggestions.ts": $$$19,
-    "vtex/loaders/logistics/getSalesChannelById.ts": $$$20,
-    "vtex/loaders/logistics/listHolidays.ts": $$$21,
-    "vtex/loaders/logistics/listPickupPoints.ts": $$$22,
-    "vtex/loaders/logistics/listPickupPointsByLocation.ts": $$$23,
-    "vtex/loaders/logistics/listSalesChannelById.ts": $$$24,
-    "vtex/loaders/logistics/listStockByStore.ts": $$$25,
-    "vtex/loaders/masterdata/searchDocuments.ts": $$$26,
-    "vtex/loaders/navbar.ts": $$$27,
-    "vtex/loaders/options/productIdByTerm.ts": $$$28,
-    "vtex/loaders/orders/getById.ts": $$$29,
-    "vtex/loaders/orders/list.ts": $$$30,
-    "vtex/loaders/orders/orderplaced.ts": $$$31,
-    "vtex/loaders/paths/PDPDefaultPath.ts": $$$32,
-    "vtex/loaders/paths/PLPDefaultPath.ts": $$$33,
-    "vtex/loaders/payment/paymentSystems.ts": $$$34,
-    "vtex/loaders/payment/userPayments.ts": $$$35,
-    "vtex/loaders/product/extend.ts": $$$36,
-    "vtex/loaders/product/extensions/detailsPage.ts": $$$37,
-    "vtex/loaders/product/extensions/list.ts": $$$38,
-    "vtex/loaders/product/extensions/listingPage.ts": $$$39,
-    "vtex/loaders/product/extensions/suggestions.ts": $$$40,
-    "vtex/loaders/product/wishlist.ts": $$$41,
-    "vtex/loaders/profile/getCurrentProfile.ts": $$$42,
-    "vtex/loaders/profile/getProfileByEmail.ts": $$$43,
-    "vtex/loaders/promotion/getPromotionById.ts": $$$44,
-    "vtex/loaders/proxy.ts": $$$45,
-    "vtex/loaders/session/getSession.ts": $$$46,
-    "vtex/loaders/session/getUserSessions.ts": $$$47,
-    "vtex/loaders/user.ts": $$$48,
-    "vtex/loaders/wishlist.ts": $$$49,
-    "vtex/loaders/workflow/product.ts": $$$50,
-    "vtex/loaders/workflow/products.ts": $$$51,
+    "vtex/loaders/intelligentSearch/correction.ts": $$$6,
+    "vtex/loaders/intelligentSearch/productDetailsPage.ts": $$$7,
+    "vtex/loaders/intelligentSearch/productList.ts": $$$8,
+    "vtex/loaders/intelligentSearch/productListingPage.ts": $$$9,
+    "vtex/loaders/intelligentSearch/productSearchValidator.ts": $$$10,
+    "vtex/loaders/intelligentSearch/searches.ts": $$$11,
+    "vtex/loaders/intelligentSearch/suggestions.ts": $$$12,
+    "vtex/loaders/intelligentSearch/topsearches.ts": $$$13,
+    "vtex/loaders/legacy/brands.ts": $$$14,
+    "vtex/loaders/legacy/pageType.ts": $$$15,
+    "vtex/loaders/legacy/productDetailsPage.ts": $$$16,
+    "vtex/loaders/legacy/productList.ts": $$$17,
+    "vtex/loaders/legacy/productListingPage.ts": $$$18,
+    "vtex/loaders/legacy/relatedProductsLoader.ts": $$$19,
+    "vtex/loaders/legacy/suggestions.ts": $$$20,
+    "vtex/loaders/logistics/getSalesChannelById.ts": $$$21,
+    "vtex/loaders/logistics/listHolidays.ts": $$$22,
+    "vtex/loaders/logistics/listPickupPoints.ts": $$$23,
+    "vtex/loaders/logistics/listPickupPointsByLocation.ts": $$$24,
+    "vtex/loaders/logistics/listSalesChannelById.ts": $$$25,
+    "vtex/loaders/logistics/listStockByStore.ts": $$$26,
+    "vtex/loaders/masterdata/searchDocuments.ts": $$$27,
+    "vtex/loaders/navbar.ts": $$$28,
+    "vtex/loaders/options/productIdByTerm.ts": $$$29,
+    "vtex/loaders/orders/getById.ts": $$$30,
+    "vtex/loaders/orders/list.ts": $$$31,
+    "vtex/loaders/orders/orderplaced.ts": $$$32,
+    "vtex/loaders/paths/PDPDefaultPath.ts": $$$33,
+    "vtex/loaders/paths/PLPDefaultPath.ts": $$$34,
+    "vtex/loaders/payment/paymentSystems.ts": $$$35,
+    "vtex/loaders/payment/userPayments.ts": $$$36,
+    "vtex/loaders/product/extend.ts": $$$37,
+    "vtex/loaders/product/extensions/detailsPage.ts": $$$38,
+    "vtex/loaders/product/extensions/list.ts": $$$39,
+    "vtex/loaders/product/extensions/listingPage.ts": $$$40,
+    "vtex/loaders/product/extensions/suggestions.ts": $$$41,
+    "vtex/loaders/product/wishlist.ts": $$$42,
+    "vtex/loaders/profile/getCurrentProfile.ts": $$$43,
+    "vtex/loaders/profile/getProfileByEmail.ts": $$$44,
+    "vtex/loaders/promotion/getPromotionById.ts": $$$45,
+    "vtex/loaders/proxy.ts": $$$46,
+    "vtex/loaders/session/getSession.ts": $$$47,
+    "vtex/loaders/session/getUserSessions.ts": $$$48,
+    "vtex/loaders/user.ts": $$$49,
+    "vtex/loaders/wishlist.ts": $$$50,
+    "vtex/loaders/workflow/product.ts": $$$51,
+    "vtex/loaders/workflow/products.ts": $$$52,
   },
   "handlers": {
     "vtex/handlers/sitemap.ts": $$$$0,
@@ -209,10 +210,9 @@ const manifest = {
     "vtex/actions/session/createSession.ts": $$$$$$$$$39,
     "vtex/actions/session/deleteSession.ts": $$$$$$$$$40,
     "vtex/actions/session/editSession.ts": $$$$$$$$$41,
-    "vtex/actions/sessions/delete.ts": $$$$$$$$$42,
-    "vtex/actions/trigger.ts": $$$$$$$$$43,
-    "vtex/actions/wishlist/addItem.ts": $$$$$$$$$44,
-    "vtex/actions/wishlist/removeItem.ts": $$$$$$$$$45,
+    "vtex/actions/trigger.ts": $$$$$$$$$42,
+    "vtex/actions/wishlist/addItem.ts": $$$$$$$$$43,
+    "vtex/actions/wishlist/removeItem.ts": $$$$$$$$$44,
   },
   "workflows": {
     "vtex/workflows/events.ts": $$$$$$$$$$0,
diff --git a/vtex/utils/client.ts b/vtex/utils/client.ts
index e3de28007..e484cdb20 100644
--- a/vtex/utils/client.ts
+++ b/vtex/utils/client.ts
@@ -3,6 +3,7 @@ import {
   AuthResponse,
   Brand,
   Category,
+  CorrectionSearchResult,
   CreateNewDocument,
   FacetSearchResult,
   InstallmentOption,
@@ -168,7 +169,13 @@ export interface VTEXCommerceStable {
       "zip-code"?: string;
     };
   };
-
+  "GET /api/io/_v/api/intelligent-search/correction_search": {
+    response: CorrectionSearchResult;
+    searchParams: {
+      query: string;
+      locale?: string;
+    };
+  };
   "GET /api/checkout/changeToAnonymousUser/:orderFormId": {
     response: OrderForm;
     searchParams: { sc?: string };
diff --git a/vtex/utils/types.ts b/vtex/utils/types.ts
index 0d56e56f0..58061b862 100644
--- a/vtex/utils/types.ts
+++ b/vtex/utils/types.ts
@@ -970,6 +970,15 @@ export interface SpecificationGroup {
   }>;
 }
 
+export interface CorrectionSearchResult {
+  correction: {
+    correction: boolean;
+    misspelled: boolean;
+    text?: string;
+    highlighted?: string;
+  };
+}
+
 export type FilterType = RangeFacet["type"] | BooleanFacet["type"];
 
 export interface FacetSearchResult {

From a3f6d9c5ceda36f0eebd91d7270f132ddb3b74e9 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Sat, 14 Mar 2026 18:40:23 -0400
Subject: [PATCH 92/93] fix: reading property of undefdined

---
 website/components/OneDollarStats.tsx | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/website/components/OneDollarStats.tsx b/website/components/OneDollarStats.tsx
index 65ef65807..9527978b4 100644
--- a/website/components/OneDollarStats.tsx
+++ b/website/components/OneDollarStats.tsx
@@ -44,7 +44,7 @@ const oneDollarSnippet = () => {
   // 2000 bytes limit
   const truncate = (str: string) => `${str}`.slice(0, 990);
 
-  globalThis.window.DECO.events.subscribe((event) => {
+  globalThis?.window?.DECO?.events?.subscribe((event) => {
     if (!event || event.name !== "deco") {
       return;
     }
@@ -60,7 +60,7 @@ const oneDollarSnippet = () => {
     trackPageview();
   })();
 
-  globalThis.window.DECO.events.subscribe((event) => {
+  globalThis?.window?.DECO?.events?.subscribe((event) => {
     if (!event) {
       return;
     }

From 9d11d708f44dc711446acb9fefc28b2f07da0c65 Mon Sep 17 00:00:00 2001
From: vitoUwu <victorhugomeurerdelgrandi@gmail.com>
Date: Wed, 1 Apr 2026 15:22:59 -0400
Subject: [PATCH 93/93] fix: prioritize checkout cookies over auth cookie on
 order placed loader

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
---
 vtex/loaders/orders/orderplaced.ts | 42 +++++++++++++++++++++++-------
 1 file changed, 32 insertions(+), 10 deletions(-)

diff --git a/vtex/loaders/orders/orderplaced.ts b/vtex/loaders/orders/orderplaced.ts
index 90308f7ab..8722645e2 100644
--- a/vtex/loaders/orders/orderplaced.ts
+++ b/vtex/loaders/orders/orderplaced.ts
@@ -11,6 +11,37 @@ interface Props {
   orderId: string;
 }
 
+/**
+ * Checkout cookies (CheckoutDataAccess + Vtex_CHKO_Auth) are set by VTEX right
+ * after an order is placed and are sufficient — and preferred — to access the
+ * order-placed page. The VtexIdclientAutCookie_* auth cookie can still be
+ * present in the browser even after it has expired, so sending it alongside the
+ * checkout cookies (or on its own when stale) causes the request to fail.
+ * Strategy: use checkout cookies when available; fall back to the auth cookie
+ * only when they are absent.
+ */
+function resolveOrderCookie(headers: Headers): string {
+  const all = getCookies(headers);
+
+  const checkoutCookies = Object.fromEntries(
+    Object.entries(all).filter(([key]) =>
+      key === CHECKOUT_DATA_ACCESS_COOKIE || key === VTEX_CHKO_AUTH
+    ),
+  );
+
+  if (Object.keys(checkoutCookies).length > 0) {
+    return stringify(checkoutCookies);
+  }
+
+  const authCookies = Object.fromEntries(
+    Object.entries(all).filter(([key]) =>
+      key.startsWith(VTEX_ID_CLIENT_COOKIE)
+    ),
+  );
+
+  return stringify(authCookies);
+}
+
 /**
  * @title Get Order Placed Order Details
  * @description Should be used on order placed page, the user must be authenticated or have access to the order through permissions or cookies
@@ -21,16 +52,7 @@ export default async function loader(
   ctx: AppContext,
 ) {
   const { vcsDeprecated } = ctx;
-  const cookies = Object.fromEntries(
-    Object.entries(getCookies(req.headers)).filter(([key]) =>
-      key.startsWith(VTEX_ID_CLIENT_COOKIE) ||
-      // these two cookies are set by VTEX after order is placed on checkout and are
-      // used to access the order placed page
-      key === CHECKOUT_DATA_ACCESS_COOKIE ||
-      key === VTEX_CHKO_AUTH
-    ),
-  );
-  const cookie = stringify(cookies);
+  const cookie = resolveOrderCookie(req.headers);
 
   const isOrderGroup = !orderId.includes("-");