{"openapi":"3.0.0","servers":[{"url":"https://vtex.local"},{"description":"VTEX server url","url":"https://{accountName}.{environment}.com.br","variables":{"accountName":{"default":"{accountName}","description":"Name of the VTEX account. Used as part of the URL"},"environment":{"default":"{environment}","description":"Environment to use. Used as part of the URL."}}}],"info":{"contact":{},"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/vtex-rest-api/reference/cartsimulation)\r\n- [GET - Get current or create a new cart](https://developers.vtex.com/vtex-rest-api/reference/createanewcart)\r\n- [GET - Get cart information by ID](https://developers.vtex.com/vtex-rest-api/reference/getcartinformationbyid)\r\n- [POST - Remove all items](https://developers.vtex.com/vtex-rest-api/reference/removeallitems)\r\n- [GET - Remove all personal data](https://developers.vtex.com/vtex-rest-api/reference/removeallpersonaldata)\r\n- [POST - Update cart items](https://developers.vtex.com/vtex-rest-api/reference/itemsupdate)\r\n- [POST - Add cart items](https://developers.vtex.com/vtex-rest-api/reference/items)\r\n- [PUT - Change price](https://developers.vtex.com/vtex-rest-api/reference/pricechange)\r\n- [PATCH - Ignore profile data](https://developers.vtex.com/vtex-rest-api/reference/ignoreprofiledata)\r\n- [GET - Cart installments](https://developers.vtex.com/vtex-rest-api/reference/getcartinstallments)\r\n- [POST - Add coupons to the cart](https://developers.vtex.com/vtex-rest-api/reference/addcoupons)\r\n\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/vtex-rest-api/reference/getclientprofilebyemail)\r\n- [POST - Add client profile](https://developers.vtex.com/vtex-rest-api/reference/addclientprofile)\r\n- [POST - Add shipping address and select delivery option](https://developers.vtex.com/vtex-rest-api/reference/addshippingaddress)\r\n- [POST - Add client preferences](https://developers.vtex.com/vtex-rest-api/reference/addclientpreferences)\r\n- [POST - Add marketing data](https://developers.vtex.com/vtex-rest-api/reference/addmarketingdata)\r\n- [POST - Add payment data](https://developers.vtex.com/vtex-rest-api/reference/addpaymentdata)\r\n- [POST - Add merchant context data](https://developers.vtex.com/vtex-rest-api/reference/addmerchantcontextdata)\r\n\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/vtex-rest-api/reference/setmultiplecustomfieldvalues)\r\n- [PUT - Set single custom field value](https://developers.vtex.com/vtex-rest-api/reference/setsinglecustomfieldvalue)\r\n- [DELETE - Remove single custom field value](https://developers.vtex.com/vtex-rest-api/reference/removesinglecustomfieldvalue)\r\n\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/vtex-rest-api/reference/getorderformconfiguration)\r\n- [POST - Update orderForm configuration](https://developers.vtex.com/vtex-rest-api/reference/updateorderformconfiguration)\r\n- [GET - Get window to change seller](https://developers.vtex.com/vtex-rest-api/reference/getwindowtochangeseller)\r\n- [POST - Update window to change seller](https://developers.vtex.com/vtex-rest-api/reference/updatewindowtochangeseller)\r\n- [POST - Clear orderForm messages](https://developers.vtex.com/vtex-rest-api/reference/clearorderformmessages)\r\n\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/vtex-rest-api/reference/listpickupppointsbylocation)\r\n- [GET - Get address by postal code](https://developers.vtex.com/vtex-rest-api/reference/getaddressbypostalcode)\r\n\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/vtex-rest-api/reference/placeorderfromexistingorderform)\r\n- [PUT - Place order](https://developers.vtex.com/vtex-rest-api/reference/placeorder)\r\n- [POST - Process order](https://developers.vtex.com/vtex-rest-api/reference/processorder)\r\n\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/vtex-rest-api/reference/getsellersbyregion)","title":"Checkout API","version":"1.0","x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/vtex/openapi-schemas/master/VTEX - Checkout API.json","version":"3.0"}],"x-providerName":"vtex.local","x-serviceName":"Checkout-API"},"security":[{"appKey":[],"appToken":[]}],"tags":[{"name":"Shopping cart"},{"name":"Cart attachments"},{"name":"Custom data"},{"name":"Configuration"},{"name":"Fulfillment"},{"name":"Order placement"},{"name":"Region"}],"paths":{"/api/checkout/pub/gatewayCallback/{orderGroup}":{"post":{"deprecated":false,"description":"Order processing callback request, which is made after an order's payment is approved.\n\r\n\r> This request has to be made until five minutes after the [Place order](https://developers.vtex.com/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.","operationId":"ProcessOrder","parameters":[{"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`.","in":"path","name":"orderGroup","required":true,"schema":{"default":"123456789","type":"string"},"style":"simple"},{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"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.","in":"header","name":"Cookie","required":true,"schema":{"default":"Vtex_CHKO_Auth=0e/RpYIEZu19BuwXB4tZ7eIGu9HT8vdUAHWQDHDpxMc=; CheckoutDataAccess=0e/PoiTEZu19BuwXB4tZ7eIGu9HT8vdUAHWQDHDpxMc=","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":{}}},"description":"OK"},"500":{"content":{"application/json":{"example":{"error":{"code":"001","exception":null,"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. *** "},"operationId":"a231ed11-255b-4ea0-96c3-1790e1b27f7e"},"schema":{"properties":{"error":{"description":"Information on the error.","properties":{"code":{"description":"Error code.","type":"string"},"exception":{"description":"Error exception.","nullable":true,"type":"string"},"message":{"description":"Error message.","type":"string"}},"type":"object"},"operationId":{"description":"Operation ID.","type":"string"}},"type":"object"}}},"description":"Internal Server Error"}},"security":[],"summary":"Process order","tags":["Order placement"]}},"/api/checkout/pub/orderForm":{"get":{"deprecated":false,"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","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Use this query parameter to create a new empty shopping cart.","in":"query","name":"forceNewCart","required":false,"schema":{"default":true,"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"allowManualPrice":false,"canEditData":true,"checkedInPickupPointId":null,"clientPreferencesData":{"locale":"pt-BR","optinNewsLetter":null},"clientProfileData":{"corporateDocument":null,"corporateName":null,"corporatePhone":null,"customerClass":null,"document":null,"documentType":null,"email":null,"firstName":null,"isCorporate":false,"lastName":null,"phone":null,"profileCompleteOnLoading":null,"profileErrorOnLoading":null,"stateInscription":null,"tradeName":null},"commercialConditionData":null,"customData":null,"giftRegistryData":null,"hooksData":null,"ignoreProfileData":false,"invoiceData":null,"isCheckedIn":false,"itemMetadata":null,"items":[],"itemsOrdination":null,"loggedIn":false,"marketingData":null,"messages":[],"openTextField":null,"orderFormId":"9ceee0fde6db489fbc682a0e2ab13a86","paymentData":{"availableAccounts":[],"availableTokens":[],"giftCardMessages":[],"giftCards":[],"installmentOptions":[],"paymentSystems":[],"payments":[]},"ratesAndBenefitsData":null,"salesChannel":"1","selectableGifts":[],"sellers":[],"shippingData":null,"storeId":null,"storePreferencesData":{"countryCode":"BRA","currencyCode":"BRL","currencyFormatInfo":{"currencyDecimalDigits":2,"currencyDecimalSeparator":",","currencyGroupSeparator":".","currencyGroupSize":3,"startsWithCurrencySymbol":true},"currencyLocale":1046,"currencySymbol":"R$","saveUserData":true,"timeZone":"E. South America Standard Time"},"subscriptionData":null,"totalizers":[],"userProfileId":null,"userType":null,"value":0}}},"description":"OK"}},"security":[],"summary":"Get current or create a new cart","tags":["Shopping cart"]}},"/api/checkout/pub/orderForm/{orderFormId}":{"get":{"deprecated":false,"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","parameters":[{"description":"ID of the orderForm corresponding to the cart whose information you want to retrieve.","in":"path","name":"orderFormId","required":true,"schema":{"default":"ede846222cd44046ba6c638442c3505a","type":"string"},"style":"simple"},{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"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.","in":"query","name":"refreshOutdatedData","required":false,"schema":{"default":true,"type":"boolean"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"allowManualPrice":false,"canEditData":true,"checkedInPickupPointId":null,"clientPreferencesData":{"locale":"pt-BR","optinNewsLetter":null},"clientProfileData":{"corporateDocument":null,"corporateName":null,"corporatePhone":null,"customerClass":null,"document":"12345678900","documentType":"cpf","email":"clark.kent@examplemail.com","firstName":"Clark","isCorporate":false,"lastName":"Kent","phone":"+5500123456789","profileCompleteOnLoading":false,"profileErrorOnLoading":false,"stateInscription":null,"tradeName":null},"commercialConditionData":null,"customData":null,"giftRegistryData":null,"hooksData":null,"ignoreProfileData":false,"invoiceData":null,"isCheckedIn":false,"itemMetadata":{"items":[{"assemblyOptions":[],"detailUrl":"/racao-royal-canin-feline-urinary/p","ean":"123456789","id":"1","imageUrl":"http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000","name":"Ração Royal Canin Feline Urinary 500g","productId":"1","refId":"0001","seller":"1","skuName":"Ração Royal Canin Feline Urinary 500g"}]},"items":[{"additionalInfo":{"brandId":"2000000","brandName":"Royal Canin","offeringInfo":null,"offeringType":null,"offeringTypeId":null},"assemblies":[],"attachmentOfferings":[],"attachments":[],"availability":"available","bundleItems":[],"components":[],"detailUrl":"/racao-royal-canin-feline-urinary/p","ean":"123456789","id":"1","imageUrl":"http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000","isGift":false,"listPrice":30000,"manualPrice":null,"manufacturerCode":null,"measurementUnit":"un","modalType":null,"name":"Ração Royal Canin Feline Urinary 500g","offerings":[],"parentAssemblyBinding":null,"parentItemIndex":null,"preSaleDate":null,"price":15000,"priceTags":[],"priceValidUntil":"2025-04-15T13:52:27.978Z","productCategories":{"1":"Alimentação","10":"Ração Seca"},"productCategoryIds":"/1/10/","productId":"1","productRefId":"","quantity":1,"refId":"0001","rewardValue":0,"seller":"1","sellerChain":["1"],"sellingPrice":15000,"skuName":"Ração Royal Canin Feline Urinary 500g","tax":0,"uniqueId":"E0F2B7AF5CD74D668F1E27537206912C","unitMultiplier":1}],"itemsOrdination":null,"loggedIn":false,"marketingData":null,"messages":[],"openTextField":null,"orderFormId":"ede846222cd44046ba6c638442c3505a","paymentData":{"availableAccounts":[],"availableTokens":[],"giftCardMessages":[],"giftCards":[],"installmentOptions":[{"bin":null,"installments":[{"count":1,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":1,"hasInterestRate":false,"id":"LOJADOBRENO","interestRate":0,"total":15000,"value":15000}],"total":15000,"value":15000},{"count":2,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":2,"hasInterestRate":false,"id":"LOJADOBRENO","interestRate":0,"total":15000,"value":7500}],"total":15000,"value":7500}],"paymentGroupName":null,"paymentName":null,"paymentSystem":"2","value":15000}],"paymentSystems":[{"availablePayments":null,"description":null,"dueDate":"2025-04-15T13:52:27.978Z","groupName":"creditCardPaymentGroup","id":2,"isCustom":false,"name":"Visa","requiresAuthentication":false,"requiresDocument":false,"stringId":"2","template":"creditCardPaymentGroup-template","validator":{"cardCodeMask":"999","cardCodeRegex":"^[0-3]{8}$","mask":"9999 9999 9999 9999","regex":"^2[1-8]{17}$","useBillingAddress":true,"useCardHolderName":true,"useCvv":true,"useExpirationDate":true,"weights":[2,1,2,1,2,1]}}],"payments":[]},"ratesAndBenefitsData":{"rateAndBenefitsIdentifiers":[],"teaser":[]},"salesChannel":"1","selectableGifts":[],"sellers":[{"id":"1","logo":"","name":"lojadobreno"}],"shippingData":{"address":null,"availableAddresses":[],"logisticsInfo":[{"addressId":null,"deliveryChannels":[{"id":"pickup-in-point"},{"id":"delivery"}],"itemId":"1","itemIndex":0,"selectedDeliveryChannel":null,"selectedSla":null,"shipsTo":["BRA"],"slas":[]}],"pickupPoints":[],"selectedAddresses":[]},"storeId":null,"storePreferencesData":{"countryCode":"BRA","currencyCode":"BRL","currencyFormatInfo":{"currencyDecimalDigits":2,"currencyDecimalSeparator":",","currencyGroupSeparator":".","currencyGroupSize":3,"startsWithCurrencySymbol":true},"currencyLocale":1046,"currencySymbol":"R$","saveUserData":true,"timeZone":"E. South America Standard Time"},"subscriptionData":null,"totalizers":[{"id":"Items","name":"Total dos Itens","value":15000}],"userProfileId":null,"userType":null,"value":15000}}},"description":"","headers":{}}},"security":[],"summary":"Get cart information by ID","tags":["Shopping cart"]}},"/api/checkout/pub/orderForm/{orderFormId}/attachments/clientPreferencesData":{"post":{"deprecated":false,"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","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"ID of the orderForm that will receive client profile information.","in":"path","name":"orderFormId","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"locale":{"default":"EN","description":"Locale chosen by the shopper. Determines website language.","type":"string"},"optinNewsLetter":{"default":false,"description":"Indicates whether the shopper opted in to receive the store's news letter.","type":"boolean"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"allowManualPrice":false,"canEditData":true,"checkedInPickupPointId":null,"clientPreferencesData":{"locale":"PT","optinNewsLetter":false},"clientProfileData":null,"commercialConditionData":null,"customData":null,"giftRegistryData":null,"hooksData":null,"ignoreProfileData":false,"invoiceData":null,"isCheckedIn":false,"itemMetadata":null,"items":[],"itemsOrdination":null,"loggedIn":false,"marketingData":null,"messages":[],"openTextField":null,"orderFormId":"a7e4702410864239959f9bdcf77e3fba","paymentData":{"availableAccounts":[],"availableTokens":[],"giftCardMessages":[],"giftCards":[],"installmentOptions":[],"paymentSystems":[],"payments":[],"updateStatus":"updated"},"ratesAndBenefitsData":null,"salesChannel":"1","selectableGifts":[],"sellers":[],"shippingData":null,"storeId":null,"storePreferencesData":{"countryCode":"BRA","currencyCode":"BRL","currencyFormatInfo":{"currencyDecimalDigits":2,"currencyDecimalSeparator":",","currencyGroupSeparator":".","currencyGroupSize":3,"startsWithCurrencySymbol":true},"currencyLocale":1046,"currencySymbol":"R$","saveUserData":true,"timeZone":"E. South America Standard Time"},"subscriptionData":null,"totalizers":[],"userProfileId":null,"userType":null,"value":0},"schema":{}}},"description":"OK"}},"security":[],"summary":"Add client preferences","tags":["Cart attachments"]}},"/api/checkout/pub/orderForm/{orderFormId}/attachments/clientProfileData":{"post":{"deprecated":false,"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","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"ID of the orderForm that will receive client profile information.","in":"path","name":"orderFormId","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"description":"Customer's profile information.","properties":{"corporateDocument":{"default":"12345678000100","description":"Corporate document, if the customer is a legal entity.","type":"string"},"corporateName":{"default":"company-name","description":"Company name, if the customer is a legal entity.","type":"string"},"corporatePhone":{"default":"+551100988887777","description":"Corporate phone number, if the customer is a legal entity.","type":"string"},"document":{"default":"123456789","description":"Document number informed by the customer.","type":"string"},"documentType":{"default":"cpf","description":"Type of the document informed by the customer.","type":"string"},"email":{"default":"customer@examplemail.com","description":"Customer's email address.","type":"string"},"firstName":{"default":"first-name","description":"Customer's first name.","type":"string"},"isCorporate":{"default":false,"description":"`true` if the customer is a legal entity.","type":"boolean"},"lastName":{"default":"last-name","description":"Customer's last name.","type":"string"},"phone":{"default":"+55110988887777","description":"Customer's phone number.","type":"string"},"stateInscription":{"default":"12345678","description":"State inscription, if the customer is a legal entity.","type":"string"},"tradeName":{"default":"trade-name","description":"Trade name, if the customer is a legal entity.","type":"string"}},"required":["email","firstName","lastName","documentType","document"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"allowManualPrice":false,"canEditData":true,"checkedInPickupPointId":null,"clientPreferencesData":{"locale":"pt-BR","optinNewsLetter":null},"clientProfileData":{"corporateDocument":null,"corporateName":null,"corporatePhone":null,"customerClass":null,"document":"44444444444","documentType":"cpf","email":"clark.kent@examplemail.com","firstName":"Clark","isCorporate":false,"lastName":"Kent","phone":"+5511123456789","profileCompleteOnLoading":false,"profileErrorOnLoading":false,"stateInscription":null,"tradeName":null},"commercialConditionData":null,"customData":null,"giftRegistryData":null,"hooksData":null,"ignoreProfileData":false,"invoiceData":null,"isCheckedIn":false,"itemMetadata":null,"items":[],"itemsOrdination":null,"loggedIn":false,"marketingData":null,"messages":[],"openTextField":null,"orderFormId":"9ceee0fde6db489fbc809a0e2ab13a86","paymentData":{"availableAccounts":[],"availableTokens":[],"giftCardMessages":[],"giftCards":[],"installmentOptions":[],"paymentSystems":[],"payments":[],"updateStatus":"updated"},"ratesAndBenefitsData":null,"salesChannel":"1","selectableGifts":[],"sellers":[],"shippingData":null,"storeId":null,"storePreferencesData":{"countryCode":"BRA","currencyCode":"BRL","currencyFormatInfo":{"currencyDecimalDigits":2,"currencyDecimalSeparator":",","currencyGroupSeparator":".","currencyGroupSize":3,"startsWithCurrencySymbol":true},"currencyLocale":1046,"currencySymbol":"R$","saveUserData":true,"timeZone":"E. South America Standard Time"},"subscriptionData":null,"totalizers":[],"userProfileId":null,"userType":null,"value":0}}},"description":"OK","headers":{}}},"security":[],"summary":"Add client profile","tags":["Cart attachments"]}},"/api/checkout/pub/orderForm/{orderFormId}/attachments/marketingData":{"post":{"deprecated":false,"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","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"ID of the orderForm that will receive client profile information.","in":"path","name":"orderFormId","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"coupon":{"default":"free-shipping","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.","type":"string"},"marketingTags":{"default":["tag1","tag2"],"description":"Marketing tags.","items":{"type":"string"},"type":"array"},"utmCampaign":{"default":"Black friday","description":"UTM campaign","type":"string"},"utmMedium":{"default":"CPC","description":"UTM medium.","type":"string"},"utmSource":{"default":"Facebook","description":"UTM source.","type":"string"},"utmiCampaign":{"default":"utmi_campaign-exmaple","description":"utmi_campaign (internal utm)","type":"string"},"utmiPage":{"default":"utmi_page-example","description":"utmi_page (internal utm)","type":"string"},"utmiPart":{"default":"utmi_part-exmaple","description":"utmi_part (internal utm)","type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"allowManualPrice":false,"canEditData":true,"checkedInPickupPointId":null,"clientPreferencesData":{"locale":"pt-BR","optinNewsLetter":null},"clientProfileData":null,"commercialConditionData":null,"customData":null,"giftRegistryData":null,"hooksData":null,"ignoreProfileData":false,"invoiceData":null,"isCheckedIn":false,"itemMetadata":null,"items":[],"itemsOrdination":null,"loggedIn":false,"marketingData":{"coupon":"free-shipping","marketingTags":["tag1","tag2"],"utmCampaign":"Black friday","utmMedium":"CPC","utmSource":"app","utmiCampaign":null,"utmiPart":null,"utmipage":null},"messages":[],"openTextField":null,"orderFormId":"7c5b47971fad41b89102c7ab7bb8b08b","paymentData":{"availableAccounts":[],"availableTokens":[],"giftCardMessages":[],"giftCards":[],"installmentOptions":[],"paymentSystems":[],"payments":[],"updateStatus":"updated"},"ratesAndBenefitsData":null,"salesChannel":"1","selectableGifts":[],"sellers":[],"shippingData":null,"storeId":null,"storePreferencesData":{"countryCode":"BRA","currencyCode":"BRL","currencyFormatInfo":{"currencyDecimalDigits":2,"currencyDecimalSeparator":",","currencyGroupSeparator":".","currencyGroupSize":3,"startsWithCurrencySymbol":true},"currencyLocale":1046,"currencySymbol":"R$","saveUserData":true,"timeZone":"E. South America Standard Time"},"subscriptionData":null,"totalizers":[],"userProfileId":null,"userType":null,"value":0}}},"description":"OK"}},"security":[],"summary":"Add marketing data","tags":["Cart attachments"]}},"/api/checkout/pub/orderForm/{orderFormId}/attachments/merchantContextData":{"post":{"deprecated":false,"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","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"ID of the orderForm that will receive the relevant information added by the merchant.","example":"29154e27383145cc8ce1f7a1df0d99c4","in":"path","name":"orderFormId","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"salesAssociateData":{"description":"Sales Associate information.","properties":{"salesAssociateId":{"default":"seller123","description":"Sales Associate (Seller) identification code. All information should be registered by the merchant. Maximum of 100 characters.","type":"string"}},"type":"object"}},"required":["salesAssociateData"],"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"salesAssociateData":{"salesAssociateId":"seller123"}},"schema":{"properties":{"salesAssociateId":{"description":"Sales Associate (Seller) identification code.","type":"string"}},"type":"object"}}},"description":"OK"}},"security":[],"summary":"Add merchant context data","tags":["Cart attachments"]}},"/api/checkout/pub/orderForm/{orderFormId}/attachments/paymentData":{"post":{"deprecated":false,"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","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"ID of the orderForm that will receive client profile information.","in":"path","name":"orderFormId","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"payments":{"description":"Array with information on each payment chosen by the shopper.","items":{"properties":{"group":{"default":"bankInvoicePaymentGroup","description":"Payment system group.","type":"string"},"hasDefaultBillingAddress":{"default":false,"description":"Indicates whether billing address for this payment is the default address.","type":"boolean"},"installments":{"default":1,"description":"Selected number of installments.","type":"integer"},"installmentsInterestRate":{"default":0,"description":"Installments' interest rate.","type":"number"},"installmentsValue":{"default":1,"description":"Value of the installments.","type":"integer"},"paymentSystem":{"default":1,"description":"Payment system ID.","type":"integer"},"paymentSystemName":{"default":"Boleto Bancário","description":"Payment system name.","type":"string"},"referenceValue":{"default":100,"description":"Reference value used to calculate total order value with interest.","type":"integer"},"value":{"default":100,"description":"Total value assigned to this payment.","type":"integer"}},"type":"object"},"type":"array"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"allowManualPrice":false,"canEditData":true,"checkedInPickupPointId":null,"clientPreferencesData":{"locale":"pt-BR","optinNewsLetter":null},"clientProfileData":null,"commercialConditionData":null,"customData":null,"giftRegistryData":null,"hooksData":null,"ignoreProfileData":false,"invoiceData":null,"isCheckedIn":false,"itemMetadata":{"items":[{"assemblyOptions":[],"detailUrl":"/chopp-claro-30l/p","ean":null,"id":"2","imageUrl":"http://myshop.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000","name":"Chopp Claro 30L","productId":"2","refId":"CBC30L","seller":"1","skuName":"Chopp Claro 30L"}]},"items":[{"additionalInfo":{"brandId":"2000000","brandName":"Beershow","dimension":null,"offeringInfo":null,"offeringType":null,"offeringTypeId":null},"assemblies":[],"attachmentOfferings":[],"attachments":[],"availability":"available","bundleItems":[],"components":[],"detailUrl":"/chopp-claro-30l/p","ean":null,"id":"2","imageUrl":"http://myshop.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000","isGift":false,"listPrice":49900,"manualPrice":null,"manualPriceAppliedBy":null,"manufacturerCode":null,"measurementUnit":"un","modalType":null,"name":"Chopp Claro 30L","offerings":[],"parentAssemblyBinding":null,"parentItemIndex":null,"preSaleDate":null,"price":32890,"priceDefinition":{"calculatedSellingPrice":32890,"sellingPrices":[{"quantity":2,"value":32890}],"total":65780},"priceTags":[],"priceValidUntil":"2025-04-15T13:52:27.982Z","productCategories":{"1":"Bebidas"},"productCategoryIds":"/1/","productId":"2","productRefId":"","quantity":2,"refId":"CBC30L","rewardValue":0,"seller":"1","sellerChain":["1"],"sellingPrice":32890,"skuName":"Chopp Claro 30L","tax":0,"uniqueId":"3CBFA140CE8F4E208062FC15CE9ED8D3","unitMultiplier":1}],"itemsOrdination":null,"loggedIn":false,"marketingData":null,"messages":[],"openTextField":null,"orderFormId":"29154e27383145cc8ce1f7a1df0d99c4","paymentData":{"availableAccounts":[],"availableTokens":[],"giftCardMessages":[],"giftCards":[],"installmentOptions":[{"bin":null,"installments":[{"count":1,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":1,"hasInterestRate":false,"id":"MYSHOP","interestRate":0,"total":65780,"value":65780}],"total":65780,"value":65780}],"paymentGroupName":null,"paymentName":null,"paymentSystem":"2","value":65780},{"bin":null,"installments":[{"count":1,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":1,"hasInterestRate":false,"id":"MYSHOP","interestRate":0,"total":65780,"value":65780}],"total":65780,"value":65780}],"paymentGroupName":null,"paymentName":null,"paymentSystem":"4","value":65780},{"bin":null,"installments":[{"count":1,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":1,"hasInterestRate":false,"id":"MYSHOP","interestRate":0,"total":65780,"value":65780}],"total":65780,"value":65780}],"paymentGroupName":null,"paymentName":null,"paymentSystem":"6","value":65780}],"paymentSystems":[{"availablePayments":null,"description":null,"dueDate":"2025-04-15T13:52:27.982Z","groupName":"creditCardPaymentGroup","id":2,"isCustom":false,"name":"Visa","requiresAuthentication":false,"requiresDocument":false,"stringId":"2","template":"creditCardPaymentGroup-template","validator":{"cardCodeMask":"999","cardCodeRegex":"^[0-9]{3}$","mask":"9999 9999 9999 9999","regex":"^4[0-9]{15}$","useBillingAddress":true,"useCardHolderName":true,"useCvv":true,"useExpirationDate":true,"weights":[2,1,2,1,2,1,2,1,2,1,2,1,2,1,2,1,2,1,2]}},{"availablePayments":null,"description":null,"dueDate":"2025-04-15T13:52:27.983Z","groupName":"creditCardPaymentGroup","id":4,"isCustom":false,"name":"Mastercard","requiresAuthentication":false,"requiresDocument":false,"stringId":"4","template":"creditCardPaymentGroup-template","validator":{"cardCodeMask":"999","cardCodeRegex":"^[0-9]{3}$","mask":"9999 9999 9999 9999","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})","useBillingAddress":true,"useCardHolderName":true,"useCvv":true,"useExpirationDate":true,"weights":[2,1,2,1,2,1,2,1,2,1,2,1,2,1,2,1,2,1,2]}},{"availablePayments":null,"description":null,"dueDate":"2025-04-15T13:52:27.983Z","groupName":"bankInvoicePaymentGroup","id":6,"isCustom":false,"name":"Boleto Bancário","requiresAuthentication":false,"requiresDocument":false,"stringId":"6","template":"bankInvoicePaymentGroup-template","validator":{"cardCodeMask":null,"cardCodeRegex":null,"mask":null,"regex":null,"useBillingAddress":false,"useCardHolderName":false,"useCvv":false,"useExpirationDate":false,"weights":null}}],"payments":[{"accountId":null,"bin":null,"installments":1,"merchantSellerPayments":[{"id":"MYSHOP","installmentValue":65780,"installments":1,"interestRate":0,"referenceValue":65780,"value":65780}],"paymentSystem":"6","referenceValue":65780,"tokenId":null,"value":65780}],"updateStatus":"updated"},"ratesAndBenefitsData":{"rateAndBenefitsIdentifiers":[],"teaser":[]},"salesChannel":"1","selectableGifts":[],"sellers":[{"id":"1","logo":"","name":"My Seller"}],"shippingData":{"address":null,"availableAddresses":[],"logisticsInfo":[{"addressId":null,"deliveryChannels":[{"id":"delivery"},{"id":"pickup-in-point"}],"itemId":"2","itemIndex":0,"selectedDeliveryChannel":null,"selectedSla":null,"shipsTo":["BRA","COL","USA"],"slas":[]}],"pickupPoints":[],"selectedAddresses":[]},"storeId":null,"storePreferencesData":{"countryCode":"BRA","currencyCode":"BRL","currencyFormatInfo":{"currencyDecimalDigits":2,"currencyDecimalSeparator":",","currencyGroupSeparator":".","currencyGroupSize":3,"startsWithCurrencySymbol":true},"currencyLocale":1046,"currencySymbol":"R$","saveUserData":true,"timeZone":"E. South America Standard Time"},"subscriptionData":null,"totalizers":[{"id":"Items","name":"Total dos Itens","value":65780}],"userProfileId":null,"userType":null,"value":65780}}},"description":"","headers":{}}},"security":[],"summary":"Add payment data","tags":["Cart attachments"]}},"/api/checkout/pub/orderForm/{orderFormId}/attachments/shippingData":{"post":{"deprecated":false,"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","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"ID of the orderForm that will receive client profile information.","in":"path","name":"orderFormId","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"clearAddressIfPostalCodeNotFound":{"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,"type":"boolean"},"logisticsInfo":{"description":"Array with logistics information on each item of the `items` array in the `orderForm`.","items":{"properties":{"itemIndex":{"default":0,"description":"Index of item in items array","type":"integer"},"selectedDeliveryChannel":{"default":"delivery","description":"Delivery channel selected by the customer. For example, `\"delivery\"` or `\"pickup-in-point\"`.","type":"string"},"selectedSla":{"default":"normal","description":"Selected SLA. For example, `\"normal\"` or `\"express\"`.","type":"string"}},"type":"object"},"type":"array"},"selectedAddresses":{"description":"List of objects with addresses information.","items":{"properties":{"addressType":{"description":"Type of address. For example, `Residential` or `Pickup`, among others.","example":"residential","type":"string"},"city":{"description":"City of the shipping address.","example":"Rio de Janeiro","type":"string"},"complement":{"description":"Complement to the shipping address in case it applies.","example":"3rd floor","type":"string"},"country":{"description":"Three letter ISO code of the country of the shipping address.","example":"BRA","type":"string"},"geoCoordinates":{"default":[-47.924747467041016,-15.832582473754883],"description":"Array containing two floats with geocoordinates, first longitude, then latitude.","items":{"example":-47.924747467041016,"type":"number"},"type":"array"},"neighborhood":{"description":"Neighborhood of the shipping address.","example":"Botafogo","type":"string"},"number":{"description":"Number of the building, house or apartment in the shipping address.","example":"300","type":"string"},"postalCode":{"description":"Postal Code.","example":"12345-000","type":"string"},"receiverName":{"description":"Name of the person who is going to receive the order.","example":"receiver-name","type":"string"},"reference":{"description":"Complement that might help locate the shipping address more precisely in case of delivery.","example":"Grey building","type":"string"},"state":{"description":"State of the shipping address.","example":"RJ","type":"string"},"street":{"description":"Street of the shipping address.","example":"Praia de Botafogo","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"allowManualPrice":false,"canEditData":true,"checkedInPickupPointId":null,"clientPreferencesData":{"locale":"pt-BR","optinNewsLetter":null},"clientProfileData":null,"commercialConditionData":null,"customData":null,"giftRegistryData":null,"hooksData":null,"ignoreProfileData":false,"invoiceData":null,"isCheckedIn":false,"itemMetadata":null,"items":[],"itemsOrdination":null,"loggedIn":false,"marketingData":null,"messages":[],"openTextField":null,"orderFormId":"2f586e50342a4f87b7e0654c56299e88","paymentData":{"availableAccounts":[],"availableTokens":[],"giftCardMessages":[],"giftCards":[],"installmentOptions":[],"paymentSystems":[],"payments":[],"updateStatus":"updated"},"ratesAndBenefitsData":null,"salesChannel":"1","selectableGifts":[],"sellers":[],"shippingData":{"address":{"addressId":"c3701fc4c61b4d1b91f67e81415db44d","addressType":"residential","city":"Rio de Janeiro","complement":null,"country":"BRA","geoCoordinates":[],"isDisposable":true,"neighborhood":"My neighborhood","number":"1091","postalCode":"12345000","receiverName":"Clark Kent","reference":null,"state":"ST","street":"My street"},"availableAddresses":[{"addressId":"ae3173b32bf64663a81fc42b057be211","addressType":"residential","city":"Brasília","complement":null,"country":"BRA","geoCoordinates":[-47.92592239379883,-15.832707405090332],"isDisposable":true,"neighborhood":"Asa Sul","number":"101","postalCode":"70386060","receiverName":"Clark Kent","reference":null,"state":"DF","street":"Quadra SQS 116 Bloco F"},{"addressId":"449dcbe11c5844098fb4545a49cf6e07","addressType":"residential","city":"Brasília","complement":null,"country":"BRA","geoCoordinates":[],"isDisposable":true,"neighborhood":"Asa sul","number":"101","postalCode":"00076555","receiverName":"Clark Kent","reference":null,"state":"DF","street":"My street"},{"addressId":"c3701fc4c61b4d1b91f67e81415db44d","addressType":"residential","city":"Rio de Janeiro","complement":null,"country":"BRA","geoCoordinates":[],"isDisposable":true,"neighborhood":"My neighborhood","number":"1091","postalCode":"12345000","receiverName":"Clark Kent","reference":null,"state":"ST","street":"My street"}],"logisticsInfo":[{"addressId":"f239ad30f8c948a382543ab2c739b967","deliveryChannels":[{"id":"pickup-in-point"},{"id":"delivery"}],"itemId":"2","itemIndex":0,"selectedDeliveryChannel":null,"selectedSla":null,"shipsTo":["BRA","COL","USA"],"slas":[{"availableDeliveryWindows":[],"deliveryChannel":"pickup-in-point","deliveryIds":[{"courierId":"1ee17c2","courierName":"Retira em Loja","dockId":"1","kitItemDetails":[],"quantity":2,"warehouseId":11}],"deliveryWindow":null,"id":"Retirada (VTEXSP)","listPrice":250,"lockTTL":null,"name":"Retirada (VTEXSP)","pickupDistance":15.848081588745117,"pickupPointId":"1_VTEXSP","pickupStoreInfo":{"additionalInfo":"","address":{"addressId":"VTEXSP","addressType":"pickup","city":"São Paulo","complement":"","country":"BRA","geoCoordinates":[-47.924747467041016,-15.832582473754883],"isDisposable":true,"neighborhood":"Itaim Bibi","number":"4440","postalCode":"04538-132","receiverName":null,"reference":null,"state":"SP","street":"Avenida Brigadeiro Faria Lima"},"dockId":"1","friendlyName":"VTEX SP","isPickupStore":true},"polygonName":null,"price":250,"shippingEstimate":"3bd","shippingEstimateDate":null,"tax":0,"transitTime":"3bd"}]}],"pickupPoints":[],"selectedAddresses":[{"addressId":"c3701fc4c61b4d1b91f67e81415db44d","addressType":"residential","city":"Rio de Janeiro","complement":null,"country":"BRA","geoCoordinates":[],"isDisposable":true,"neighborhood":"My neighborhood","number":"1091","postalCode":"12345000","receiverName":"Clark Kent","reference":null,"state":"ST","street":"My street"}]},"storeId":null,"storePreferencesData":{"countryCode":"BRA","currencyCode":"BRL","currencyFormatInfo":{"currencyDecimalDigits":2,"currencyDecimalSeparator":",","currencyGroupSeparator":".","currencyGroupSize":3,"startsWithCurrencySymbol":true},"currencyLocale":1046,"currencySymbol":"R$","saveUserData":true,"timeZone":"E. South America Standard Time"},"subscriptionData":null,"totalizers":[],"userProfileId":null,"userType":null,"value":0}}},"description":"","headers":{}}},"security":[],"summary":"Add shipping address and select delivery option","tags":["Cart attachments"]}},"/api/checkout/pub/orderForm/{orderFormId}/coupons":{"post":{"deprecated":false,"description":"Use this request to add coupons to a given shopping cart.","operationId":"AddCoupons","parameters":[{"description":"ID of the orderForm that will receive coupon information.","in":"path","name":"orderFormId","required":true,"schema":{"default":"ede846222cd44046ba6c638442c3505a","type":"string"},"style":"simple"},{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"text":{"default":"freeshipping","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.","type":"string"}},"type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"allowManualPrice":false,"availableAccounts":[],"availableAddresses":[{"addressId":"666c2e830bd9474ab6f6cc53fb6dd2d2","addressType":"residential","city":"Brasília","complement":"15º andar","country":"BRA","geoCoordinates":[-47.924747467041016,-15.832582473754883],"isDisposable":true,"neighborhood":"Copacabana","number":"123","postalCode":"70386000","receiverName":"Clark Kent","reference":null,"state":"DF","street":"Rua da minha casa"}],"canEditData":true,"clientPreferencesData":{"locale":"pt-BR","optinNewsLetter":false},"clientProfileData":{"corporateDocument":null,"corporateName":null,"corporatePhone":null,"customerClass":null,"document":"12345678900","documentType":"cpf","email":"clark.kent@example.com","firstName":"Clark","isCorporate":false,"lastName":"Kent","phone":"+5521998765432","profileCompleteOnLoading":false,"profileErrorOnLoading":null,"stateInscription":null,"tradeName":null},"commercialConditionData":null,"customData":null,"giftRegistryData":null,"hooksData":null,"ignoreProfileData":false,"invoiceData":null,"isCheckedIn":false,"itemMetadata":{"items":[{"assemblyOptions":[],"detailUrl":"/chopp-brahma-claro-30l/p","ean":null,"id":"2","imageUrl":"http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000","name":"Chopp Brahma Claro 30L","productId":"2","refId":"CBC30L","seller":"1","skuName":"Chopp Brahma Claro 30L"}]},"items":[{"additionalInfo":{"brandId":"2000000","brandName":"Brahma","dimension":null,"offeringInfo":null,"offeringType":null,"offeringTypeId":null},"assemblies":[],"attachmentOfferings":[],"attachments":[],"availability":"available","bundleItems":[],"components":[],"detailUrl":"/chopp-brahma-claro-30l/p","ean":null,"id":"2","imageUrl":"http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000","isGift":false,"listPrice":49900,"manualPrice":null,"manualPriceAppliedBy":null,"manufacturerCode":null,"measurementUnit":"un","modalType":null,"name":"Chopp Brahma Claro 30L","offerings":[],"parentAssemblyBinding":null,"parentItemIndex":null,"preSaleDate":null,"price":32890,"priceDefinition":{"calculatedSellingPrice":32890,"sellingPrices":[{"quantity":1,"value":32890}],"total":32890},"priceTags":[],"priceValidUntil":"2025-04-15T13:52:27.983Z","productCategories":{"1":"Bebidas"},"productCategoryIds":"/1/","productId":"2","productRefId":"","quantity":1,"refId":"CBC30L","rewardValue":0,"seller":"1","sellerChain":["1"],"sellingPrice":32890,"skuName":"Chopp Brahma Claro 30L","tax":0,"uniqueId":"9D6E447B3FF64CEDA33B17C01379C119","unitMultiplier":1}],"itemsOrdination":{"ascending":true,"criteria":"NAME"},"loggedIn":false,"marketingData":{"coupon":"freeshipping","marketingTags":[],"utmCampaign":null,"utmMedium":null,"utmSource":null,"utmiCampaign":null,"utmiPart":null,"utmipage":null},"messages":[],"openTextField":null,"orderFormId":"ede846222cd44046ba6c638442c3505a","paymentData":{"giftCards":[],"transactions":[{"isActive":true,"merchantName":"MYSTORE","payments":[],"sharedTransaction":false,"transactionId":"296D6D245C17437E823EB77E403FC88D"}]},"profileProvider":"VTEX","ratesAndBenefitsData":{"rateAndBenefitsIdentifiers":[],"teaser":[]},"salesChannel":"1","selectableGifts":[],"sellers":[{"id":"1","logo":"","name":"lojadobreno"}],"shippingData":{"address":{"addressId":"teste","addressType":"residential","city":"Brasília","complement":"15º andar","country":"BRA","geoCoordinates":[-47.924747467041016,-15.832582473754883],"isDisposable":true,"neighborhood":"Copacabana","number":"123","postalCode":"70386000","receiverName":"Clark Kent","reference":null,"state":"DF","street":"Rua da minha casa"},"availableAddresses":[{"addressId":"teste","addressType":"residential","city":"Rio de Janeiro","complement":"15º andar","country":"BRA","geoCoordinates":[-47.924747467041016,-15.832582473754883],"isDisposable":true,"neighborhood":"Copacabana","number":"123","postalCode":"12345000","receiverName":"Clark Kent","reference":null,"state":"RJ","street":"Rua da minha casa"}],"logisticsInfo":[{"addressId":"teste","deliveryChannels":[{"id":"delivery"},{"id":"pickup-in-point"}],"itemId":"2","itemIndex":0,"selectedDeliveryChannel":"delivery","selectedSla":"Normal","shipsTo":["BRA","COL","USA"],"slas":[{"availableDeliveryWindows":[],"deliveryChannel":"delivery","deliveryIds":[{"courierId":"1","courierName":"Transportadora","dockId":"1","kitItemDetails":[],"quantity":1,"warehouseId":11}],"deliveryWindow":null,"id":"Normal","listPrice":1500,"lockTTL":"10d","name":"Normal","pickupDistance":0,"pickupPointId":null,"pickupStoreInfo":{"additionalInfo":null,"address":null,"dockId":null,"friendlyName":null,"isPickupStore":false},"polygonName":null,"price":1500,"shippingEstimate":"3bd","shippingEstimateDate":null,"tax":0,"transitTime":"3bd"}]}],"pickupPoints":[],"selectedAddresses":[{"addressId":"teste","addressType":"residential","city":"Rio de Janeiro","complement":"15º andar","country":"BRA","geoCoordinates":[-47.924747467041016,-15.832582473754883],"isDisposable":true,"neighborhood":"Copacabana","number":"123","postalCode":"12345000","receiverName":"Clark Kent","reference":null,"state":"RJ","street":"Rua da minha casa"}]},"storeId":null,"storePreferencesData":{},"subscriptionData":null,"totalizers":[{"id":"Items","name":"Total Items","value":32890}],"userProfileId":"fb542e51-5488-4c34-8d17-ed8fcf597a94","userType":null,"value":34390}}},"schema":{"properties":{"allowManualPrice":{"description":"Permission to modify item price manually.","type":"boolean"},"availableAccounts":{"description":"Available accounts.","items":{"type":"string"},"type":"array"},"availableAddresses":{"description":"Information on each available address.","items":{"properties":{"addressId":{"description":"Address ID.","type":"string"},"addressType":{"description":"Address type.","type":"string"},"city":{"description":"City of the address.","type":"string"},"complement":{"description":"Complement to the address.","nullable":true,"type":"string"},"country":{"description":"Country of the address. ISO three-letter code.","type":"string"},"geoCoordinates":{"description":"Array containing two floats with geocoordinates, first longitude, then latitude.","items":{"type":"number"},"type":"array"},"isDisposable":{"description":"Indicates whether address is disposable.","type":"boolean"},"neighborhood":{"description":"Neighborhood of the address.","type":"string"},"number":{"description":"Number of the address.","type":"string"},"receiverName":{"description":"Name of the receiver.","type":"string"},"reference":{"description":"Reference that may help in the location of the address.","nullable":true,"type":"string"},"state":{"description":"State of the address.","type":"string"},"street":{"description":"Street of the address.","type":"string"}},"type":"object"},"type":"array"},"canEditData":{"description":"Data can be edited.","type":"boolean"},"clientPreferencesData":{"description":"Object containing preferences from the client who placed the order.","properties":{"locale":{"description":"Client's locale. Examples: `pt-BR` and `en-US`.","type":"string"},"optinNewsLetter":{"description":"`true` if the client opted to receive newsletter from the store.","nullable":false,"type":"boolean"}},"type":"object"},"clientProfileData":{"description":"Customer's profile information.","properties":{"corporateDocument":{"description":"Corporate document, if the customer is a legal entity.","nullable":true,"type":"string"},"corporateName":{"description":"Company name, if the customer is a legal entity.","nullable":true,"type":"string"},"corporatePhone":{"description":"Corporate phone number, if the customer is a legal entity.","nullable":true,"type":"string"},"customerClass":{"description":"Customer class.","nullable":true,"type":"string"},"document":{"description":"Document informed by the customer.","type":"string"},"documentType":{"description":"Type of the document informed by the customer.","type":"string"},"email":{"description":"Email address.","type":"string"},"firstName":{"description":"First name.","type":"string"},"isCorporate":{"description":"Indicates whether the customer is a legal entity.","type":"boolean"},"lastName":{"description":"Last name.","type":"string"},"phone":{"description":"Phone number.","type":"string"},"profileCompleteOnLoading":{"description":"Indicates whether profile is complete on loading.","type":"boolean"},"profileErrorOnLoading":{"description":"Indicates whether profile presents error on loading.","nullable":true,"type":"boolean"},"stateInscription":{"description":"State inscription, if the customer is a legal entity.","nullable":true,"type":"string"},"tradeName":{"description":"Trade name, if the customer is a legal entity.","nullable":true,"type":"string"}},"type":"object"},"commercialConditionData":{"description":"Object containing commercial condition information.","nullable":true,"type":"object"},"customData":{"description":"Customer additional information.","nullable":true,"type":"object"},"giftRegistryData":{"description":"Gift registry list information.","nullable":true,"type":"object"},"hooksData":{"description":"Hooks information.","nullable":true,"type":"object"},"ignoreProfileData":{"description":"Ignore customer profile data.","type":"boolean"},"invoiceData":{"description":"Object containing information pertinent to the order's invoice.","nullable":true,"type":"object"},"isCheckedIn":{"description":"Indicates whether order is checked in.","type":"boolean"},"itemMetadata":{"description":"Item metadata.","properties":{"items":{"description":"List of objects containing metadata on each item in the order.","items":{"properties":{"detailUrl":{"description":"Detail URL.","type":"string"},"ean":{"description":"European Article Number.","nullable":true,"type":"string"},"id":{"description":"Item ID.","type":"string"},"imageUrl":{"description":"Image URL.","type":"string"},"name":{"description":"Product name.","type":"string"},"productId":{"description":"Product ID.","type":"string"},"refId":{"description":"Ref ID.","type":"string"},"seller":{"description":"Seller.","type":"string"},"skuName":{"description":"SKU name.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"items":{"description":"Information on each item in the order.","items":{"properties":{"additionalInfo":{"description":"Additional information.","properties":{"brandId":{"description":"Brand ID.","type":"string"},"brandName":{"description":"Brand name.","type":"string"},"dimension":{"description":"Dimension.","nullable":true,"type":"string"},"offeringInfo":{"description":"Offering information.","nullable":true,"type":"string"},"offeringType":{"description":"Offering type.","nullable":true,"type":"string"},"offeringTypeId":{"description":"Offering type ID.","nullable":true,"type":"string"}},"type":"object"},"attachments":{"description":"Array containing information on attachments.","items":{"type":"string"},"type":"array"},"availability":{"description":"Availability","type":"string"},"bundleItems":{"description":"Information on services sold along with the SKU. Example: a gift package.","items":{"properties":{"id":{"description":"Service identifier.","type":"integer"},"name":{"description":"Service name.","type":"string"},"price":{"description":"Service price in cents.","type":"integer"},"type":{"description":"Service type.","type":"string"}},"type":"object"},"type":"array"},"detailUrl":{"description":"Detail URL.","type":"string"},"ean":{"description":"European Article Number.","nullable":true,"type":"string"},"id":{"description":"ID of the item.","type":"string"},"imageUrl":{"description":"Image URL.","type":"string"},"isGift":{"description":"Indicates whether item is a gift.","type":"boolean"},"listPrice":{"description":"List price in cents.","type":"integer"},"manualPrice":{"description":"Manual price in cents.","nullable":true,"type":"integer"},"manualPriceAppliedBy":{"description":"User that applied the manual price, if that is the case.","nullable":true,"type":"string"},"manufacturerCode":{"description":"Manufacturer code.","nullable":true,"type":"string"},"measurementUnit":{"description":"Measurement unit","type":"string"},"modalType":{"description":"Modal type.","nullable":true,"type":"string"},"name":{"description":"Product name.","type":"string"},"parentAssemblyBinding":{"description":"Parent assembly binding.","nullable":true,"type":"string"},"parentItemIndex":{"description":"Parent item index.","nullable":true,"type":"integer"},"preSaleDate":{"description":"Presale date.","nullable":true,"type":"string"},"price":{"description":"Price in cents.","type":"integer"},"priceDefinition":{"description":"Price information for all units of a specific item.","properties":{"calculatedSellingPrice":{"description":"Item's calculated unitary selling price in cents.","type":"integer"},"sellingPrices":{"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":{"properties":{"quantity":{"description":"Rounding quantity, meaning how many items are rounded to this value.","type":"integer"},"value":{"description":"Value in cents for that specific rounding.","type":"integer"}},"type":"object"},"type":"array"},"total":{"description":"Total value for all units of the item in cents.","type":"integer"}},"type":"object"},"priceTags":{"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":{"properties":{"identifier":{"description":"Price tag identifier.","type":"string"},"isPercentual":{"description":"Indicates whether price tag value is applied through a percentage.","type":"boolean"},"name":{"description":"Price tag name.","type":"string"},"rawValue":{"description":"Price tag raw value.","type":"integer"},"value":{"description":"Price tag value.","type":"integer"}},"type":"object"},"type":"array"},"priceValidUntil":{"description":"Price expiration date and time.","type":"string"},"productCategories":{"description":"Object, where each field is an ID from `productCategoryIds`.","properties":{"{ID}":{"description":"Product category corresponding to the ID in the field key.","type":"string"}},"type":"object"},"productCategoryIds":{"description":"Product category IDs.","type":"string"},"productId":{"description":"Product ID.","type":"string"},"productRefId":{"description":"Product Ref ID.","type":"string"},"quantity":{"description":"Quantity.","type":"integer"},"refId":{"description":"Ref ID.","type":"string"},"rewardValue":{"description":"Reward value in cents.","type":"integer"},"seller":{"description":"Seller.","type":"string"},"sellerChain":{"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":{"description":"Seller.","type":"string"},"type":"array"},"sellingPrice":{"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.","type":"integer"},"skuName":{"description":"SKU name.","type":"string"},"tax":{"description":"Tax value in cents.","type":"integer"},"uniqueId":{"description":"Unique ID.","type":"string"},"unitMultiplier":{"description":"Unit multiplier","type":"integer"}},"type":"object"},"type":"array"},"itemsOrdination":{"description":"Object containing information about the ordering of items within the orderForm.","properties":{"ascending":{"description":"Indicates whether the ordering is ascending.","type":"boolean"},"criteria":{"description":"Criteria adopted to order the items in the list.","type":"string"}},"type":"object"},"loggedIn":{"description":"Indicates whether the user is logged into the store.","type":"boolean"},"marketingData":{"description":"Object containIng promotion data such as coupon tracking information and internal or external UTMs.","properties":{"coupon":{"default":"free-shipping","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.","type":"string"},"utmCampaign":{"default":"Black friday","description":"UTM campaign.","nullable":true,"type":"string"},"utmMedium":{"default":"CPC","description":"UTM medium.","nullable":true,"type":"string"},"utmSource":{"default":"Facebook","description":"UTM source.","nullable":true,"type":"string"},"utmiCampaign":{"default":"utmi_campaign-exmaple","description":"utmi_campaign (internal utm).","nullable":true,"type":"string"},"utmiPage":{"default":"utmi_page-example","description":"utmi_page (internal utm).","nullable":true,"type":"string"},"utmiPart":{"default":"utmi_part-exmaple","description":"utmi_part (internal utm).","nullable":true,"type":"string"}},"type":"object"},"messages":{"description":"Array containing an object for each message generated by our servers while processing the request.","items":{},"type":"array"},"openTextField":{"default":"open-text-example","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,"type":"string"},"orderFormId":{"description":"ID of the orderForm corresponding to a specific cart.","type":"string"},"paymentData":{"description":"Information on the order's payment.","properties":{"giftCards":{"description":"Gift card information, if it applies to the order.","items":{"properties":{"balance":{"description":"Gift card balance in cents.","type":"integer"},"id":{"description":"Gift card ID.","type":"string"},"inUse":{"description":"Indicates whether gift card is in use.","type":"boolean"},"isSpecialCard":{"description":"Indicates whether gift card is special.","type":"boolean"},"name":{"description":"Gift card name.","type":"string"},"redemptionCode":{"description":"Gift card redemption code.","type":"string"},"value":{"description":"Gift card value in cents.","type":"integer"}},"type":"object"},"type":"array"},"transactions":{"description":"Information on each transaction pertinent to the order.","items":{"properties":{"isActive":{"description":"Indicates whether transaction is active.","type":"boolean"},"merchantName":{"description":"Merchant name.","type":"string"},"payments":{"description":"Information on each payment.","items":{"properties":{"accountId":{"description":"Account ID.","type":"string"},"bin":{"description":"Bin.","type":"string"},"installments":{"description":"Number of installments.","type":"integer"},"paymentSystem":{"description":"Payment system.","type":"string"},"referenceValue":{"description":"Reference value for calculating interest rates, in case it applies. Displayed in cents.","type":"integer"},"value":{"description":"Value including interest, in case it applies. Displayed in cents.","type":"integer"}},"type":"object"},"type":"array"},"sharedTransaction":{"description":"Indicates whather transaction is shared.","type":"boolean"},"transactionId":{"description":"Transaction ID.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"profileProvider":{"description":"Profile provider.","type":"string"},"ratesAndBenefitsData":{"description":"Information on rates and benefits that apply to the order.","properties":{"rateAndBenefitsIdentifiers":{"description":"List with rates and benefits identifiers.","items":{"type":"string"},"type":"array"},"teaser":{"description":"List with rates and benefits teasers.","items":{"type":"string"},"type":"array"}},"type":"object"},"salesChannel":{"description":"Attribute created by the seller, in their VTEX store configuration.","type":"string"},"selectableGifts":{"description":"Array containing the data of the item selected as a gift.","items":{},"type":"array"},"sellers":{"description":"Information on each seller.","items":{"properties":{"id":{"description":"Seller ID.","type":"string"},"logo":{"description":"Seller logo.","nullable":true,"type":"string"},"name":{"description":"Seller name.","type":"string"}},"type":"object"},"type":"array"},"shippingData":{"description":"Shipping information pertinent to the order.","properties":{"address":{"description":"Address information.","properties":{"addressId":{"description":"Address ID.","type":"string"},"addressType":{"description":"Type of address. For example, `Residential` or `Pickup`.","type":"string"},"city":{"description":"City of the shipping address.","type":"string"},"complement":{"description":"Complement to the shipping address, in case it applies.","nullable":true,"type":"string"},"country":{"description":"Three letter ISO code of the country of the shipping address.","type":"string"},"geoCoordinates":{"description":"Array containing two floats with geocoordinates, first longitude, then latitude.","items":{"type":"number"},"type":"array"},"isDisposable":{"description":"Indicates whether address is disposable.","type":"boolean"},"neighborhood":{"description":"Neighborhood of the shipping address.","type":"string"},"number":{"description":"Number of the building, house or apartment in the shipping address.","type":"string"},"postalCode":{"description":"Postal code.","type":"string"},"receiverName":{"description":"Name of the person who is going to receive the order.","type":"string"},"reference":{"description":"Complement that might help locate the shipping address more precisely in case of delivery.","nullable":true,"type":"string"},"state":{"description":"State of the shipping address.","type":"string"},"street":{"description":"Street of the shipping address.","type":"string"}},"type":"object"},"availableAddresses":{"description":"Array with information on the available addresses for the order.","items":{"properties":{"addressId":{"description":"Address ID.","type":"string"},"addressType":{"description":"Type of address. For example, `Residential` or `Pickup`.","type":"string"},"city":{"description":"City of the shipping address.","type":"string"},"complement":{"description":"Complement to the shipping address, in case it applies.","type":"string"},"country":{"description":"Three letter ISO code of the country of the shipping address.","type":"string"},"geoCoordinates":{"description":"Array containing two floats with geocoordinates, first longitude, then latitude.","items":{"type":"number"},"type":"array"},"isDisposable":{"description":"Indicates whether address is disposable.","type":"boolean"},"neighborhood":{"description":"Neighborhood of the shipping address.","type":"string"},"number":{"description":"Number of the building, house or apartment in the shipping address.","type":"string"},"postalCode":{"description":"Postal code.","type":"string"},"receiverName":{"description":"Name of the person who is going to receive the order.","type":"string"},"reference":{"description":"Complement that might help locate the shipping address more precisely in case of delivery.","nullable":true,"type":"string"},"state":{"description":"State of the shipping address.","type":"string"},"street":{"description":"Street of the shipping address.","type":"string"}},"type":"object"},"type":"array"},"logisticsInfo":{"description":"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.","items":{"properties":{"addressId":{"description":"Address ID.","type":"string"},"deliveryChannels":{"description":"List of available delivery channels.","items":{"properties":{"id":{"description":"Delivery channel ID.","type":"string"}},"type":"object"},"type":"array"},"itemId":{"description":"Item ID.","type":"string"},"itemIndex":{"description":"Index corresponding to the position of the object in the `items` array.","type":"integer"},"selectedDeliveryChannel":{"description":"Delivery channel selected by the customer.","type":"string"},"selectedSla":{"description":"SLA selected by the customer.","type":"string"},"shipsTo":{"description":"List of countries that the item may be shipped to.","items":{"description":"Three letter country code.","type":"string"},"type":"array"},"slas":{"description":"Information on available SLAs.","items":{"properties":{"deliveryChannel":{"description":"Delivery channel.","type":"string"},"deliveryIds":{"description":"Information on each delivery ID.","items":{"properties":{"courierId":{"description":"Courier ID.","type":"string"},"courierName":{"description":"Courier name.","type":"string"},"dockId":{"description":"Warehouse ID.","type":"string"},"quantity":{"description":"Quantity.","type":"integer"},"warehouseId":{"description":"Warehouse ID.","type":"string"}},"type":"object"},"type":"array"},"id":{"description":"SLA ID.","type":"string"},"listPrice":{"description":"List price in cents.","type":"integer"},"lockTTL":{"description":"Estimate date of delivery.","type":"string"},"name":{"description":"SLA name.","type":"string"},"pickupDistance":{"description":"Pickup point distance.","type":"integer"},"pickupPointId":{"description":"Pickup point ID.","nullable":true,"type":"string"},"pickupStoreInfo":{"description":"Information on the pickup store.","properties":{"additionalInfo":{"description":"Additional information.","nullable":true,"type":"string"},"address":{"description":"Address information.","nullable":true,"properties":{"addressType":{"description":"Type of address. For example, `Residential` or `Pickup`.","type":"string"},"city":{"description":"City of the shipping address.","type":"string"},"complement":{"description":"Complement to the shipping address, in case it applies.","nullable":true,"type":"string"},"country":{"description":"Three letter ISO code of the country of the shipping address.","type":"string"},"geoCoordinates":{"description":"Array containing two floats with geocoordinates, first longitude, then latitude.","items":{"type":"number"},"type":"array"},"neighborhood":{"description":"Neighborhood of the shipping address.","type":"string"},"number":{"description":"Number of the building, house or apartment in the shipping address.","type":"string"},"postalCode":{"description":"Postal code.","type":"string"},"reference":{"description":"Complement that might help locate the shipping address more precisely in case of delivery.","nullable":true,"type":"string"},"state":{"description":"State of the shipping address.","type":"string"},"street":{"description":"Street of the shipping address.","type":"string"}},"type":"object"},"dockId":{"description":"Corresponding dock ID.","nullable":true,"type":"string"},"friendlyName":{"description":"Friendly name.","nullable":true,"type":"string"},"isPickupStore":{"description":"Indicates whether it is the pickup store.","type":"boolean"}},"type":"object"},"polygonName":{"description":"Polygon name.","nullable":true,"type":"string"},"price":{"description":"Price in cents.","type":"integer"},"shippingEstimate":{"description":"Shipping estimate. For instance, Three business days will be represented `3bd`.","type":"string"},"shippingEstimateDate":{"description":"Shipping estimate date.","nullable":true,"type":"string"},"tax":{"description":"Tax in cents.","type":"integer"},"transitTime":{"description":"Transit time. For instance, \"three business days\" is represented `3bd`.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"},"selectedAddresses":{"description":"Array with information on the selected addresses for the order.","items":{"properties":{"addressId":{"description":"Address ID.","type":"string"},"addressType":{"description":"Type of address. For example, `Residential` or `Pickup`.","type":"string"},"city":{"description":"City of the shipping address.","type":"string"},"complement":{"description":"Complement to the shipping address, in case it applies.","type":"string"},"country":{"description":"Three letter ISO code of the country of the shipping address.","type":"string"},"geoCoordinates":{"description":"Array containing two floats with geocoordinates, first longitude, then latitude.","items":{"type":"number"},"type":"array"},"isDisposable":{"description":"Indicates whether address is disposable.","type":"boolean"},"neighborhood":{"description":"Neighborhood of the shipping address.","type":"string"},"number":{"description":"Number of the building, house or apartment in the shipping address.","type":"string"},"postalCode":{"description":"Postal code.","type":"string"},"receiverName":{"description":"Name of the person who is going to receive the order.","type":"string"},"reference":{"description":"Complement that might help locate the shipping address more precisely in case of delivery.","nullable":true,"type":"string"},"state":{"description":"State of the shipping address.","type":"string"},"street":{"description":"Street of the shipping address.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"storeId":{"description":"ID of the store.","nullable":true,"type":"string"},"storePreferencesData":{"description":"Object containing data from the store's configuration (stored in VTEX's License Manager).","type":"object"},"subscriptionData":{"description":"Subscription information.","nullable":true,"type":"object"},"totalizers":{"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":"array"},"userProfileId":{"description":"Unique ID associated with the customer profile.","type":"string"},"userType":{"description":"User type.","nullable":true,"type":"string"},"value":{"description":"Total value of the order without separating cents. For example, $24.99 is represented `2499`.","type":"integer"}},"type":"object"}}},"description":"OK","headers":{}}},"security":[],"summary":"Add coupons to the cart","tags":["Shopping cart"]}},"/api/checkout/pub/orderForm/{orderFormId}/customData/{appId}":{"put":{"deprecated":false,"description":"Your account may create `apps`, which contain custom fields, through the [Update orderForm configuration](https://developers.vtex.com/reference/configuration#updateorderformconfiguration) request. The values of these custom fields can then be updated by this request.\n\r\n\rTo do that, you need to inform the ID of the app you created with the configuration API (`appId`).\n\r\n\rIn the body of the request, for each field created in this app (`appFieldName`) you will inform a value (`appFieldValue`).\r\n\r\nThe [orderForm](https://developers.vtex.com/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","parameters":[{"description":"ID of the orderForm that will receive the new custom field values.","in":"path","name":"orderFormId","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"ID of the app created with the configuration API.","in":"path","name":"appId","required":true,"schema":{"type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"description":"Here you must add the pairs of Field Name and Field Value.","type":"object"}}},"required":true},"responses":{"200":{"content":{"application/json":{"example":{"allowManualPrice":false,"canEditData":true,"checkedInPickupPointId":null,"clientPreferencesData":{"locale":"pt-BR","optinNewsLetter":null},"clientProfileData":null,"commercialConditionData":null,"customData":{"customApps":[{"fields":{"testField1":"testValue1","testField2":"testValue2"},"id":"abcd","major":1}]},"giftRegistryData":null,"hooksData":null,"ignoreProfileData":false,"invoiceData":null,"isCheckedIn":false,"itemMetadata":{"items":[{"assemblyOptions":[],"detailUrl":"/racao-royal-canin-feline-urinary/p","ean":"123456789","id":"1","imageUrl":"http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000","name":"Ração Royal Canin Feline Urinary 500g","productId":"1","refId":"0001","seller":"1","skuName":"Ração Royal Canin Feline Urinary 500g"}]},"items":[{"additionalInfo":{"brandId":"2000000","brandName":"Royal Canin","offeringInfo":null,"offeringType":null,"offeringTypeId":null},"assemblies":[],"attachmentOfferings":[],"attachments":[],"availability":"available","bundleItems":[],"components":[],"detailUrl":"/racao-royal-canin-feline-urinary/p","ean":"123456789","id":"1","imageUrl":"http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000","isGift":false,"listPrice":30000,"manualPrice":10000,"manufacturerCode":null,"measurementUnit":"un","modalType":null,"name":"Ração Royal Canin Feline Urinary 500g","offerings":[],"parentAssemblyBinding":null,"parentItemIndex":null,"preSaleDate":null,"price":15000,"priceTags":[{"identifier":null,"isPercentual":false,"name":"DISCOUNT@MANUALPRICE","rawValue":-50,"value":-5000}],"priceValidUntil":"2025-04-15T13:52:27.984Z","productCategories":{"1":"Alimentação","10":"Ração Seca"},"productCategoryIds":"/1/10/","productId":"1","productRefId":"","quantity":1,"refId":"0001","rewardValue":0,"seller":"1","sellerChain":["1"],"sellingPrice":10000,"skuName":"Ração Royal Canin Feline Urinary 500g","tax":0,"uniqueId":"E0F2B7AF5CD74D668F1E27537206912C","unitMultiplier":1}],"itemsOrdination":null,"loggedIn":false,"marketingData":null,"messages":[],"openTextField":null,"orderFormId":"ede846222cd44046ba6c638442c3505a","paymentData":{"availableAccounts":[],"availableTokens":[],"giftCardMessages":[],"giftCards":[],"installmentOptions":[{"bin":null,"installments":[{"count":1,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":1,"hasInterestRate":false,"id":"LOJADOBRENO","interestRate":0,"total":10000,"value":10000}],"total":10000,"value":10000},{"count":2,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":2,"hasInterestRate":false,"id":"LOJADOBRENO","interestRate":0,"total":10000,"value":5000}],"total":10000,"value":5000}],"paymentGroupName":null,"paymentName":null,"paymentSystem":"2","value":10000}],"paymentSystems":[{"availablePayments":null,"description":null,"dueDate":"2025-04-15T13:52:27.984Z","groupName":"creditCardPaymentGroup","id":2,"isCustom":false,"name":"Visa","requiresAuthentication":false,"requiresDocument":false,"stringId":"2","template":"creditCardPaymentGroup-template","validator":{"cardCodeMask":"999","cardCodeRegex":"^[0-9]{3}$","mask":"9999 9999 9999 9999","regex":"^4[0-9]{15}$","useBillingAddress":true,"useCardHolderName":true,"useCvv":true,"useExpirationDate":true,"weights":[2,1,2,1]}}],"payments":[]},"ratesAndBenefitsData":{"rateAndBenefitsIdentifiers":[],"teaser":[]},"salesChannel":"1","selectableGifts":[],"sellers":[{"id":"1","logo":"","name":"lojadobreno"}],"shippingData":{"address":null,"availableAddresses":[],"logisticsInfo":[{"addressId":null,"deliveryChannels":[{"id":"pickup-in-point"},{"id":"delivery"}],"itemId":"1","itemIndex":0,"selectedDeliveryChannel":"delivery","selectedSla":null,"shipsTo":["BRA"],"slas":[]}],"pickupPoints":[],"selectedAddresses":[]},"storeId":null,"storePreferencesData":{"countryCode":"BRA","currencyCode":"BRL","currencyFormatInfo":{"currencyDecimalDigits":2,"currencyDecimalSeparator":",","currencyGroupSeparator":".","currencyGroupSize":3,"startsWithCurrencySymbol":true},"currencyLocale":1046,"currencySymbol":"R$","saveUserData":true,"timeZone":"E. South America Standard Time"},"subscriptionData":null,"totalizers":[{"id":"Items","name":"Total dos Itens","value":15000},{"id":"Discounts","name":"Total dos Descontos","value":-5000}],"userProfileId":null,"userType":null,"value":10000},"schema":{}}},"description":"OK"}},"security":[],"summary":"Set multiple custom field values","tags":["Custom data"]}},"/api/checkout/pub/orderForm/{orderFormId}/customData/{appId}/{appFieldName}":{"delete":{"deprecated":false,"description":"Your account may create `apps`, which contain custom fields, through the [Update orderForm configuration](https://developers.vtex.com/reference#updateorderformconfiguration) request. The value of a specific custom field can be removed by this request.\n\r\n\rTo do that, you need to inform in the URL the ID of the app you created with the configuration API (`appId`).\n\r\n\rYou also need to iform the specific field created in this app (identified by the `appFieldName` parameter, also passed through the URL) whose value you want to remove.","operationId":"Removesinglecustomfieldvalue","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"The ID of the orderForm from which you want to remove the custom field value.","in":"path","name":"orderFormId","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"ID of the app created through the Update orderForm Configuration endpoint.","in":"path","name":"appId","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Name of the app's field created through the Update orderForm Configuration endpoint and which will be deleted.","in":"path","name":"appFieldName","required":true,"schema":{"type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":{"allowManualPrice":false,"canEditData":true,"checkedInPickupPointId":null,"clientPreferencesData":{"locale":"pt-BR","optinNewsLetter":null},"clientProfileData":null,"commercialConditionData":null,"customData":{"customApps":[{"fields":{"testField2":"testValue2"},"id":"abcd","major":1}]},"giftRegistryData":null,"hooksData":null,"ignoreProfileData":false,"invoiceData":null,"isCheckedIn":false,"itemMetadata":{"items":[{"assemblyOptions":[],"detailUrl":"/racao-royal-canin-feline-urinary/p","ean":"123456789","id":"1","imageUrl":"http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000","name":"Ração Royal Canin Feline Urinary 500g","productId":"1","refId":"0001","seller":"1","skuName":"Ração Royal Canin Feline Urinary 500g"}]},"items":[{"additionalInfo":{"brandId":"2000000","brandName":"Royal Canin","offeringInfo":null,"offeringType":null,"offeringTypeId":null},"assemblies":[],"attachmentOfferings":[],"attachments":[],"availability":"available","bundleItems":[],"components":[],"detailUrl":"/racao-royal-canin-feline-urinary/p","ean":"123456789","id":"1","imageUrl":"http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000","isGift":false,"listPrice":30000,"manualPrice":10000,"manufacturerCode":null,"measurementUnit":"un","modalType":null,"name":"Ração Royal Canin Feline Urinary 500g","offerings":[],"parentAssemblyBinding":null,"parentItemIndex":null,"preSaleDate":null,"price":15000,"priceTags":[{"identifier":null,"isPercentual":false,"name":"DISCOUNT@MANUALPRICE","rawValue":-50,"value":-5000}],"priceValidUntil":"2025-04-15T13:52:27.984Z","productCategories":{"1":"Alimentação","10":"Ração Seca"},"productCategoryIds":"/1/10/","productId":"1","productRefId":"","quantity":1,"refId":"0001","rewardValue":0,"seller":"1","sellerChain":["1"],"sellingPrice":10000,"skuName":"Ração Royal Canin Feline Urinary 500g","tax":0,"uniqueId":"E0F2B7AF5CD74D668F1E27537206912C","unitMultiplier":1}],"itemsOrdination":null,"loggedIn":false,"marketingData":null,"messages":[],"openTextField":null,"orderFormId":"ede846222cd44046ba6c638442c3505a","paymentData":{"availableAccounts":[],"availableTokens":[],"giftCardMessages":[],"giftCards":[],"installmentOptions":[{"bin":null,"installments":[{"count":1,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":1,"hasInterestRate":false,"id":"LOJADOBRENO","interestRate":0,"total":10000,"value":10000}],"total":10000,"value":10000},{"count":2,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":2,"hasInterestRate":false,"id":"LOJADOBRENO","interestRate":0,"total":10000,"value":5000}],"total":10000,"value":5000}],"paymentGroupName":null,"paymentName":null,"paymentSystem":"2","value":10000}],"paymentSystems":[{"availablePayments":null,"description":null,"dueDate":"2025-04-15T13:52:27.984Z","groupName":"creditCardPaymentGroup","id":2,"isCustom":false,"name":"Visa","requiresAuthentication":false,"requiresDocument":false,"stringId":"2","template":"creditCardPaymentGroup-template","validator":{"cardCodeMask":"999","cardCodeRegex":"^[0-9]{3}$","mask":"9999 9999 9999 9999","regex":"^4[0-9]{15}$","useBillingAddress":true,"useCardHolderName":true,"useCvv":true,"useExpirationDate":true,"weights":[2,1,2,1,2]}}],"payments":[]},"ratesAndBenefitsData":{"rateAndBenefitsIdentifiers":[],"teaser":[]},"salesChannel":"1","selectableGifts":[],"sellers":[{"id":"1","logo":"","name":"lojadobreno"}],"shippingData":{"address":null,"availableAddresses":[],"logisticsInfo":[{"addressId":null,"deliveryChannels":[{"id":"pickup-in-point"},{"id":"delivery"}],"itemId":"1","itemIndex":0,"selectedDeliveryChannel":"delivery","selectedSla":null,"shipsTo":["BRA"],"slas":[]}],"pickupPoints":[],"selectedAddresses":[]},"storeId":null,"storePreferencesData":{"countryCode":"BRA","currencyCode":"BRL","currencyFormatInfo":{"currencyDecimalDigits":2,"currencyDecimalSeparator":",","currencyGroupSeparator":".","currencyGroupSize":3,"startsWithCurrencySymbol":true},"currencyLocale":1046,"currencySymbol":"R$","saveUserData":true,"timeZone":"E. South America Standard Time"},"subscriptionData":null,"totalizers":[{"id":"Items","name":"Total dos Itens","value":15000},{"id":"Discounts","name":"Total dos Descontos","value":-5000}],"userProfileId":null,"userType":null,"value":10000}}},"description":"OK"}},"security":[],"summary":"Remove single custom field value","tags":["Custom data"]},"put":{"deprecated":false,"description":"Your account may create `apps`, which contain custom fields, through the [Update orderForm configuration](https://developers.vtex.com/reference#updateorderformconfiguration) request. The value of a specific custom field can then be updated by this request.\n\r\n\rTo do that, you need to inform in the URL the ID of the app you created with the configuration API (`appId`).\n\r\n\rIn the body of the request, you will inform the new value (`appFieldValue`, passed through the body) of the specific field created in this app (identified by the `appFieldName` parameter, passed through the URL).\r\n\r\nThe [orderForm](https://developers.vtex.com/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","parameters":[{"description":"The ID of the orderForm whose custom field's value you want to change.","in":"path","name":"orderFormId","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"ID of the app created through the Update orderForm Configuration endpoint.","in":"path","name":"appId","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Name of the app's field created through the Update orderForm Configuration endpoint.","in":"path","name":"appFieldName","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"example":{"value":"{{appFieldValue}}"},"schema":{"$ref":"#/components/schemas/SetsinglecustomfieldvalueRequest"}}},"description":"","required":true},"responses":{"200":{"content":{"application/json":{"example":{"allowManualPrice":false,"canEditData":true,"checkedInPickupPointId":null,"clientPreferencesData":{"locale":"pt-BR","optinNewsLetter":null},"clientProfileData":null,"commercialConditionData":null,"customData":{"customApps":[{"fields":{"testField1":"Hello World","testField2":"testValue2"},"id":"abcd","major":1}]},"giftRegistryData":null,"hooksData":null,"ignoreProfileData":false,"invoiceData":null,"isCheckedIn":false,"itemMetadata":{"items":[{"assemblyOptions":[],"detailUrl":"/racao-royal-canin-feline-urinary/p","ean":"123456789","id":"1","imageUrl":"http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000","name":"Ração Royal Canin Feline Urinary 500g","productId":"1","refId":"0001","seller":"1","skuName":"Ração Royal Canin Feline Urinary 500g"}]},"items":[{"additionalInfo":{"brandId":"2000000","brandName":"Royal Canin","offeringInfo":null,"offeringType":null,"offeringTypeId":null},"assemblies":[],"attachmentOfferings":[],"attachments":[],"availability":"available","bundleItems":[],"components":[],"detailUrl":"/racao-royal-canin-feline-urinary/p","ean":"123456789","id":"1","imageUrl":"http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000","isGift":false,"listPrice":30000,"manualPrice":10000,"manufacturerCode":null,"measurementUnit":"un","modalType":null,"name":"Ração Royal Canin Feline Urinary 500g","offerings":[],"parentAssemblyBinding":null,"parentItemIndex":null,"preSaleDate":null,"price":15000,"priceTags":[{"identifier":null,"isPercentual":false,"name":"DISCOUNT@MANUALPRICE","rawValue":-50,"value":-5000}],"priceValidUntil":"2025-04-15T13:52:27.984Z","productCategories":{"1":"Alimentação","10":"Ração Seca"},"productCategoryIds":"/1/10/","productId":"1","productRefId":"","quantity":1,"refId":"0001","rewardValue":0,"seller":"1","sellerChain":["1"],"sellingPrice":10000,"skuName":"Ração Royal Canin Feline Urinary 500g","tax":0,"uniqueId":"E0F2B7AF5CD74D668F1E27537206912C","unitMultiplier":1}],"itemsOrdination":null,"loggedIn":false,"marketingData":null,"messages":[],"openTextField":null,"orderFormId":"ede846222cd44046ba6c638442c3505a","paymentData":{"availableAccounts":[],"availableTokens":[],"giftCardMessages":[],"giftCards":[],"installmentOptions":[{"bin":null,"installments":[{"count":1,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":1,"hasInterestRate":false,"id":"LOJADOBRENO","interestRate":0,"total":10000,"value":10000}],"total":10000,"value":10000},{"count":2,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":2,"hasInterestRate":false,"id":"LOJADOBRENO","interestRate":0,"total":10000,"value":5000}],"total":10000,"value":5000}],"paymentGroupName":null,"paymentName":null,"paymentSystem":"2","value":10000}],"paymentSystems":[{"availablePayments":null,"description":null,"dueDate":"2025-04-15T13:52:27.985Z","groupName":"creditCardPaymentGroup","id":2,"isCustom":false,"name":"Visa","requiresAuthentication":false,"requiresDocument":false,"stringId":"2","template":"creditCardPaymentGroup-template","validator":{"cardCodeMask":"999","cardCodeRegex":"^[0-9]{3}$","mask":"9999 9999 9999 9999","regex":"^4[0-9]{15}$","useBillingAddress":true,"useCardHolderName":true,"useCvv":true,"useExpirationDate":true,"weights":[2,1,2,1,2]}}],"payments":[]},"ratesAndBenefitsData":{"rateAndBenefitsIdentifiers":[],"teaser":[]},"salesChannel":"1","selectableGifts":[],"sellers":[{"id":"1","logo":"","name":"lojadobreno"}],"shippingData":{"address":null,"availableAddresses":[],"logisticsInfo":[{"addressId":null,"deliveryChannels":[{"id":"pickup-in-point"},{"id":"delivery"}],"itemId":"1","itemIndex":0,"selectedDeliveryChannel":"delivery","selectedSla":null,"shipsTo":["BRA"],"slas":[]}],"pickupPoints":[],"selectedAddresses":[]},"storeId":null,"storePreferencesData":{"countryCode":"BRA","currencyCode":"BRL","currencyFormatInfo":{"currencyDecimalDigits":2,"currencyDecimalSeparator":",","currencyGroupSeparator":".","currencyGroupSize":3,"startsWithCurrencySymbol":true},"currencyLocale":1046,"currencySymbol":"R$","saveUserData":true,"timeZone":"E. South America Standard Time"},"subscriptionData":null,"totalizers":[{"id":"Items","name":"Total dos Itens","value":15000},{"id":"Discounts","name":"Total dos Descontos","value":-5000}],"userProfileId":null,"userType":null,"value":10000}}},"description":"","headers":{}}},"security":[],"summary":"Set single custom field value","tags":["Custom data"]}},"/api/checkout/pub/orderForm/{orderFormId}/installments":{"get":{"deprecated":false,"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","parameters":[{"description":"ID of the `orderForm` to be consulted for installments.","in":"path","name":"orderFormId","required":true,"schema":{"type":"string"}},{"description":"ID of the payment method to be consulted for installments.","explode":true,"in":"query","name":"paymentSystem","required":true,"schema":{"type":"integer"},"style":"form"},{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":{"bin":null,"installments":[{"count":1,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":1,"hasInterestRate":false,"id":"MyStore","interestRate":0,"total":32000,"value":32000}],"total":32000,"value":32000},{"count":2,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":2,"hasInterestRate":false,"id":"MyStore","interestRate":0,"total":32000,"value":1600}],"total":32000,"value":1600},{"count":3,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":3,"hasInterestRate":false,"id":"MyStore","interestRate":0,"total":32000,"value":10666}],"total":32000,"value":10666}],"paymentGroupName":null,"paymentName":null,"paymentSystem":"2","value":32000}}},"description":"OK","headers":{}}},"security":[],"summary":"Cart installments","tags":["Shopping cart"]}},"/api/checkout/pub/orderForm/{orderFormId}/items":{"post":{"deprecated":false,"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","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"ID of the orderForm corresponding to the cart in which the new item will be added.","in":"path","name":"orderFormId","required":true,"schema":{"default":"ede846222cd44046ba6c638442c3505a","type":"string"},"style":"simple"},{"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”`.","in":"query","name":"allowedOutdatedData","required":false,"schema":{"default":["paymentData"],"items":{},"type":"array"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"orderItems":{"description":"Array containing the cart items. Each object inside this array corresponds to a different item.","items":{"properties":{"id":{"description":"The ID of the SKU in VTEX platform.","example":"2005","type":"string"},"index":{"description":"The position of the item in the array.","example":0,"type":"integer"},"price":{"description":"Price of the item in cents. Send this value in case you want to make a bulk price change.","example":1099,"type":"integer"},"quantity":{"description":"The quantity of the item (SKU) in the cart.","example":3,"format":"int32","type":"integer"},"seller":{"description":"The seller responsible for the SKU.","example":"1","type":"string"}},"required":["quantity","seller","id","index"],"type":"object"},"type":"array"}},"type":"object"}}},"description":"","required":true},"responses":{"200":{"content":{"application/json":{"example":{"allowManualPrice":false,"availableAccounts":[],"availableAddresses":[{"addressId":"666c2e830bd9474ab6f6cc53fb6dd2d2","addressType":"residential","city":"Brasília","complement":"15º andar","country":"BRA","geoCoordinates":[-47.924747467041016,-15.832582473754883],"isDisposable":true,"neighborhood":"Copacabana","number":"123","postalCode":"70386000","receiverName":"Clark Kent","reference":null,"state":"DF","street":"Rua da minha casa"}],"canEditData":true,"clientPreferencesData":{"locale":"pt-BR","optinNewsLetter":false},"clientProfileData":{"corporateDocument":null,"corporateName":null,"corporatePhone":null,"customerClass":null,"document":"12345678900","documentType":"cpf","email":"clark.kent@example.com","firstName":"Clark","isCorporate":false,"lastName":"Kent","phone":"+5521998765432","profileCompleteOnLoading":false,"profileErrorOnLoading":null,"stateInscription":null,"tradeName":null},"commercialConditionData":null,"customData":null,"giftRegistryData":null,"hooksData":null,"ignoreProfileData":false,"invoiceData":null,"isCheckedIn":false,"itemMetadata":{"items":[{"assemblyOptions":[],"detailUrl":"/racao-royal-canin-feline-urinary/p","ean":"123456789","id":"1","imageUrl":"http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000","name":"Ração Royal Canin Feline Urinary 500g","productId":"1","refId":"0001","seller":"1","skuName":"Ração Royal Canin Feline Urinary 500g"}]},"items":[{"additionalInfo":{"brandId":"2000000","brandName":"Brahma","dimension":null,"offeringInfo":null,"offeringType":null,"offeringTypeId":null},"assemblies":[],"attachmentOfferings":[],"attachments":[],"availability":"available","bundleItems":[],"components":[],"detailUrl":"/chopp-brahma-claro-30l/p","ean":null,"id":"2","imageUrl":"http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000","isGift":false,"listPrice":49900,"manualPrice":null,"manualPriceAppliedBy":null,"manufacturerCode":null,"measurementUnit":"un","modalType":null,"name":"Chopp Brahma Claro 30L","offerings":[],"parentAssemblyBinding":null,"parentItemIndex":null,"preSaleDate":null,"price":32890,"priceDefinition":{"calculatedSellingPrice":32890,"sellingPrices":[{"quantity":1,"value":32890}],"total":32890},"priceTags":[],"priceValidUntil":"2025-04-15T13:52:27.985Z","productCategories":{"1":"Bebidas"},"productCategoryIds":"/1/","productId":"2005","productRefId":"","quantity":3,"refId":"CBC30L","rewardValue":0,"seller":"1","sellerChain":["1"],"sellingPrice":32890,"skuName":"Chopp Brahma Claro 30L","tax":0,"uniqueId":"9D6E447B3FF64CEDA33B17C01379C119","unitMultiplier":1}],"itemsOrdination":{"ascending":true,"criteria":"NAME"},"loggedIn":false,"marketingData":{"coupon":"free-shipping","utmCampaign":"Black friday","utmMedium":"CPC","utmSource":"app","utmiCampaign":null,"utmiPart":null,"utmipage":null},"messages":[],"openTextField":null,"orderFormId":"ede846222cd44046ba6c638442c3505a","paymentData":{"availableAccounts":[],"availableTokens":[],"giftCardMessages":[],"giftCards":[],"installmentOptions":[{"bin":null,"installments":[{"count":1,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":1,"hasInterestRate":false,"id":"LOJADOBRENO","interestRate":0,"total":15000,"value":15000}],"total":15000,"value":15000},{"count":2,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":2,"hasInterestRate":false,"id":"LOJADOBRENO","interestRate":0,"total":15000,"value":7500}],"total":15000,"value":7500}],"paymentGroupName":null,"paymentName":null,"paymentSystem":"2","value":15000}],"paymentSystems":[{"availablePayments":null,"description":null,"dueDate":"2025-04-15T13:52:27.985Z","groupName":"creditCardPaymentGroup","id":2,"isCustom":false,"name":"Visa","requiresAuthentication":false,"requiresDocument":false,"stringId":"2","template":"creditCardPaymentGroup-template","validator":{"cardCodeMask":"999","cardCodeRegex":"^[0-3]{8}$","mask":"9999 9999 9999 9999","regex":"^2[1-8]{17}$","useBillingAddress":true,"useCardHolderName":true,"useCvv":true,"useExpirationDate":true,"weights":[2,1,2,1,2,1]}}],"payments":[]},"profileProvider":"VTEX","ratesAndBenefitsData":{"rateAndBenefitsIdentifiers":[],"teaser":[]},"salesChannel":"1","selectableGifts":[],"sellers":[{"id":"1","logo":"","name":"lojadobreno"}],"shippingData":{"address":{"addressId":"teste","addressType":"residential","city":"Brasília","complement":"15º andar","country":"BRA","geoCoordinates":[-47.924747467041016,-15.832582473754883],"isDisposable":true,"neighborhood":"Copacabana","number":"123","postalCode":"70386000","receiverName":"Clark Kent","reference":null,"state":"DF","street":"Rua da minha casa"},"availableAddresses":[{"addressId":"teste","addressType":"residential","city":"Rio de Janeiro","complement":"15º andar","country":"BRA","geoCoordinates":[-47.924747467041016,-15.832582473754883],"isDisposable":true,"neighborhood":"Copacabana","number":"123","postalCode":"12345000","receiverName":"Clark Kent","reference":null,"state":"RJ","street":"Rua da minha casa"}],"logisticsInfo":[{"addressId":"teste","deliveryChannels":[{"id":"delivery"},{"id":"pickup-in-point"}],"itemId":"2","itemIndex":0,"selectedDeliveryChannel":"delivery","selectedSla":"Normal","shipsTo":["BRA","COL","USA"],"slas":[{"availableDeliveryWindows":[],"deliveryChannel":"delivery","deliveryIds":[{"courierId":"1","courierName":"Transportadora","dockId":"1","kitItemDetails":[],"quantity":1,"warehouseId":11}],"deliveryWindow":null,"id":"Normal","listPrice":1500,"lockTTL":"10d","name":"Normal","pickupDistance":0,"pickupPointId":null,"pickupStoreInfo":{"additionalInfo":null,"address":null,"dockId":null,"friendlyName":null,"isPickupStore":false},"polygonName":null,"price":1500,"shippingEstimate":"3bd","shippingEstimateDate":null,"tax":0,"transitTime":"3bd"}]}],"pickupPoints":[],"selectedAddresses":[{"addressId":"teste","addressType":"residential","city":"Rio de Janeiro","complement":"15º andar","country":"BRA","geoCoordinates":[-47.924747467041016,-15.832582473754883],"isDisposable":true,"neighborhood":"Copacabana","number":"123","postalCode":"12345000","receiverName":"Clark Kent","reference":null,"state":"RJ","street":"Rua da minha casa"}]},"storeId":null,"storePreferencesData":{"countryCode":"BRA","currencyCode":"BRL","currencyFormatInfo":{"currencyDecimalDigits":2,"currencyDecimalSeparator":",","currencyGroupSeparator":".","currencyGroupSize":3,"startsWithCurrencySymbol":true},"currencyLocale":1046,"currencySymboupdate cartl":"R$","saveUserData":true,"timeZone":"E. South America Standard Time"},"subscriptionData":null,"totalizers":[{"id":"Items","name":"Total dos Itens","value":15000}],"userProfileId":"fb542e51-5488-4c34-8d17-ed8fcf597a94","userType":null,"value":34390},"schema":{"properties":{"allowManualPrice":{"description":"Permission to modify item price manually.","type":"boolean"},"availableAccounts":{"description":"Available accounts.","items":{"type":"string"},"type":"array"},"availableAddresses":{"description":"Information on each available address.","items":{"properties":{"addressId":{"description":"Address ID.","type":"string"},"addressType":{"description":"Address type.","type":"string"},"city":{"description":"City of the address.","type":"string"},"complement":{"description":"Complement to the address.","nullable":true,"type":"string"},"country":{"description":"Country of the address. ISO three-letter code.","type":"string"},"geoCoordinates":{"description":"Array containing two floats with geocoordinates, first longitude, then latitude.","items":{"type":"number"},"type":"array"},"isDisposable":{"description":"Indicates whether address is disposable.","type":"boolean"},"neighborhood":{"description":"Neighborhood of the address.","type":"string"},"number":{"description":"Number of the address.","type":"string"},"receiverName":{"description":"Name of the receiver.","type":"string"},"reference":{"description":"Reference that may help in the location of the address.","nullable":true,"type":"string"},"state":{"description":"State of the address.","type":"string"},"street":{"description":"Street of the address.","type":"string"}},"type":"object"},"type":"array"},"canEditData":{"description":"Data can be edited.","type":"boolean"},"clientPreferencesData":{"description":"Object containing preferences from the client who placed the order.","properties":{"locale":{"description":"Client's locale. Examples: `pt-BR` and `en-US`.","type":"string"},"optinNewsLetter":{"default":false,"description":"`true` if the client opted to receive newsletter from the store.","type":"boolean"}},"type":"object"},"clientProfileData":{"description":"Customer's profile information.","properties":{"corporateDocument":{"description":"Corporate document, if the customer is a legal entity.","nullable":true,"type":"string"},"corporateName":{"description":"Company name, if the customer is a legal entity.","nullable":true,"type":"string"},"corporatePhone":{"description":"Corporate phone number, if the customer is a legal entity.","nullable":true,"type":"string"},"customerClass":{"description":"Customer class.","nullable":true,"type":"string"},"document":{"description":"Document informed by the customer.","type":"string"},"documentType":{"description":"Type of the document informed by the customer.","type":"string"},"email":{"description":"Email address.","type":"string"},"firstName":{"description":"First name.","type":"string"},"isCorporate":{"description":"Indicates whether the customer is a legal entity.","type":"boolean"},"lastName":{"description":"Last name.","type":"string"},"phone":{"description":"Phone number.","type":"string"},"profileCompleteOnLoading":{"description":"Indicates whether profile is complete on loading.","type":"boolean"},"profileErrorOnLoading":{"description":"Indicates whether profile presents error on loading.","nullable":true,"type":"boolean"},"stateInscription":{"description":"State inscription, if the customer is a legal entity.","nullable":true,"type":"string"},"tradeName":{"description":"Trade name, if the customer is a legal entity.","nullable":true,"type":"string"}},"type":"object"},"commercialConditionData":{"description":"Object containing commercial condition information.","nullable":true,"type":"object"},"customData":{"description":"Customer additional information.","nullable":true,"type":"object"},"giftRegistryData":{"description":"Gift registry list information.","nullable":true,"type":"object"},"hooksData":{"description":"Hooks information.","nullable":true,"type":"object"},"ignoreProfileData":{"description":"Ignore customer profile data.","type":"boolean"},"invoiceData":{"description":"Object containing information pertinent to the order's invoice.","nullable":true,"type":"object"},"isCheckedIn":{"description":"Indicates whether order is checked in.","type":"boolean"},"itemMetadata":{"description":"Item metadata.","properties":{"items":{"description":"List of objects containing metadata on each item in the order.","items":{"properties":{"detailUrl":{"description":"Detail URL.","type":"string"},"ean":{"description":"European Article Number.","nullable":true,"type":"string"},"id":{"description":"Item ID.","type":"string"},"imageUrl":{"description":"Image URL.","type":"string"},"name":{"description":"Product name.","type":"string"},"productId":{"description":"Product ID.","type":"string"},"refId":{"description":"Ref ID.","type":"string"},"seller":{"description":"Seller.","type":"string"},"skuName":{"description":"SKU name.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"items":{"description":"Information on each item in the order.","items":{"properties":{"additionalInfo":{"description":"Additional information.","properties":{"brandId":{"description":"Brand ID.","type":"string"},"brandName":{"description":"Brand name.","type":"string"},"dimension":{"description":"Dimension.","nullable":true,"type":"string"},"offeringInfo":{"description":"Offering information.","nullable":true,"type":"string"},"offeringType":{"description":"Offering type.","nullable":true,"type":"string"},"offeringTypeId":{"description":"Offering type ID.","nullable":true,"type":"string"}},"type":"object"},"attachments":{"description":"Array containing information on attachments.","items":{"type":"string"},"type":"array"},"availability":{"description":"Availability.","type":"string"},"bundleItems":{"description":"Information on services sold along with the SKU. Example: a gift package.","items":{"properties":{"id":{"description":"Service identifier.","type":"integer"},"name":{"description":"Service name.","type":"string"},"price":{"description":"Service price in cents.","type":"integer"},"type":{"description":"Service type.","type":"string"}},"type":"object"},"type":"array"},"detailUrl":{"description":"Detail URL.","type":"string"},"ean":{"description":"European Article Number.","nullable":true,"type":"string"},"id":{"description":"ID of the item.","type":"string"},"imageUrl":{"description":"Image URL.","type":"string"},"isGift":{"description":"Indicates whether item is a gift.","type":"boolean"},"listPrice":{"description":"List price in cents.","type":"integer"},"manualPrice":{"description":"Manual price in cents.","nullable":true,"type":"integer"},"manualPriceAppliedBy":{"description":"User that applied the manual price, if that is the case.","nullable":true,"type":"string"},"manufacturerCode":{"description":"Manufacturer code.","nullable":true,"type":"string"},"measurementUnit":{"description":"Measurement unit.","type":"string"},"modalType":{"description":"Modal type.","nullable":true,"type":"string"},"name":{"description":"Product name.","type":"string"},"parentAssemblyBinding":{"description":"Parent assembly binding.","nullable":true,"type":"string"},"parentItemIndex":{"description":"Parent item index.","nullable":true,"type":"integer"},"preSaleDate":{"description":"Presale date.","nullable":true,"type":"string"},"price":{"description":"Price in cents.","type":"integer"},"priceDefinition":{"description":"Price information for all units of a specific item.","properties":{"calculatedSellingPrice":{"description":"Item's calculated unitary selling price in cents.","type":"integer"},"sellingPrices":{"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":{"properties":{"quantity":{"description":"Rounding quantity, meaning how many items are rounded to this value.","type":"integer"},"value":{"description":"Value in cents for that specific rounding.","type":"integer"}},"type":"object"},"type":"array"},"total":{"description":"Total value for all units of the item in cents.","type":"integer"}},"type":"object"},"priceTags":{"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":{"properties":{"identifier":{"description":"Price tag identifier.","type":"string"},"isPercentual":{"description":"Indicates whether price tag value is applied through a percentage.","type":"boolean"},"name":{"description":"Price tag name.","type":"string"},"rawValue":{"description":"Price tag raw value.","type":"integer"},"value":{"description":"Price tag value.","type":"integer"}},"type":"object"},"type":"array"},"priceValidUntil":{"description":"Price expiration date and time.","type":"string"},"productCategories":{"description":"Object, where each field is an ID from `productCategoryIds`.","properties":{"{ID}":{"description":"Product category corresponding to the ID in the field key.","type":"string"}},"type":"object"},"productCategoryIds":{"description":"Product category IDs.","type":"string"},"productId":{"description":"Product ID.","type":"string"},"productRefId":{"description":"Product Ref ID.","type":"string"},"quantity":{"description":"Quantity.","type":"integer"},"refId":{"description":"Ref ID.","type":"string"},"rewardValue":{"description":"Reward value in cents.","type":"integer"},"seller":{"description":"Seller.","type":"string"},"sellerChain":{"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":{"description":"Seller.","type":"string"},"type":"array"},"sellingPrice":{"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.","type":"integer"},"skuName":{"description":"SKU name.","type":"string"},"tax":{"description":"Tax value in cents.","type":"integer"},"uniqueId":{"description":"Unique ID.","type":"string"},"unitMultiplier":{"description":"Unit multiplier.","type":"integer"}},"type":"object"},"type":"array"},"itemsOrdination":{"description":"Object containing information about the ordering of items within the orderForm.","properties":{"ascending":{"description":"Indicates whether the ordering is ascending.","type":"boolean"},"criteria":{"description":"Criteria adopted to order the items in the list.","type":"string"}},"type":"object"},"loggedIn":{"description":"Indicates whether the user is logged into the store.","type":"boolean"},"marketingData":{"description":"Object containing promotion data such as coupon tracking information and internal or external UTMs.","properties":{"coupon":{"default":"free-shipping","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.","type":"string"},"utmCampaign":{"default":"Black friday","description":"UTM campaign","type":"string"},"utmMedium":{"default":"CPC","description":"UTM medium.","type":"string"},"utmSource":{"default":"Facebook","description":"UTM source.","type":"string"},"utmiCampaign":{"default":"utmi_campaign-example","description":"utmi_campaign (internal utm).","nullable":true,"type":"string"},"utmiPage":{"default":"utmi_page-example","description":"utmi_page (internal utm).","nullable":true,"type":"string"},"utmiPart":{"default":"utmi_part-example","description":"utmi_part (internal utm).","nullable":true,"type":"string"}},"type":"object"},"messages":{"description":"Array containing an object for each message generated by our servers while processing the request.","items":{},"type":"array"},"openTextField":{"default":"open-text-example","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,"type":"string"},"orderFormId":{"description":"ID of the orderForm corresponding to a specific cart.","type":"string"},"paymentData":{"description":"Information on the order's payment.","properties":{"giftCards":{"description":"Gift card information, if it applies to the order.","items":{"properties":{"balance":{"description":"Gift card balance in cents.","type":"integer"},"id":{"description":"Gift card ID.","type":"string"},"inUse":{"description":"Indicates whether gift card is in use.","type":"boolean"},"isSpecialCard":{"description":"Indicates whether gift card is special.","type":"boolean"},"name":{"description":"Gift card name.","type":"string"},"redemptionCode":{"description":"Gift card redemption code.","type":"string"},"value":{"description":"Gift card value in cents.","type":"integer"}},"type":"object"},"type":"array"},"transactions":{"description":"Information on each transaction pertinent to the order.","items":{"properties":{"isActive":{"description":"Indicates whether transaction is active.","type":"boolean"},"merchantName":{"description":"Merchant name.","type":"string"},"payments":{"description":"Information on each payment.","items":{"properties":{"accountId":{"description":"Account ID.","type":"string"},"bin":{"description":"Bin.","type":"string"},"installments":{"description":"Number of installments.","type":"integer"},"paymentSystem":{"description":"Payment system.","type":"string"},"referenceValue":{"description":"Reference value for calculating interest rates, in case it applies. Displayed in cents.","type":"integer"},"value":{"description":"Value including interest, in case it applies. Displayed in cents.","type":"integer"}},"type":"object"},"type":"array"},"sharedTransaction":{"description":"Indicates whather transaction is shared.","type":"boolean"},"transactionId":{"description":"Transaction ID.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"profileProvider":{"description":"Profile provider.","type":"string"},"ratesAndBenefitsData":{"description":"Information on rates and benefits that apply to the order.","properties":{"rateAndBenefitsIdentifiers":{"description":"List with rates and benefits identifiers.","items":{"type":"string"},"type":"array"},"teaser":{"description":"List with rates and benefits teasers.","items":{"type":"string"},"type":"array"}},"type":"object"},"salesChannel":{"description":"Attribute created by the seller, in their VTEX store configuration.","type":"string"},"selectableGifts":{"description":"Array containing the data of the item selected as a gift.","items":{},"type":"array"},"sellers":{"description":"Information on each seller.","items":{"properties":{"id":{"description":"Seller ID.","type":"string"},"logo":{"description":"Seller logo.","nullable":true,"type":"string"},"name":{"description":"Seller name.","type":"string"}},"type":"object"},"type":"array"},"shippingData":{"description":"Shipping information pertinent to the order.","properties":{"address":{"description":"Address information.","properties":{"addressId":{"description":"Address ID.","type":"string"},"addressType":{"description":"Type of address. For example, `Residential` or `Pickup`.","type":"string"},"city":{"description":"City of the shipping address.","type":"string"},"complement":{"description":"Complement to the shipping address, in case it applies.","nullable":true,"type":"string"},"country":{"description":"Three letter ISO code of the country of the shipping address.","type":"string"},"geoCoordinates":{"description":"Array containing two floats with geocoordinates, first longitude, then latitude.","items":{"type":"number"},"type":"array"},"isDisposable":{"description":"Indicates whether address is disposable.","type":"boolean"},"neighborhood":{"description":"Neighborhood of the shipping address.","type":"string"},"number":{"description":"Number of the building, house or apartment in the shipping address.","type":"string"},"postalCode":{"description":"Postal code.","type":"string"},"receiverName":{"description":"Name of the person who is going to receive the order.","type":"string"},"reference":{"description":"Complement that might help locate the shipping address more precisely in case of delivery.","nullable":true,"type":"string"},"state":{"description":"State of the shipping address.","type":"string"},"street":{"description":"Street of the shipping address.","type":"string"}},"type":"object"},"availableAddresses":{"description":"Array with information on the available addresses for the order.","items":{"properties":{"addressId":{"description":"Address ID.","type":"string"},"addressType":{"description":"Type of address. For example, `Residential` or `Pickup`.","type":"string"},"city":{"description":"City of the shipping address.","type":"string"},"complement":{"description":"Complement to the shipping address, in case it applies.","type":"string"},"country":{"description":"Three letter ISO code of the country of the shipping address.","type":"string"},"geoCoordinates":{"description":"Array containing two floats with geocoordinates, first longitude, then latitude.","items":{"type":"number"},"type":"array"},"isDisposable":{"description":"Indicates whether address is disposable.","type":"boolean"},"neighborhood":{"description":"Neighborhood of the shipping address.","type":"string"},"number":{"description":"Number of the building, house or apartment in the shipping address.","type":"string"},"postalCode":{"description":"Postal code.","type":"string"},"receiverName":{"description":"Name of the person who is going to receive the order.","type":"string"},"reference":{"description":"Complement that might help locate the shipping address more precisely in case of delivery.","nullable":true,"type":"string"},"state":{"description":"State of the shipping address.","type":"string"},"street":{"description":"Street of the shipping address.","type":"string"}},"type":"object"},"type":"array"},"logisticsInfo":{"description":"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.","items":{"properties":{"addressId":{"description":"Address ID.","type":"string"},"deliveryChannels":{"description":"List of available delivery channels.","items":{"properties":{"id":{"description":"Delivery channel ID.","type":"string"}},"type":"object"},"type":"array"},"itemId":{"description":"Item ID.","type":"string"},"itemIndex":{"description":"Index corresponding to the position of the object in the `items` array.","type":"integer"},"selectedDeliveryChannel":{"description":"Delivery channel selected by the customer.","type":"string"},"selectedSla":{"description":"SLA selected by the customer.","type":"string"},"shipsTo":{"description":"List of countries that the item may be shipped to.","items":{"description":"Three letter country code.","type":"string"},"type":"array"},"slas":{"description":"Information on available SLAs.","items":{"properties":{"deliveryChannel":{"description":"Delivery channel.","type":"string"},"deliveryIds":{"description":"Information on each delivery ID.","items":{"properties":{"courierId":{"description":"Courier ID.","type":"string"},"courierName":{"description":"Courier name.","type":"string"},"dockId":{"description":"Warehouse ID.","type":"string"},"quantity":{"description":"Quantity.","type":"integer"},"warehouseId":{"description":"Warehouse ID.","type":"string"}},"type":"object"},"type":"array"},"id":{"description":"SLA ID.","type":"string"},"listPrice":{"description":"List price in cents.","type":"integer"},"lockTTL":{"description":"Estimate date of delivery.","type":"string"},"name":{"description":"SLA name.","type":"string"},"pickupDistance":{"description":"Pickup point distance.","type":"integer"},"pickupPointId":{"description":"Pickup point ID.","nullable":true,"type":"string"},"pickupStoreInfo":{"description":"Information on the pickup store.","properties":{"additionalInfo":{"description":"Additional information.","nullable":true,"type":"string"},"address":{"description":"Address information.","nullable":true,"properties":{"addressType":{"description":"Type of address. For example, `Residential` or `Pickup`.","type":"string"},"city":{"description":"City of the shipping address.","type":"string"},"complement":{"description":"Complement to the shipping address, in case it applies.","nullable":true,"type":"string"},"country":{"description":"Three letter ISO code of the country of the shipping address.","type":"string"},"geoCoordinates":{"description":"Array containing two floats with geocoordinates, first longitude, then latitude.","items":{"type":"number"},"type":"array"},"neighborhood":{"description":"Neighborhood of the shipping address.","type":"string"},"number":{"description":"Number of the building, house or apartment in the shipping address.","type":"string"},"postalCode":{"description":"Postal code.","type":"string"},"reference":{"description":"Complement that might help locate the shipping address more precisely in case of delivery.","nullable":true,"type":"string"},"state":{"description":"State of the shipping address.","type":"string"},"street":{"description":"Street of the shipping address.","type":"string"}},"type":"object"},"dockId":{"description":"Corresponding dock ID.","nullable":true,"type":"string"},"friendlyName":{"description":"Friendly name.","nullable":true,"type":"string"},"isPickupStore":{"description":"Indicates whether it is the pickup store.","type":"boolean"}},"type":"object"},"polygonName":{"description":"Polygon name.","nullable":true,"type":"string"},"price":{"description":"Price in cents.","type":"integer"},"shippingEstimate":{"description":"Shipping estimate. For instance, Three business days will be represented `3bd`.","type":"string"},"shippingEstimateDate":{"description":"Shipping estimate date.","nullable":true,"type":"string"},"tax":{"description":"Tax in cents.","type":"integer"},"transitTime":{"description":"Transit time. For instance, \"three business days\" is represented `3bd`.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"},"selectedAddresses":{"description":"Array with information on the selected addresses for the order.","items":{"properties":{"addressId":{"description":"Address ID.","type":"string"},"addressType":{"description":"Type of address. For example, `Residential` or `Pickup`.","type":"string"},"city":{"description":"City of the shipping address.","type":"string"},"complement":{"description":"Complement to the shipping address, in case it applies.","type":"string"},"country":{"description":"Three letter ISO code of the country of the shipping address.","type":"string"},"geoCoordinates":{"description":"Array containing two floats with geocoordinates, first longitude, then latitude.","items":{"type":"number"},"type":"array"},"isDisposable":{"description":"Indicates whether address is disposable.","type":"boolean"},"neighborhood":{"description":"Neighborhood of the shipping address.","type":"string"},"number":{"description":"Number of the building, house or apartment in the shipping address.","type":"string"},"postalCode":{"description":"Postal code.","type":"string"},"receiverName":{"description":"Name of the person who is going to receive the order.","type":"string"},"reference":{"description":"Complement that might help locate the shipping address more precisely in case of delivery.","nullable":true,"type":"string"},"state":{"description":"State of the shipping address.","type":"string"},"street":{"description":"Street of the shipping address.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"storeId":{"description":"ID of the store.","nullable":true,"type":"string"},"storePreferencesData":{"description":"Object containing data from the store's configuration (stored in VTEX's License Manager).","type":"object"},"subscriptionData":{"description":"Subscription information.","nullable":true,"type":"object"},"totalizers":{"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":"array"},"userProfileId":{"description":"Unique ID associated with the customer profile.","type":"string"},"userType":{"description":"User type.","nullable":true,"type":"string"},"value":{"description":"Total value of the order without separating cents. For example, $24.99 is represented `2499`.","type":"integer"}},"type":"object"}}},"description":"OK"}},"security":[],"summary":"Add cart items","tags":["Shopping cart"]}},"/api/checkout/pub/orderForm/{orderFormId}/items/removeAll":{"post":{"deprecated":false,"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","parameters":[{"description":"ID of the orderForm corresponding to the cart whose items you want to remove.","in":"path","name":"orderFormId","required":true,"schema":{"default":"ede846222cd44046ba6c638442c3505a","type":"string"},"style":"simple"},{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"default":{},"description":"This object must be empty.","properties":{},"title":"","type":"object"}}},"description":""},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"allowManualPrice":false,"canEditData":true,"checkedInPickupPointId":null,"clientPreferencesData":{"locale":"pt-BR","optinNewsLetter":null},"clientProfileData":{"corporateDocument":null,"corporateName":null,"corporatePhone":null,"customerClass":null,"document":"769387308","documentType":"dni","email":"john.doe@google.com","firstName":"John","isCorporate":false,"lastName":"Doe","phone":"+5491111223344","profileCompleteOnLoading":false,"profileErrorOnLoading":false,"stateInscription":null,"tradeName":null},"commercialConditionData":null,"customData":null,"giftRegistryData":null,"hooksData":null,"ignoreProfileData":false,"invoiceData":null,"isCheckedIn":false,"itemMetadata":{"items":[]},"items":[],"itemsOrdination":null,"loggedIn":false,"marketingData":null,"messages":[],"openTextField":null,"orderFormId":"ede846222cd44046ba6c638442c3505a","paymentData":{"availableAccounts":[],"availableTokens":[],"giftCardMessages":[],"giftCards":[],"installmentOptions":[{"bin":null,"installments":[{"count":1,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":1,"hasInterestRate":false,"id":"LOJADOBRENO","interestRate":0,"total":15000,"value":15000}],"total":15000,"value":15000}],"paymentGroupName":null,"paymentName":null,"paymentSystem":"2","value":15000}],"paymentSystems":[{"availablePayments":null,"description":null,"dueDate":"2025-04-15T13:52:27.986Z","groupName":"creditCardPaymentGroup","id":4,"isCustom":false,"name":"Mastercard","requiresAuthentication":false,"requiresDocument":false,"stringId":"4","template":"creditCardPaymentGroup-template","validator":{"cardCodeMask":"999","cardCodeRegex":"^[1-3]{9}$","mask":"9999 9999 9999 9999","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})","useBillingAddress":true,"useCardHolderName":true,"useCvv":true,"useExpirationDate":true,"weights":[2,1,2,1,2]}}],"payments":[]},"ratesAndBenefitsData":null,"salesChannel":"1","selectableGifts":[],"sellers":[],"shippingData":{"address":null,"availableAddresses":[],"logisticsInfo":[],"pickupPoints":[],"selectedAddresses":[]},"storeId":null,"storePreferencesData":{"countryCode":"BRA","currencyCode":"BRL","currencyFormatInfo":{"currencyDecimalDigits":2,"currencyDecimalSeparator":",","currencyGroupSeparator":".","currencyGroupSize":3,"startsWithCurrencySymbol":true},"currencyLocale":1046,"currencySymbol":"R$","saveUserData":true,"timeZone":"E. South America Standard Time"},"subscriptionData":null,"totalizers":[],"userProfileId":null,"userType":null,"value":0}}},"schema":{"type":"object"}}},"description":"","headers":{}}},"security":[],"summary":"Remove all items","tags":["Shopping cart"]}},"/api/checkout/pub/orderForm/{orderFormId}/items/update":{"post":{"deprecated":false,"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","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"ID of the `orderForm` corresponding to the cart whose items you want to update.","in":"path","name":"orderFormId","required":true,"schema":{"default":"ede846222cd44046ba6c638442c3505a","type":"string"},"style":"simple"},{"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”`.","in":"query","name":"allowedOutdatedData","required":false,"schema":{"default":["paymentData"],"items":{},"type":"array"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"orderItems":{"description":"Array containing the cart items. Each object inside this array corresponds to a different item.","items":{"properties":{"index":{"description":"The position of the item in the array.","example":0,"type":"integer"},"quantity":{"description":"The quantity of the item in the cart.","example":3,"format":"int32","type":"integer"}},"required":["quantity","index"],"type":"object"},"type":"array"}},"type":"object"}}},"description":"","required":true},"responses":{"200":{"content":{"application/json":{"example":{"allowManualPrice":false,"availableAccounts":[],"availableAddresses":[{"addressId":"666c2e830bd9474ab6f6cc53fb6dd2d2","addressType":"residential","city":"Brasília","complement":"15º andar","country":"BRA","geoCoordinates":["-47.924747467041016","-15.832582473754883"],"isDisposable":true,"neighborhood":"Copacabana","number":"123","postalCode":"70386000","receiverName":"Clark Kent","reference":null,"state":"DF","street":"Rua da minha casa"}],"canEditData":true,"clientPreferencesData":{"locale":"pt-BR","optinNewsLetter":false},"clientProfileData":{"corporateDocument":null,"corporateName":null,"corporatePhone":null,"customerClass":null,"document":"12345678900","documentType":"cpf","email":"clark.kent@example.com","firstName":"Clark","isCorporate":false,"lastName":"Kent","phone":"+5521998765432","profileCompleteOnLoading":false,"profileErrorOnLoading":null,"stateInscription":null,"tradeName":null},"commercialConditionData":null,"customData":null,"giftRegistryData":null,"hooksData":null,"ignoreProfileData":false,"invoiceData":null,"isCheckedIn":false,"itemMetadata":{"items":[{"assemblyOptions":[],"detailUrl":"/racao-royal-canin-feline-urinary/p","ean":"123456789","id":"1","imageUrl":"http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000","name":"Ração Royal Canin Feline Urinary 500g","productId":"1","refId":"0001","seller":"1","skuName":"Ração Royal Canin Feline Urinary 500g"}]},"items":[{"additionalInfo":{"brandId":"2000000","brandName":"Brahma","dimension":null,"offeringInfo":null,"offeringType":null,"offeringTypeId":null},"assemblies":[],"attachmentOfferings":[],"attachments":[],"availability":"available","bundleItems":[],"components":[],"detailUrl":"/chopp-brahma-claro-30l/p","ean":null,"id":"2","imageUrl":"http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000","isGift":false,"listPrice":49900,"manualPrice":null,"manualPriceAppliedBy":null,"manufacturerCode":null,"measurementUnit":"un","modalType":null,"name":"Chopp Brahma Claro 30L","offerings":[],"parentAssemblyBinding":null,"parentItemIndex":null,"preSaleDate":null,"price":32890,"priceDefinition":{"calculatedSellingPrice":32890,"sellingPrices":[{"quantity":1,"value":32890}],"total":32890},"priceTags":[],"priceValidUntil":"2025-04-15T13:52:27.986Z","productCategories":{"1":"Bebidas"},"productCategoryIds":"/1/","productId":"2","productRefId":"","quantity":1,"refId":"CBC30L","rewardValue":0,"seller":"1","sellerChain":["1"],"sellingPrice":32890,"skuName":"Chopp Brahma Claro 30L","tax":0,"uniqueId":"9D6E447B3FF64CEDA33B17C01379C119","unitMultiplier":1}],"itemsOrdination":{"ascending":true,"criteria":"NAME"},"loggedIn":false,"marketingData":{"coupon":"free-shipping","utmCampaign":"Black friday","utmMedium":"CPC","utmSource":"app","utmiCampaign":null,"utmiPart":null,"utmipage":null},"messages":[],"openTextField":null,"orderFormId":"ede846222cd44046ba6c638442c3505a","paymentData":{"availableAccounts":[],"availableTokens":[],"giftCardMessages":[],"giftCards":[],"installmentOptions":[{"bin":null,"installments":[{"count":1,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":1,"hasInterestRate":false,"id":"LOJADOBRENO","interestRate":0,"total":15000,"value":15000}],"total":15000,"value":15000},{"count":2,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":2,"hasInterestRate":false,"id":"LOJADOBRENO","interestRate":0,"total":15000,"value":7500}],"total":15000,"value":7500}],"paymentGroupName":null,"paymentName":null,"paymentSystem":"2","value":15000}],"paymentSystems":[{"availablePayments":null,"description":null,"dueDate":"2025-04-15T13:52:27.986Z","groupName":"creditCardPaymentGroup","id":2,"isCustom":false,"name":"Visa","requiresAuthentication":false,"requiresDocument":false,"stringId":"2","template":"creditCardPaymentGroup-template","validator":{"cardCodeMask":"999","cardCodeRegex":"^[0-3]{8}$","mask":"9999 9999 9999 9999","regex":"^2[1-8]{17}$","useBillingAddress":true,"useCardHolderName":true,"useCvv":true,"useExpirationDate":true,"weights":[2,1,2,1,2,1]}}],"payments":[]},"profileProvider":"VTEX","ratesAndBenefitsData":{"rateAndBenefitsIdentifiers":[],"teaser":[]},"salesChannel":"1","selectableGifts":[],"sellers":[{"id":"1","logo":"","name":"lojadobreno"}],"shippingData":{"address":{"addressId":"teste","addressType":"residential","city":"Brasília","complement":"15º andar","country":"BRA","geoCoordinates":["-47.924747467041016","-15.832582473754883"],"isDisposable":true,"neighborhood":"Copacabana","number":"123","postalCode":"70386000","receiverName":"Clark Kent","reference":null,"state":"DF","street":"Rua da minha casa"},"availableAddresses":[{"addressId":"teste","addressType":"residential","city":"Rio de Janeiro","complement":"15º andar","country":"BRA","geoCoordinates":["-47.924747467041016","-15.832582473754883"],"isDisposable":true,"neighborhood":"Copacabana","number":"123","postalCode":"12345000","receiverName":"Clark Kent","reference":null,"state":"RJ","street":"Rua da minha casa"}],"logisticsInfo":[{"addressId":"teste","deliveryChannels":[{"id":"delivery"},{"id":"pickup-in-point"}],"itemId":"2","itemIndex":0,"selectedDeliveryChannel":"delivery","selectedSla":"Normal","shipsTo":["BRA","COL","USA"],"slas":[{"availableDeliveryWindows":[],"deliveryChannel":"delivery","deliveryIds":[{"courierId":"1","courierName":"Transportadora","dockId":"1","kitItemDetails":[],"quantity":1,"warehouseId":11}],"deliveryWindow":null,"id":"Normal","listPrice":1500,"lockTTL":"10d","name":"Normal","pickupDistance":0,"pickupPointId":null,"pickupStoreInfo":{"additionalInfo":null,"address":null,"dockId":null,"friendlyName":null,"isPickupStore":false},"polygonName":null,"price":1500,"shippingEstimate":"3bd","shippingEstimateDate":null,"tax":0,"transitTime":"3bd"}]}],"pickupPoints":[],"selectedAddresses":[{"addressId":"teste","addressType":"residential","city":"Rio de Janeiro","complement":"15º andar","country":"BRA","geoCoordinates":["-47.924747467041016","-15.832582473754883"],"isDisposable":true,"neighborhood":"Copacabana","number":"123","postalCode":"12345000","receiverName":"Clark Kent","reference":null,"state":"RJ","street":"Rua da minha casa"}]},"storeId":null,"storePreferencesData":{"countryCode":"BRA","currencyCode":"BRL","currencyFormatInfo":{"currencyDecimalDigits":2,"currencyDecimalSeparator":",","currencyGroupSeparator":".","currencyGroupSize":3,"startsWithCurrencySymbol":true},"currencyLocale":1046,"currencySymboupdate cartl":"R$","saveUserData":true,"timeZone":"E. South America Standard Time"},"subscriptionData":null,"totalizers":[{"id":"Items","name":"Total dos Itens","value":15000}],"userProfileId":"fb542e51-5488-4c34-8d17-ed8fcf597a94","userType":null,"value":34390},"schema":{"properties":{"allowManualPrice":{"description":"Permission to modify item price manually.","type":"boolean"},"availableAccounts":{"description":"Available accounts.","items":{"type":"string"},"type":"array"},"availableAddresses":{"description":"Information on each available address.","items":{"properties":{"addressId":{"description":"Address ID.","type":"string"},"addressType":{"description":"Address type.","type":"string"},"city":{"description":"City of the address.","type":"string"},"complement":{"description":"Complement to the address.","nullable":true,"type":"string"},"country":{"description":"Country of the address. ISO three-letter code.","type":"string"},"geoCoordinates":{"description":"List with the two geocoordinates.","items":{"type":"string"},"type":"array"},"isDisposable":{"description":"Indicates whether address is disposable.","type":"boolean"},"neighborhood":{"description":"Neighborhood of the address.","type":"string"},"number":{"description":"Number of the address.","type":"string"},"receiverName":{"description":"Name of the receiver.","type":"string"},"reference":{"description":"Reference that may help in the location of the address.","nullable":true,"type":"string"},"state":{"description":"State of the address.","type":"string"},"street":{"description":"Street of the address.","type":"string"}},"type":"object"},"type":"array"},"canEditData":{"description":"Data can be edited.","type":"boolean"},"clientPreferencesData":{"description":"Object containing preferences from the client who placed the order.","properties":{"locale":{"description":"Client's locale. Examples: `pt-BR` and `en-US`.","type":"string"},"optinNewsLetter":{"default":false,"description":"`true` if the client opted to receive newsletter from the store.","type":"boolean"}},"type":"object"},"clientProfileData":{"description":"Customer's profile information.","properties":{"corporateDocument":{"description":"Corporate document, if the customer is a legal entity.","nullable":true,"type":"string"},"corporateName":{"description":"Company name, if the customer is a legal entity.","nullable":true,"type":"string"},"corporatePhone":{"description":"Corporate phone number, if the customer is a legal entity.","nullable":true,"type":"string"},"customerClass":{"description":"Customer class.","nullable":true,"type":"string"},"document":{"description":"Document informed by the customer.","type":"string"},"documentType":{"description":"Type of the document informed by the customer.","type":"string"},"email":{"description":"Email address.","type":"string"},"firstName":{"description":"First name.","type":"string"},"isCorporate":{"description":"Indicates whether the customer is a legal entity.","type":"boolean"},"lastName":{"description":"Last name.","type":"string"},"phone":{"description":"Phone number.","type":"string"},"profileCompleteOnLoading":{"description":"Indicates whether profile is complete on loading.","type":"boolean"},"profileErrorOnLoading":{"description":"Indicates whether profile presents error on loading.","nullable":true,"type":"boolean"},"stateInscription":{"description":"State inscription, if the customer is a legal entity.","nullable":true,"type":"string"},"tradeName":{"description":"Trade name, if the customer is a legal entity.","nullable":true,"type":"string"}},"type":"object"},"commercialConditionData":{"description":"Object containing commercial condition information.","nullable":true,"type":"object"},"customData":{"description":"Customer additional information.","nullable":true,"type":"object"},"giftRegistryData":{"description":"Gift registry list information.","nullable":true,"type":"object"},"hooksData":{"description":"Hooks information.","nullable":true,"type":"object"},"ignoreProfileData":{"description":"Ignore customer profile data.","type":"boolean"},"invoiceData":{"description":"Object containing information pertinent to the order's invoice.","nullable":true,"type":"object"},"isCheckedIn":{"description":"Indicates whether order is checked in.","type":"boolean"},"itemMetadata":{"description":"Item metadata.","properties":{"items":{"description":"List of objects containing metadata on each item in the order.","items":{"properties":{"detailUrl":{"description":"Detail URL.","type":"string"},"ean":{"description":"European Article Number.","nullable":true,"type":"string"},"id":{"description":"Item ID.","type":"string"},"imageUrl":{"description":"Image URL.","type":"string"},"name":{"description":"Product name.","type":"string"},"productId":{"description":"Product ID.","type":"string"},"refId":{"description":"Ref ID.","type":"string"},"seller":{"description":"Seller.","type":"string"},"skuName":{"description":"SKU name.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"items":{"description":"Information on each item in the order.","items":{"properties":{"additionalInfo":{"description":"Additional information.","properties":{"brandId":{"description":"Brand ID.","type":"string"},"brandName":{"description":"Brand name.","type":"string"},"dimension":{"description":"Dimension.","nullable":true,"type":"string"},"offeringInfo":{"description":"Offering information.","nullable":true,"type":"string"},"offeringType":{"description":"Offering type.","nullable":true,"type":"string"},"offeringTypeId":{"description":"Offering type ID.","nullable":true,"type":"string"}},"type":"object"},"attachments":{"description":"Array containing information on attachments.","items":{"type":"string"},"type":"array"},"availability":{"description":"Availability.","type":"string"},"bundleItems":{"description":"Information on services sold along with the SKU. Example: a gift package.","items":{"properties":{"id":{"description":"Service identifier.","type":"integer"},"name":{"description":"Service name.","type":"string"},"price":{"description":"Service price in cents.","type":"integer"},"type":{"description":"Service type.","type":"string"}},"type":"object"},"type":"array"},"detailUrl":{"description":"Detail URL.","type":"string"},"ean":{"description":"European Article Number.","nullable":true,"type":"string"},"id":{"description":"ID of the item.","type":"string"},"imageUrl":{"description":"Image URL.","type":"string"},"isGift":{"description":"Indicates whether item is a gift.","type":"boolean"},"listPrice":{"description":"List price in cents.","type":"integer"},"manualPrice":{"description":"Manual price in cents.","nullable":true,"type":"integer"},"manualPriceAppliedBy":{"description":"User that applied the manual price, if that is the case.","nullable":true,"type":"string"},"manufacturerCode":{"description":"Manufacturer code.","nullable":true,"type":"string"},"measurementUnit":{"description":"Measurement unit.","type":"string"},"modalType":{"description":"Modal type.","nullable":true,"type":"string"},"name":{"description":"Product name.","type":"string"},"parentAssemblyBinding":{"description":"Parent assembly binding.","nullable":true,"type":"string"},"parentItemIndex":{"description":"Parent item index.","nullable":true,"type":"integer"},"preSaleDate":{"description":"Presale date.","nullable":true,"type":"string"},"price":{"description":"Price in cents.","type":"integer"},"priceDefinition":{"description":"Price information for all units of a specific item.","properties":{"calculatedSellingPrice":{"description":"Item's calculated unitary selling price in cents.","type":"integer"},"sellingPrices":{"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":{"properties":{"quantity":{"description":"Rounding quantity, meaning how many items are rounded to this value.","type":"integer"},"value":{"description":"Value in cents for that specific rounding.","type":"integer"}},"type":"object"},"type":"array"},"total":{"description":"Total value for all units of the item in cents.","type":"integer"}},"type":"object"},"priceTags":{"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":{"properties":{"identifier":{"description":"Price tag identifier.","type":"string"},"isPercentual":{"description":"Indicates whether price tag value is applied through a percentage.","type":"boolean"},"name":{"description":"Price tag name.","type":"string"},"rawValue":{"description":"Price tag raw value.","type":"integer"},"value":{"description":"Price tag value.","type":"integer"}},"type":"object"},"type":"array"},"priceValidUntil":{"description":"Price expiration date and time.","type":"string"},"productCategories":{"description":"Object, where each field is an ID from `productCategoryIds`.","properties":{"{ID}":{"description":"Product category corresponding to the ID in the field key.","type":"string"}},"type":"object"},"productCategoryIds":{"description":"Product category IDs.","type":"string"},"productId":{"description":"Product ID.","type":"string"},"productRefId":{"description":"Product Ref ID.","type":"string"},"quantity":{"description":"Quantity.","type":"integer"},"refId":{"description":"Ref ID.","type":"string"},"rewardValue":{"description":"Reward value in cents.","type":"integer"},"seller":{"description":"Seller.","type":"string"},"sellerChain":{"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":{"description":"Seller.","type":"string"},"type":"array"},"sellingPrice":{"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.","type":"integer"},"skuName":{"description":"SKU name.","type":"string"},"tax":{"description":"Tax value in cents.","type":"integer"},"uniqueId":{"description":"Unique ID.","type":"string"},"unitMultiplier":{"description":"Unit multiplier.","type":"integer"}},"type":"object"},"type":"array"},"itemsOrdination":{"description":"Object containing information about the ordering of items within the `orderForm`.","properties":{"ascending":{"description":"Indicates whether the ordering is ascending.","type":"boolean"},"criteria":{"description":"Criteria adopted to order the items in the list.","type":"string"}},"type":"object"},"loggedIn":{"description":"Indicates whether the user is logged into the store.","type":"boolean"},"marketingData":{"description":"Object containing promotion data such as coupon tracking information and internal or external UTMs.","properties":{"coupon":{"default":"free-shipping","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.","type":"string"},"utmCampaign":{"default":"Black friday","description":"UTM campaign","type":"string"},"utmMedium":{"default":"CPC","description":"UTM medium.","type":"string"},"utmSource":{"default":"Facebook","description":"UTM source.","type":"string"},"utmiCampaign":{"default":"utmi_campaign-example","description":"utmi_campaign (internal utm).","nullable":true,"type":"string"},"utmiPage":{"default":"utmi_page-example","description":"utmi_page (internal utm).","nullable":true,"type":"string"},"utmiPart":{"default":"utmi_part-example","description":"utmi_part (internal utm).","nullable":true,"type":"string"}},"type":"object"},"messages":{"description":"Array containing an object for each message generated by our servers while processing the request.","items":{},"type":"array"},"openTextField":{"default":"open-text-example","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,"type":"string"},"orderFormId":{"description":"ID of the orderForm corresponding to a specific cart.","type":"string"},"paymentData":{"description":"Information on the order's payment.","properties":{"giftCards":{"description":"Gift card information, if it applies to the order.","items":{"properties":{"balance":{"description":"Gift card balance in cents.","type":"integer"},"id":{"description":"Gift card ID.","type":"string"},"inUse":{"description":"Indicates whether gift card is in use.","type":"boolean"},"isSpecialCard":{"description":"Indicates whether gift card is special.","type":"boolean"},"name":{"description":"Gift card name.","type":"string"},"redemptionCode":{"description":"Gift card redemption code.","type":"string"},"value":{"description":"Gift card value in cents.","type":"integer"}},"type":"object"},"type":"array"},"transactions":{"description":"Information on each transaction pertinent to the order.","items":{"properties":{"isActive":{"description":"Indicates whether transaction is active.","type":"boolean"},"merchantName":{"description":"Merchant name.","type":"string"},"payments":{"description":"Information on each payment.","items":{"properties":{"accountId":{"description":"Account ID.","type":"string"},"bin":{"description":"Bin.","type":"string"},"installments":{"description":"Number of installments.","type":"integer"},"paymentSystem":{"description":"Payment system.","type":"string"},"referenceValue":{"description":"Reference value for calculating interest rates, in case it applies. Displayed in cents.","type":"integer"},"value":{"description":"Value including interest, in case it applies. Displayed in cents.","type":"integer"}},"type":"object"},"type":"array"},"sharedTransaction":{"description":"Indicates whather transaction is shared.","type":"boolean"},"transactionId":{"description":"Transaction ID.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"profileProvider":{"description":"Profile provider.","type":"string"},"ratesAndBenefitsData":{"description":"Information on rates and benefits that apply to the order.","properties":{"rateAndBenefitsIdentifiers":{"description":"List with rates and benefits identifiers.","items":{"type":"string"},"type":"array"},"teaser":{"description":"List with rates and benefits teasers.","items":{"type":"string"},"type":"array"}},"type":"object"},"salesChannel":{"description":"Attribute created by the seller, in their VTEX store configuration.","type":"string"},"selectableGifts":{"description":"Array containing the data of the item selected as a gift.","items":{},"type":"array"},"sellers":{"description":"Information on each seller.","items":{"properties":{"id":{"description":"Seller ID.","type":"string"},"logo":{"description":"Seller logo.","nullable":true,"type":"string"},"name":{"description":"Seller name.","type":"string"}},"type":"object"},"type":"array"},"shippingData":{"description":"Shipping information pertinent to the order.","properties":{"address":{"description":"Address information.","properties":{"addressId":{"description":"Address ID.","type":"string"},"addressType":{"description":"Type of address. For example, `Residential` or `Pickup`.","type":"string"},"city":{"description":"City of the shipping address.","type":"string"},"complement":{"description":"Complement to the shipping address, in case it applies.","nullable":true,"type":"string"},"country":{"description":"Three letter ISO code of the country of the shipping address.","type":"string"},"geoCoordinates":{"description":"Array with two strings with geocoordinates, first latitude, then longitude.","items":{"type":"string"},"type":"array"},"isDisposable":{"description":"Indicates whether address is disposable.","type":"boolean"},"neighborhood":{"description":"Neighborhood of the shipping address.","type":"string"},"number":{"description":"Number of the building, house or apartment in the shipping address.","type":"string"},"postalCode":{"description":"Postal code.","type":"string"},"receiverName":{"description":"Name of the person who is going to receive the order.","type":"string"},"reference":{"description":"Complement that might help locate the shipping address more precisely in case of delivery.","nullable":true,"type":"string"},"state":{"description":"State of the shipping address.","type":"string"},"street":{"description":"Street of the shipping address.","type":"string"}},"type":"object"},"availableAddresses":{"description":"Array with information on the available addresses for the order.","items":{"properties":{"addressId":{"description":"Address ID.","type":"string"},"addressType":{"description":"Type of address. For example, `Residential` or `Pickup`.","type":"string"},"city":{"description":"City of the shipping address.","type":"string"},"complement":{"description":"Complement to the shipping address, in case it applies.","type":"string"},"country":{"description":"Three letter ISO code of the country of the shipping address.","type":"string"},"geoCoordinates":{"description":"Array with two strings with geocoordinates, first latitude, then longitude.","items":{"type":"string"},"type":"array"},"isDisposable":{"description":"Indicates whether address is disposable.","type":"boolean"},"neighborhood":{"description":"Neighborhood of the shipping address.","type":"string"},"number":{"description":"Number of the building, house or apartment in the shipping address.","type":"string"},"postalCode":{"description":"Postal code.","type":"string"},"receiverName":{"description":"Name of the person who is going to receive the order.","type":"string"},"reference":{"description":"Complement that might help locate the shipping address more precisely in case of delivery.","nullable":true,"type":"string"},"state":{"description":"State of the shipping address.","type":"string"},"street":{"description":"Street of the shipping address.","type":"string"}},"type":"object"},"type":"array"},"logisticsInfo":{"description":"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.","items":{"properties":{"addressId":{"description":"Address ID.","type":"string"},"deliveryChannels":{"description":"List of available delivery channels.","items":{"properties":{"id":{"description":"Delivery channel ID.","type":"string"}},"type":"object"},"type":"array"},"itemId":{"description":"Item ID.","type":"string"},"itemIndex":{"description":"Index corresponding to the position of the object in the `items` array.","type":"integer"},"selectedDeliveryChannel":{"description":"Delivery channel selected by the customer.","type":"string"},"selectedSla":{"description":"SLA selected by the customer.","type":"string"},"shipsTo":{"description":"List of countries that the item may be shipped to.","items":{"description":"Three letter country code.","type":"string"},"type":"array"},"slas":{"description":"Information on available SLAs.","items":{"properties":{"deliveryChannel":{"description":"Delivery channel.","type":"string"},"deliveryIds":{"description":"Information on each delivery ID.","items":{"properties":{"courierId":{"description":"Courier ID.","type":"string"},"courierName":{"description":"Courier name.","type":"string"},"dockId":{"description":"Warehouse ID.","type":"string"},"quantity":{"description":"Quantity.","type":"integer"},"warehouseId":{"description":"Warehouse ID.","type":"string"}},"type":"object"},"type":"array"},"id":{"description":"SLA ID.","type":"string"},"listPrice":{"description":"List price in cents.","type":"integer"},"lockTTL":{"description":"Estimate date of delivery.","type":"string"},"name":{"description":"SLA name.","type":"string"},"pickupDistance":{"description":"Pickup point distance.","type":"integer"},"pickupPointId":{"description":"Pickup point ID.","nullable":true,"type":"string"},"pickupStoreInfo":{"description":"Information on the pickup store.","properties":{"additionalInfo":{"description":"Additional information.","nullable":true,"type":"string"},"address":{"description":"Address information.","nullable":true,"properties":{"addressType":{"description":"Type of address. For example, `Residential` or `Pickup`.","type":"string"},"city":{"description":"City of the shipping address.","type":"string"},"complement":{"description":"Complement to the shipping address, in case it applies.","nullable":true,"type":"string"},"country":{"description":"Three letter ISO code of the country of the shipping address.","type":"string"},"geoCoordinates":{"description":"Array with two strings with geocoordinates, first latitude, then longitude.","items":{"type":"string"},"type":"array"},"neighborhood":{"description":"Neighborhood of the shipping address.","type":"string"},"number":{"description":"Number of the building, house or apartment in the shipping address.","type":"string"},"postalCode":{"description":"Postal code.","type":"string"},"reference":{"description":"Complement that might help locate the shipping address more precisely in case of delivery.","nullable":true,"type":"string"},"state":{"description":"State of the shipping address.","type":"string"},"street":{"description":"Street of the shipping address.","type":"string"}},"type":"object"},"dockId":{"description":"Corresponding dock ID.","nullable":true,"type":"string"},"friendlyName":{"description":"Friendly name.","nullable":true,"type":"string"},"isPickupStore":{"description":"Indicates whether it is the pickup store.","type":"boolean"}},"type":"object"},"polygonName":{"description":"Polygon name.","nullable":true,"type":"string"},"price":{"description":"Price in cents.","type":"integer"},"shippingEstimate":{"description":"Shipping estimate. For instance, \"three business days\" will be represented as `3bd`.","type":"string"},"shippingEstimateDate":{"description":"Shipping estimate date.","nullable":true,"type":"string"},"tax":{"description":"Tax in cents.","type":"integer"},"transitTime":{"description":"Transit time. For instance, \"three business days\" is represented as `3bd`.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"},"selectedAddresses":{"description":"Array with information on the selected addresses for the order.","items":{"properties":{"addressId":{"description":"Address ID.","type":"string"},"addressType":{"description":"Type of address. For example, `Residential` or `Pickup`.","type":"string"},"city":{"description":"City of the shipping address.","type":"string"},"complement":{"description":"Complement to the shipping address, in case it applies.","type":"string"},"country":{"description":"Three letter ISO code of the country of the shipping address.","type":"string"},"geoCoordinates":{"description":"Array with two strings with geocoordinates, first latitude, then longitude.","items":{"type":"string"},"type":"array"},"isDisposable":{"description":"Indicates whether address is disposable.","type":"boolean"},"neighborhood":{"description":"Neighborhood of the shipping address.","type":"string"},"number":{"description":"Number of the building, house or apartment in the shipping address.","type":"string"},"postalCode":{"description":"Postal code.","type":"string"},"receiverName":{"description":"Name of the person who is going to receive the order.","type":"string"},"reference":{"description":"Complement that might help locate the shipping address more precisely in case of delivery.","nullable":true,"type":"string"},"state":{"description":"State of the shipping address.","type":"string"},"street":{"description":"Street of the shipping address.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"storeId":{"description":"ID of the store.","nullable":true,"type":"string"},"storePreferencesData":{"description":"Object containing data from the store's configuration (stored in VTEX's License Manager).","type":"object"},"subscriptionData":{"description":"Subscription information.","nullable":true,"type":"object"},"totalizers":{"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":"array"},"userProfileId":{"description":"Unique ID associated with the customer profile.","type":"string"},"userType":{"description":"User type.","nullable":true,"type":"string"},"value":{"description":"Total value of the order without separating cents. For example, $24.99 is represented as `2499`.","type":"integer"}},"type":"object"}}},"description":"OK"}},"security":[],"summary":"Update cart items","tags":["Shopping cart"]}},"/api/checkout/pub/orderForm/{orderFormId}/items/{itemIndex}/price":{"put":{"deprecated":false,"description":"This request changes the price of an SKU in a cart. You can also perform type of bulk price change with the [Update cart items request](https://developers.vtex.com/vtex-rest-api/reference/shopping-cart#itemsupdate)\r\n\r\nThe [orderForm](https://developers.vtex.com/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/reference#getorderformconfiguration) endpoint. To make it active, use the [Update orderForm configuration](https://developers.vtex.com/reference#updateorderformconfiguration) endpoint, making the `allowManualPrice` field `true`.\n\r\n\r> Whenever you use this request to change the price of an item, all items in that cart with the same SKU are affected by this change. This applies even to items that share the SKU but have been separated into different objects in the `items` array due to customizations or attachments, for example.","operationId":"PriceChange","parameters":[{"description":"ID of the orderForm corresponding to the cart whose items will have the price changed.","in":"path","name":"orderFormId","required":true,"schema":{"default":"ede846222cd44046ba6c638442c3505a","type":"string"},"style":"simple"},{"description":"The index of the item in the cart. Each cart item is identified by an index, starting in 0.","in":"path","name":"itemIndex","required":true,"schema":{"type":"string"},"style":"simple"},{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"example":{"price":10000},"schema":{"$ref":"#/components/schemas/PriceChangeRequest"}}},"description":"","required":true},"responses":{"200":{"content":{"application/json":{"example":{"allowManualPrice":true,"canEditData":true,"checkedInPickupPointId":null,"clientPreferencesData":{"locale":"pt-BR","optinNewsLetter":null},"clientProfileData":null,"commercialConditionData":null,"customData":null,"giftRegistryData":null,"hooksData":null,"ignoreProfileData":false,"invoiceData":null,"isCheckedIn":false,"itemMetadata":{"items":[{"assemblyOptions":[],"detailUrl":"/racao-royal-canin-feline-urinary/p","ean":"123456789","id":"1","imageUrl":"http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000","name":"Ração Royal Canin Feline Urinary 500g","productId":"1","refId":"0001","seller":"1","skuName":"Ração Royal Canin Feline Urinary 500g"}]},"items":[{"additionalInfo":{"brandId":"2000000","brandName":"Royal Canin","offeringInfo":null,"offeringType":null,"offeringTypeId":null},"assemblies":[],"attachmentOfferings":[],"attachments":[],"availability":"available","bundleItems":[],"components":[],"detailUrl":"/racao-royal-canin-feline-urinary/p","ean":"123456789","id":"1","imageUrl":"http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000","isGift":false,"listPrice":30000,"manualPrice":10000,"manufacturerCode":null,"measurementUnit":"un","modalType":null,"name":"Ração Royal Canin Feline Urinary 500g","offerings":[],"parentAssemblyBinding":null,"parentItemIndex":null,"preSaleDate":null,"price":15000,"priceTags":[{"identifier":null,"isPercentual":false,"name":"DISCOUNT@MANUALPRICE","rawValue":-50,"value":-5000}],"priceValidUntil":"2025-04-15T13:52:27.987Z","productCategories":{"1":"Alimentação","10":"Ração Seca"},"productCategoryIds":"/1/10/","productId":"1","productRefId":"","quantity":1,"refId":"0001","rewardValue":0,"seller":"1","sellerChain":["1"],"sellingPrice":10000,"skuName":"Ração Royal Canin Feline Urinary 500g","tax":0,"uniqueId":"E0F2B7AF5CD74D668F1E27537206912C","unitMultiplier":1}],"itemsOrdination":null,"loggedIn":true,"marketingData":null,"messages":[],"openTextField":null,"orderFormId":"ede846222cd44046ba6c638442c3505a","paymentData":{"availableAccounts":[],"availableTokens":[],"giftCardMessages":[],"giftCards":[],"installmentOptions":[{"bin":null,"installments":[{"count":1,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":1,"hasInterestRate":false,"id":"LOJADOBRENO","interestRate":0,"total":10000,"value":10000}],"total":10000,"value":10000},{"count":2,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":2,"hasInterestRate":false,"id":"LOJADOBRENO","interestRate":0,"total":10000,"value":5000}],"total":10000,"value":5000}],"paymentGroupName":null,"paymentName":null,"paymentSystem":"2","value":10000}],"paymentSystems":[{"availablePayments":null,"description":null,"dueDate":"2025-04-15T13:52:27.987Z","groupName":"creditCardPaymentGroup","id":2,"isCustom":false,"name":"Visa","requiresAuthentication":false,"requiresDocument":false,"stringId":"2","template":"creditCardPaymentGroup-template","validator":{"cardCodeMask":"999","cardCodeRegex":"^[0-9]{3}$","mask":"9999 9999 9999 9999","regex":"^4[0-9]{15}$","useBillingAddress":true,"useCardHolderName":true,"useCvv":true,"useExpirationDate":true,"weights":[2,1,2,1,2]}}],"payments":[]},"ratesAndBenefitsData":{"rateAndBenefitsIdentifiers":[],"teaser":[]},"salesChannel":"1","selectableGifts":[],"sellers":[{"id":"1","logo":"","name":"lojadobreno"}],"shippingData":{"address":null,"availableAddresses":[],"logisticsInfo":[{"addressId":null,"deliveryChannels":[{"id":"pickup-in-point"},{"id":"delivery"}],"itemId":"1","itemIndex":0,"selectedDeliveryChannel":"delivery","selectedSla":null,"shipsTo":["BRA"],"slas":[]}],"pickupPoints":[],"selectedAddresses":[]},"storeId":null,"storePreferencesData":{"countryCode":"BRA","currencyCode":"BRL","currencyFormatInfo":{"currencyDecimalDigits":2,"currencyDecimalSeparator":",","currencyGroupSeparator":".","currencyGroupSize":3,"startsWithCurrencySymbol":true},"currencyLocale":1046,"currencySymbol":"R$","saveUserData":true,"timeZone":"E. South America Standard Time"},"subscriptionData":null,"totalizers":[{"id":"Items","name":"Total dos Itens","value":15000},{"id":"Discounts","name":"Total dos Descontos","value":-5000}],"userProfileId":null,"userType":null,"value":10000}}},"description":"OK"}},"summary":"Change price","tags":["Shopping cart"]}},"/api/checkout/pub/orderForm/{orderFormId}/messages/clear":{"post":{"deprecated":false,"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","parameters":[{"description":"ID of the orderForm corresponding to the cart whose messages you want to remove.","in":"path","name":"orderFormId","required":true,"schema":{"default":"ede846222cd44046ba6c638442c3505a","type":"string"},"style":"simple"},{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"default":{},"description":"This object must be empty.","properties":{},"title":"","type":"object"}}},"description":""},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"allowManualPrice":false,"availableAccounts":[],"availableAddresses":[{"addressId":"666c2e830bd9474ab6f6cc53fb6dd2d2","addressType":"residential","city":"Brasília","complement":"15º andar","country":"BRA","geoCoordinates":[-47.924747467041016,-15.832582473754883],"isDisposable":true,"neighborhood":"Copacabana","number":"123","postalCode":"70386000","receiverName":"Clark Kent","reference":null,"state":"DF","street":"Rua da minha casa"}],"canEditData":true,"clientPreferencesData":{"locale":"pt-BR","optinNewsLetter":false},"clientProfileData":{"corporateDocument":null,"corporateName":null,"corporatePhone":null,"customerClass":null,"document":"12345678900","documentType":"cpf","email":"clark.kent@example.com","firstName":"Clark","isCorporate":false,"lastName":"Kent","phone":"+5521998765432","profileCompleteOnLoading":false,"profileErrorOnLoading":null,"stateInscription":null,"tradeName":null},"commercialConditionData":null,"customData":null,"giftRegistryData":null,"hooksData":null,"ignoreProfileData":false,"invoiceData":null,"isCheckedIn":false,"itemMetadata":{"items":[{"assemblyOptions":[],"detailUrl":"/chopp-brahma-claro-30l/p","ean":null,"id":"2","imageUrl":"http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000","name":"Chopp Brahma Claro 30L","productId":"2","refId":"CBC30L","seller":"1","skuName":"Chopp Brahma Claro 30L"}]},"items":[{"additionalInfo":{"brandId":"2000000","brandName":"Brahma","dimension":null,"offeringInfo":null,"offeringType":null,"offeringTypeId":null},"assemblies":[],"attachmentOfferings":[],"attachments":[],"availability":"available","bundleItems":[],"components":[],"detailUrl":"/chopp-brahma-claro-30l/p","ean":null,"id":"2","imageUrl":"http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000","isGift":false,"listPrice":49900,"manualPrice":null,"manualPriceAppliedBy":null,"manufacturerCode":null,"measurementUnit":"un","modalType":null,"name":"Chopp Brahma Claro 30L","offerings":[],"parentAssemblyBinding":null,"parentItemIndex":null,"preSaleDate":null,"price":32890,"priceDefinition":{"calculatedSellingPrice":32890,"sellingPrices":[{"quantity":1,"value":32890}],"total":32890},"priceTags":[],"priceValidUntil":"2025-04-15T13:52:27.987Z","productCategories":{"1":"Bebidas"},"productCategoryIds":"/1/","productId":"2","productRefId":"","quantity":1,"refId":"CBC30L","rewardValue":0,"seller":"1","sellerChain":["1"],"sellingPrice":32890,"skuName":"Chopp Brahma Claro 30L","tax":0,"uniqueId":"9D6E447B3FF64CEDA33B17C01379C119","unitMultiplier":1}],"itemsOrdination":{"ascending":true,"criteria":"NAME"},"loggedIn":false,"marketingData":{"coupon":"free-shipping","utmCampaign":"Black friday","utmMedium":"CPC","utmSource":"app","utmiCampaign":null,"utmiPart":null,"utmipage":null},"messages":[],"openTextField":null,"orderFormId":"ede846222cd44046ba6c638442c3505a","paymentData":{"giftCards":[],"transactions":[{"isActive":true,"merchantName":"MYSTORE","payments":[],"sharedTransaction":false,"transactionId":"296D6D245C17437E823EB77E403FC88D"}]},"profileProvider":"VTEX","ratesAndBenefitsData":{"rateAndBenefitsIdentifiers":[],"teaser":[]},"salesChannel":"1","selectableGifts":[],"sellers":[{"id":"1","logo":"","name":"lojadobreno"}],"shippingData":{"address":{"addressId":"teste","addressType":"residential","city":"Brasília","complement":"15º andar","country":"BRA","geoCoordinates":[-47.924747467041016,-15.832582473754883],"isDisposable":true,"neighborhood":"Copacabana","number":"123","postalCode":"70386000","receiverName":"Clark Kent","reference":null,"state":"DF","street":"Rua da minha casa"},"availableAddresses":[{"addressId":"teste","addressType":"residential","city":"Rio de Janeiro","complement":"15º andar","country":"BRA","geoCoordinates":[-47.924747467041016,-15.832582473754883],"isDisposable":true,"neighborhood":"Copacabana","number":"123","postalCode":"12345000","receiverName":"Clark Kent","reference":null,"state":"RJ","street":"Rua da minha casa"}],"logisticsInfo":[{"addressId":"teste","deliveryChannels":[{"id":"delivery"},{"id":"pickup-in-point"}],"itemId":"2","itemIndex":0,"selectedDeliveryChannel":"delivery","selectedSla":"Normal","shipsTo":["BRA","COL","USA"],"slas":[{"availableDeliveryWindows":[],"deliveryChannel":"delivery","deliveryIds":[{"courierId":"1","courierName":"Transportadora","dockId":"1","kitItemDetails":[],"quantity":1,"warehouseId":11}],"deliveryWindow":null,"id":"Normal","listPrice":1500,"lockTTL":"10d","name":"Normal","pickupDistance":0,"pickupPointId":null,"pickupStoreInfo":{"additionalInfo":null,"address":null,"dockId":null,"friendlyName":null,"isPickupStore":false},"polygonName":null,"price":1500,"shippingEstimate":"3bd","shippingEstimateDate":null,"tax":0,"transitTime":"3bd"}]}],"pickupPoints":[],"selectedAddresses":[{"addressId":"teste","addressType":"residential","city":"Rio de Janeiro","complement":"15º andar","country":"BRA","geoCoordinates":[-47.924747467041016,-15.832582473754883],"isDisposable":true,"neighborhood":"Copacabana","number":"123","postalCode":"12345000","receiverName":"Clark Kent","reference":null,"state":"RJ","street":"Rua da minha casa"}]},"storeId":null,"storePreferencesData":{},"subscriptionData":null,"totalizers":[{"id":"Items","name":"Total Items","value":32890}],"userProfileId":"fb542e51-5488-4c34-8d17-ed8fcf597a94","userType":null,"value":34390}}},"schema":{"properties":{"allowManualPrice":{"description":"Permission to modify item price manually.","type":"boolean"},"availableAccounts":{"description":"Available accounts.","items":{"type":"string"},"type":"array"},"availableAddresses":{"description":"Information on each available address.","items":{"properties":{"addressId":{"description":"Address ID.","type":"string"},"addressType":{"description":"Address type.","type":"string"},"city":{"description":"City of the address.","type":"string"},"complement":{"description":"Complement to the address.","nullable":true,"type":"string"},"country":{"description":"Country of the address. ISO three-letter code.","type":"string"},"geoCoordinates":{"description":"Array containing two floats with geocoordinates, first longitude, then latitude.","items":{"type":"number"},"type":"array"},"isDisposable":{"description":"Indicates whether address is disposable.","type":"boolean"},"neighborhood":{"description":"Neighborhood of the address.","type":"string"},"number":{"description":"Number of the address.","type":"string"},"receiverName":{"description":"Name of the receiver.","type":"string"},"reference":{"description":"Reference that may help in the location of the address.","nullable":true,"type":"string"},"state":{"description":"State of the address.","type":"string"},"street":{"description":"Street of the address.","type":"string"}},"type":"object"},"type":"array"},"canEditData":{"description":"Data can be edited.","type":"boolean"},"clientPreferencesData":{"description":"Object containing preferences from the client who placed the order.","properties":{"locale":{"description":"Client's locale. Examples: `pt-BR` and `en-US`.","type":"string"},"optinNewsLetter":{"default":false,"description":"`true` if the client opted to receive newsletter from the store.","type":"boolean"}},"type":"object"},"clientProfileData":{"description":"Customer's profile information.","properties":{"corporateDocument":{"description":"Corporate document, if the customer is a legal entity.","nullable":true,"type":"string"},"corporateName":{"description":"Company name, if the customer is a legal entity.","nullable":true,"type":"string"},"corporatePhone":{"description":"Corporate phone number, if the customer is a legal entity.","nullable":true,"type":"string"},"customerClass":{"description":"Customer class.","nullable":true,"type":"string"},"document":{"description":"Document informed by the customer.","type":"string"},"documentType":{"description":"Type of the document informed by the customer.","type":"string"},"email":{"description":"Email address.","type":"string"},"firstName":{"description":"First name.","type":"string"},"isCorporate":{"description":"Indicates whether the customer is a legal entity.","type":"boolean"},"lastName":{"description":"Last name.","type":"string"},"phone":{"description":"Phone number.","type":"string"},"profileCompleteOnLoading":{"description":"Indicates whether profile is complete on loading.","type":"boolean"},"profileErrorOnLoading":{"description":"Indicates whether profile presents error on loading.","nullable":true,"type":"boolean"},"stateInscription":{"description":"State inscription, if the customer is a legal entity.","nullable":true,"type":"string"},"tradeName":{"description":"Trade name, if the customer is a legal entity.","nullable":true,"type":"string"}},"type":"object"},"commercialConditionData":{"description":"Object containing commercial condition information.","nullable":true,"type":"object"},"customData":{"description":"Customer additional information.","nullable":true,"type":"object"},"giftRegistryData":{"description":"Gift registry list information.","nullable":true,"type":"object"},"hooksData":{"description":"Hooks information.","nullable":true,"type":"object"},"ignoreProfileData":{"description":"Ignore customer profile data.","type":"boolean"},"invoiceData":{"description":"Object containing information pertinent to the order's invoice.","nullable":true,"type":"object"},"isCheckedIn":{"description":"Indicates whether order is checked in.","type":"boolean"},"itemMetadata":{"description":"Item metadata.","properties":{"items":{"description":"List of objects containing metadata on each item in the order.","items":{"properties":{"detailUrl":{"description":"Detail URL.","type":"string"},"ean":{"description":"European Article Number.","nullable":true,"type":"string"},"id":{"description":"Item ID.","type":"string"},"imageUrl":{"description":"Image URL.","type":"string"},"name":{"description":"Product name.","type":"string"},"productId":{"description":"Product ID.","type":"string"},"refId":{"description":"Ref ID.","type":"string"},"seller":{"description":"Seller.","type":"string"},"skuName":{"description":"SKU name.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"items":{"description":"Information on each item in the order.","items":{"properties":{"additionalInfo":{"description":"Additional information.","properties":{"brandId":{"description":"Brand ID.","type":"string"},"brandName":{"description":"Brand name.","type":"string"},"dimension":{"description":"Dimension.","nullable":true,"type":"string"},"offeringInfo":{"description":"Offering information.","nullable":true,"type":"string"},"offeringType":{"description":"Offering type.","nullable":true,"type":"string"},"offeringTypeId":{"description":"Offering type ID.","nullable":true,"type":"string"}},"type":"object"},"attachments":{"description":"Array containing information on attachments.","items":{"type":"string"},"type":"array"},"availability":{"description":"Availability.","type":"string"},"bundleItems":{"description":"Information on services sold along with the SKU. Example: a gift package.","items":{"properties":{"id":{"description":"Service identifier.","type":"integer"},"name":{"description":"Service name.","type":"string"},"price":{"description":"Service price in cents.","type":"integer"},"type":{"description":"Service type.","type":"string"}},"type":"object"},"type":"array"},"detailUrl":{"description":"Detail URL.","type":"string"},"ean":{"description":"European Article Number.","nullable":true,"type":"string"},"id":{"description":"ID of the item.","type":"string"},"imageUrl":{"description":"Image URL.","type":"string"},"isGift":{"description":"Indicates whether item is a gift.","type":"boolean"},"listPrice":{"description":"List price in cents.","type":"integer"},"manualPrice":{"description":"Manual price in cents.","nullable":true,"type":"integer"},"manualPriceAppliedBy":{"description":"User that applied the manual price, if that is the case.","nullable":true,"type":"string"},"manufacturerCode":{"description":"Manufacturer code.","nullable":true,"type":"string"},"measurementUnit":{"description":"Measurement unit.","type":"string"},"modalType":{"description":"Modal type.","nullable":true,"type":"string"},"name":{"description":"Product name.","type":"string"},"parentAssemblyBinding":{"description":"Parent assembly binding.","nullable":true,"type":"string"},"parentItemIndex":{"description":"Parent item index.","nullable":true,"type":"integer"},"preSaleDate":{"description":"Presale date.","nullable":true,"type":"string"},"price":{"description":"Price in cents.","type":"integer"},"priceDefinition":{"description":"Price information for all units of a specific item.","properties":{"calculatedSellingPrice":{"description":"Item's calculated unitary selling price in cents.","type":"integer"},"sellingPrices":{"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":{"properties":{"quantity":{"description":"Rounding quantity, meaning how many items are rounded to this value.","type":"integer"},"value":{"description":"Value in cents for that specific rounding.","type":"integer"}},"type":"object"},"type":"array"},"total":{"description":"Total value for all units of the item in cents.","type":"integer"}},"type":"object"},"priceTags":{"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":{"properties":{"identifier":{"description":"Price tag identifier.","type":"string"},"isPercentual":{"description":"Indicates whether price tag value is applied through a percentage.","type":"boolean"},"name":{"description":"Price tag name.","type":"string"},"rawValue":{"description":"Price tag raw value.","type":"integer"},"value":{"description":"Price tag value.","type":"integer"}},"type":"object"},"type":"array"},"priceValidUntil":{"description":"Price expiration date and time.","type":"string"},"productCategories":{"description":"Object, where each field is an ID from `productCategoryIds`.","properties":{"{ID}":{"description":"Product category corresponding to the ID in the field key.","type":"string"}},"type":"object"},"productCategoryIds":{"description":"Product category IDs.","type":"string"},"productId":{"description":"Product ID.","type":"string"},"productRefId":{"description":"Product Ref ID.","type":"string"},"quantity":{"description":"Quantity.","type":"integer"},"refId":{"description":"Ref ID.","type":"string"},"rewardValue":{"description":"Reward value in cents.","type":"integer"},"seller":{"description":"Seller.","type":"string"},"sellerChain":{"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":{"description":"Seller.","type":"string"},"type":"array"},"sellingPrice":{"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.","type":"integer"},"skuName":{"description":"SKU name.","type":"string"},"tax":{"description":"Tax value in cents.","type":"integer"},"uniqueId":{"description":"Unique ID.","type":"string"},"unitMultiplier":{"description":"Unit multiplier.","type":"integer"}},"type":"object"},"type":"array"},"itemsOrdination":{"description":"Object containing information about the ordering of items within the orderForm.","properties":{"ascending":{"description":"Indicates whether the ordering is ascending.","type":"boolean"},"criteria":{"description":"Criteria adopted to order the items in the list.","type":"string"}},"type":"object"},"loggedIn":{"description":"Indicates whether the user is logged into the store.","type":"boolean"},"marketingData":{"description":"Object containing promotion data such as coupon tracking information and internal or external UTMs.","properties":{"coupon":{"default":"free-shipping","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.","type":"string"},"utmCampaign":{"default":"Black friday","description":"UTM campaign","type":"string"},"utmMedium":{"default":"CPC","description":"UTM medium.","type":"string"},"utmSource":{"default":"Facebook","description":"UTM source.","type":"string"},"utmiCampaign":{"default":"utmi_campaign-example","description":"utmi_campaign (internal utm).","nullable":true,"type":"string"},"utmiPage":{"default":"utmi_page-example","description":"utmi_page (internal utm)","nullable":true,"type":"string"},"utmiPart":{"default":"utmi_part-example","description":"utmi_part (internal utm).","nullable":true,"type":"string"}},"type":"object"},"messages":{"description":"Array containing an object for each message generated by our servers while processing the request.","items":{},"type":"array"},"openTextField":{"default":"open-text-example","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,"type":"string"},"orderFormId":{"description":"ID of the orderForm corresponding to a specific cart.","type":"string"},"paymentData":{"description":"Information on the order's payment.","properties":{"giftCards":{"description":"Gift card information, if it applies to the order.","items":{"properties":{"balance":{"description":"Gift card balance in cents.","type":"integer"},"id":{"description":"Gift card ID.","type":"string"},"inUse":{"description":"Indicates whether gift card is in use.","type":"boolean"},"isSpecialCard":{"description":"Indicates whether gift card is special.","type":"boolean"},"name":{"description":"Gift card name.","type":"string"},"redemptionCode":{"description":"Gift card redemption code.","type":"string"},"value":{"description":"Gift card value in cents.","type":"integer"}},"type":"object"},"type":"array"},"transactions":{"description":"Information on each transaction pertinent to the order.","items":{"properties":{"isActive":{"description":"Indicates whether transaction is active.","type":"boolean"},"merchantName":{"description":"Merchant name.","type":"string"},"payments":{"description":"Information on each payment.","items":{"properties":{"accountId":{"description":"Account ID.","type":"string"},"bin":{"description":"Bin.","type":"string"},"installments":{"description":"Number of installments.","type":"integer"},"paymentSystem":{"description":"Payment system.","type":"string"},"referenceValue":{"description":"Reference value for calculating interest rates, in case it applies. Displayed in cents.","type":"integer"},"value":{"description":"Value including interest, in case it applies. Displayed in cents.","type":"integer"}},"type":"object"},"type":"array"},"sharedTransaction":{"description":"Indicates whather transaction is shared.","type":"boolean"},"transactionId":{"description":"Transaction ID.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"profileProvider":{"description":"Profile provider.","type":"string"},"ratesAndBenefitsData":{"description":"Information on rates and benefits that apply to the order.","properties":{"rateAndBenefitsIdentifiers":{"description":"List with rates and benefits identifiers.","items":{"type":"string"},"type":"array"},"teaser":{"description":"List with rates and benefits teasers.","items":{"type":"string"},"type":"array"}},"type":"object"},"salesChannel":{"description":"Attribute created by the seller, in their VTEX store configuration.","type":"string"},"selectableGifts":{"description":"Array containing the data of the item selected as a gift.","items":{},"type":"array"},"sellers":{"description":"Information on each seller.","items":{"properties":{"id":{"description":"Seller ID.","type":"string"},"logo":{"description":"Seller logo.","nullable":true,"type":"string"},"name":{"description":"Seller name.","type":"string"}},"type":"object"},"type":"array"},"shippingData":{"description":"Shipping information pertinent to the order.","properties":{"address":{"description":"Address information.","properties":{"addressId":{"description":"Address ID.","type":"string"},"addressType":{"description":"Type of address. For example, `Residential` or `Pickup`.","type":"string"},"city":{"description":"City of the shipping address.","type":"string"},"complement":{"description":"Complement to the shipping address, in case it applies.","nullable":true,"type":"string"},"country":{"description":"Three letter ISO code of the country of the shipping address.","type":"string"},"geoCoordinates":{"description":"Array containing two floats with geocoordinates, first longitude, then latitude.","items":{"type":"number"},"type":"array"},"isDisposable":{"description":"Indicates whether address is disposable.","type":"boolean"},"neighborhood":{"description":"Neighborhood of the shipping address.","type":"string"},"number":{"description":"Number of the building, house or apartment in the shipping address.","type":"string"},"postalCode":{"description":"Postal code.","type":"string"},"receiverName":{"description":"Name of the person who is going to receive the order.","type":"string"},"reference":{"description":"Complement that might help locate the shipping address more precisely in case of delivery.","nullable":true,"type":"string"},"state":{"description":"State of the shipping address.","type":"string"},"street":{"description":"Street of the shipping address.","type":"string"}},"type":"object"},"availableAddresses":{"description":"Array with information on the available addresses for the order.","items":{"properties":{"addressId":{"description":"Address ID.","type":"string"},"addressType":{"description":"Type of address. For example, `Residential` or `Pickup`.","type":"string"},"city":{"description":"City of the shipping address.","type":"string"},"complement":{"description":"Complement to the shipping address, in case it applies.","type":"string"},"country":{"description":"Three letter ISO code of the country of the shipping address.","type":"string"},"geoCoordinates":{"description":"Array containing two floats with geocoordinates, first longitude, then latitude.","items":{"type":"number"},"type":"array"},"isDisposable":{"description":"Indicates whether address is disposable.","type":"boolean"},"neighborhood":{"description":"Neighborhood of the shipping address.","type":"string"},"number":{"description":"Number of the building, house or apartment in the shipping address.","type":"string"},"postalCode":{"description":"Postal code.","type":"string"},"receiverName":{"description":"Name of the person who is going to receive the order.","type":"string"},"reference":{"description":"Complement that might help locate the shipping address more precisely in case of delivery.","nullable":true,"type":"string"},"state":{"description":"State of the shipping address.","type":"string"},"street":{"description":"Street of the shipping address.","type":"string"}},"type":"object"},"type":"array"},"logisticsInfo":{"description":"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.","items":{"properties":{"addressId":{"description":"Address ID.","type":"string"},"deliveryChannels":{"description":"List of available delivery channels.","items":{"properties":{"id":{"description":"Delivery channel ID.","type":"string"}},"type":"object"},"type":"array"},"itemId":{"description":"Item ID.","type":"string"},"itemIndex":{"description":"Index corresponding to the position of the object in the `items` array.","type":"integer"},"selectedDeliveryChannel":{"description":"Delivery channel selected by the customer.","type":"string"},"selectedSla":{"description":"SLA selected by the customer.","type":"string"},"shipsTo":{"description":"List of countries that the item may be shipped to.","items":{"description":"Three letter country code.","type":"string"},"type":"array"},"slas":{"description":"Information on available SLAs.","items":{"properties":{"deliveryChannel":{"description":"Delivery channel.","type":"string"},"deliveryIds":{"description":"Information on each delivery ID.","items":{"properties":{"courierId":{"description":"Courier ID.","type":"string"},"courierName":{"description":"Courier name.","type":"string"},"dockId":{"description":"Warehouse ID.","type":"string"},"quantity":{"description":"Quantity.","type":"integer"},"warehouseId":{"description":"Warehouse ID.","type":"string"}},"type":"object"},"type":"array"},"id":{"description":"SLA ID.","type":"string"},"listPrice":{"description":"List price in cents.","type":"integer"},"lockTTL":{"description":"Estimate date of delivery.","type":"string"},"name":{"description":"SLA name.","type":"string"},"pickupDistance":{"description":"Pickup point distance.","type":"integer"},"pickupPointId":{"description":"Pickup point ID.","nullable":true,"type":"string"},"pickupStoreInfo":{"description":"Information on the pickup store.","properties":{"additionalInfo":{"description":"Additional information.","nullable":true,"type":"string"},"address":{"description":"Address information.","nullable":true,"properties":{"addressType":{"description":"Type of address. For example, `Residential` or `Pickup`.","type":"string"},"city":{"description":"City of the shipping address.","type":"string"},"complement":{"description":"Complement to the shipping address, in case it applies.","nullable":true,"type":"string"},"country":{"description":"Three letter ISO code of the country of the shipping address.","type":"string"},"geoCoordinates":{"description":"Array containing two floats with geocoordinates, first longitude, then latitude.","items":{"type":"number"},"type":"array"},"neighborhood":{"description":"Neighborhood of the shipping address.","type":"string"},"number":{"description":"Number of the building, house or apartment in the shipping address.","type":"string"},"postalCode":{"description":"Postal code.","type":"string"},"reference":{"description":"Complement that might help locate the shipping address more precisely in case of delivery.","nullable":true,"type":"string"},"state":{"description":"State of the shipping address.","type":"string"},"street":{"description":"Street of the shipping address.","type":"string"}},"type":"object"},"dockId":{"description":"Corresponding dock ID.","nullable":true,"type":"string"},"friendlyName":{"description":"Friendly name.","nullable":true,"type":"string"},"isPickupStore":{"description":"Indicates whether it is the pickup store.","type":"boolean"}},"type":"object"},"polygonName":{"description":"Polygon name.","nullable":true,"type":"string"},"price":{"description":"Price in cents.","type":"integer"},"shippingEstimate":{"description":"Shipping estimate. For instance, Three business days will be represented `3bd`.","type":"string"},"shippingEstimateDate":{"description":"Shipping estimate date.","nullable":true,"type":"string"},"tax":{"description":"Tax in cents.","type":"integer"},"transitTime":{"description":"Transit time. For instance, \"three business days\" is represented `3bd`.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"},"selectedAddresses":{"description":"Array with information on the selected addresses for the order.","items":{"properties":{"addressId":{"description":"Address ID.","type":"string"},"addressType":{"description":"Type of address. For example, `Residential` or `Pickup`.","type":"string"},"city":{"description":"City of the shipping address.","type":"string"},"complement":{"description":"Complement to the shipping address, in case it applies.","type":"string"},"country":{"description":"Three letter ISO code of the country of the shipping address.","type":"string"},"geoCoordinates":{"description":"Array containing two floats with geocoordinates, first longitude, then latitude.","items":{"type":"number"},"type":"array"},"isDisposable":{"description":"Indicates whether address is disposable.","type":"boolean"},"neighborhood":{"description":"Neighborhood of the shipping address.","type":"string"},"number":{"description":"Number of the building, house or apartment in the shipping address.","type":"string"},"postalCode":{"description":"Postal code.","type":"string"},"receiverName":{"description":"Name of the person who is going to receive the order.","type":"string"},"reference":{"description":"Complement that might help locate the shipping address more precisely in case of delivery.","nullable":true,"type":"string"},"state":{"description":"State of the shipping address.","type":"string"},"street":{"description":"Street of the shipping address.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"storeId":{"description":"ID of the store.","nullable":true,"type":"string"},"storePreferencesData":{"description":"Object containing data from the store's configuration (stored in VTEX's License Manager).","type":"object"},"subscriptionData":{"description":"Subscription information.","nullable":true,"type":"object"},"totalizers":{"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":"array"},"userProfileId":{"description":"Unique ID associated with the customer profile.","type":"string"},"userType":{"description":"User type.","nullable":true,"type":"string"},"value":{"description":"Total value of the order without separating cents. For example, $24.99 is represented `2499`.","type":"integer"}},"type":"object"}}},"description":"OK","headers":{}}},"security":[],"summary":"Clear orderForm messages","tags":["Configuration"]}},"/api/checkout/pub/orderForm/{orderFormId}/profile":{"patch":{"deprecated":false,"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","parameters":[{"description":"ID of the orderForm corresponding to the cart whose items will have the price changed.","in":"path","name":"orderFormId","required":true,"schema":{"default":"ede846222cd44046ba6c638442c3505a","type":"string"},"style":"simple"},{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"example":{"price":10000},"schema":{"properties":{"ignoreProfileData":{"default":false,"description":"Indicates whether profile data should be ignored.","type":"boolean"}},"type":"object"}}},"description":"","required":true},"responses":{"200":{"content":{"application/json":{"example":{"allowManualPrice":false,"canEditData":true,"checkedInPickupPointId":null,"clientPreferencesData":{"locale":"pt-BR","optinNewsLetter":null},"clientProfileData":{"corporateDocument":null,"corporateName":null,"corporatePhone":null,"customerClass":null,"document":null,"documentType":null,"email":null,"firstName":null,"isCorporate":false,"lastName":null,"phone":null,"profileCompleteOnLoading":null,"profileErrorOnLoading":null,"stateInscription":null,"tradeName":null},"commercialConditionData":null,"customData":null,"giftRegistryData":null,"hooksData":null,"ignoreProfileData":true,"invoiceData":null,"isCheckedIn":false,"itemMetadata":null,"items":[],"itemsOrdination":null,"loggedIn":true,"marketingData":null,"messages":[],"openTextField":null,"orderFormId":"68b287ae65534704b1a1e42e47c82abc","paymentData":{"availableAccounts":[],"availableTokens":[],"giftCardMessages":[],"giftCards":[],"installmentOptions":[],"paymentSystems":[],"payments":[],"updateStatus":"updated"},"ratesAndBenefitsData":null,"salesChannel":"1","selectableGifts":[],"sellers":[],"shippingData":null,"storeId":null,"storePreferencesData":{"countryCode":"BRA","currencyCode":"BRL","currencyFormatInfo":{"currencyDecimalDigits":2,"currencyDecimalSeparator":",","currencyGroupSeparator":".","currencyGroupSize":3,"startsWithCurrencySymbol":true},"currencyLocale":1046,"currencySymbol":"R$","saveUserData":true,"timeZone":"E. South America Standard Time"},"subscriptionData":null,"totalizers":[],"userProfileId":null,"userType":null,"value":0}}},"description":"","headers":{}}},"security":[],"summary":"Ignore profile data","tags":["Shopping cart"]}},"/api/checkout/pub/orderForm/{orderFormId}/transaction":{"post":{"deprecated":false,"description":"This endpoint places an order from an existing `orderForm` object, meaning an existing cart.\n\r\n\rAfter the creation of an order with this request, you have five minutes to send payment information and then request payment processing.","operationId":"PlaceOrderFromExistingOrderForm","parameters":[{"description":"ID of the `orderForm` corresponding to the cart from which to place the order.","in":"path","name":"orderFormId","required":true,"schema":{"default":"ede846222cd44046ba6c638442c3505a","type":"string"},"style":"simple"},{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"interestValue":{"default":0,"description":"Interest rate to be used in case it applies.","type":"integer"},"optinNewsLetter":{"default":false,"description":"True if the shopper opted to receive the newsletter.","title":"optinNewsLetter","type":"boolean"},"referenceId":{"default":"41a22925298a4ddca95318131a25b000","description":"ID of the `orderForm` corresponding to the cart from which to place the order. This is the same as the `orderFormId` parameter.","title":"referenceId","type":"string"},"referenceValue":{"default":6800,"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`.","type":"integer"},"savePersonalData":{"default":false,"description":"`true` if the shopper's data provided during checkout should be saved for future reference.","title":"savePersonalData","type":"boolean"},"value":{"default":6800,"description":"Total value of the order without separating cents. For example, $24.99 is represented `2499`.","type":"integer"}},"required":["referenceId","value","referenceValue","interestValue"],"title":"","type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"orderForm":null,"orders":[{"changeData":null,"clientPreferencesData":{"attachmentId":"clientPreferencesData","locale":"pt-BR","optinNewsLetter":true},"clientProfileData":{"attachmentId":"clientProfileData","corporateDocument":null,"corporateName":null,"corporatePhone":null,"document":"71279846675","documentType":"cpf","email":"marcelo@vtex.com.br","firstName":"Marcelo","isCorporate":false,"lastName":"Couto","phone":"1234567890","profileCompleteOnLoading":null,"profileErrorOnLoading":null,"stateInscription":null,"tradeName":null},"creationDate":"2025-04-15T13:52:27.988Z","followUpEmail":"f1e7309d88dd4633825ce183d52a50a6@ct.vtex.com.br","giftRegistryData":null,"hostName":"ambienteqa","isCheckedIn":false,"isCompleted":false,"items":[{"additionalInfo":{"brandId":"1","brandName":"Marca Um","offeringInfo":null,"offeringType":null,"offeringTypeId":null},"attachmentOfferings":[],"attachments":[],"availability":"available","bundleItems":[],"components":[],"defaultPicker":null,"detailUrl":"/produto-selecao-sku-lista/p","ean":null,"handlerSequence":0,"handling":false,"id":"2000016","imageUrl":"http://store.vteximg.com.br/arquivos/ids/168463-55-55/imagem-modo-lista.png","isGift":false,"itemAttachment":{"content":{},"name":null},"listPrice":15000,"manualPrice":null,"measurementUnit":"un","modalType":null,"name":"Produto Seleção SKU - Lista 35 - Preto","offerings":[],"preSaleDate":null,"price":15000,"priceTags":[],"priceValidUntil":"2025-04-15T13:52:27.988Z","productCategories":{"12":"Departamento 5","28":"Categoria 5-3"},"productCategoryIds":"/12/28/","productId":"2000002","quantity":1,"refId":"35-Preto","rewardValue":1,"seller":"1","sellingPrice":15000,"skuName":"35 - Preto","tax":0,"uniqueId":"0F93E9C4926A4CD97FDD4C2599BDF9DB","unitMultiplier":1}],"lastChange":"2025-04-15T13:52:27.988Z","marketingData":null,"merchantName":null,"openTextField":{"attachmentId":"openTextField","value":null},"orderGroup":"v976778amgh","orderId":"v976778amgh-01","paymentData":{"attachmentId":"paymentData","giftCards":[],"merchantName":"STORE","payments":[],"transactionId":"62FEDE228E2144649CF67812C4E5DD87","transactions":[{"isActive":true,"merchantName":"STORE","payments":[],"transactionId":"62FEDE228E2144649CF67812C4E5DD87"}]},"ratesAndBenefitsData":{"attachmentId":"ratesAndBenefitsData","rateAndBenefitsIdentifiers":[],"teaser":[]},"roundingError":0,"salesChannel":"1","sellerOrderId":"00-v976778amgh-01","sellers":[{"id":"1","logo":"","name":"Store"}],"shippingData":{"address":{"addressId":"49ad09e5fba8434a8ff1e0faa4b60ceb","addressType":"residential","city":"Rio de Janeiro","complement":"15º andar","country":"BRA","geoCoordinates":[],"neighborhood":"Copacabana","number":"123","postalCode":"28050987","receiverName":"Marcelo","reference":null,"state":"RJ","street":"Rua da minha casa"},"attachmentId":"shippingData","availableAddresses":[{"addressId":"49ad09e5fba8434a8ff1e0faa4b60ceb","addressType":"residential","city":"Rio de Janeiro","complement":"15º andar","country":"BRA","geoCoordinates":[],"neighborhood":"Copacabana","number":"123","postalCode":"28050642","receiverName":"Marcelo","reference":null,"state":"RJ","street":"Rua da minha casa"}],"logisticsInfo":[{"itemId":"2000016","itemIndex":0,"selectedSla":"Normal","shipsTo":["BRA"],"slas":[{"availableDeliveryWindows":[{"endDateUtc":"2025-04-15T13:52:27.988Z","lisPrice":0,"price":0,"startDateUtc":"2025-04-15T13:52:27.988Z","tax":0},{"endDateUtc":"2025-04-15T13:52:27.988Z","lisPrice":0,"price":0,"startDateUtc":"2025-04-15T13:52:27.988Z","tax":0}],"deliveryIds":[{"courierId":"1de4790","courierName":"N2_2","dockId":"N2","quantity":1,"warehouseId":11}],"deliveryWindow":null,"id":"n2_2","listPrice":650,"lockTTL":"7d","name":"n2_2","pickupStoreInfo":{"additionalInfo":null,"address":null,"dockId":null,"friendlyName":null,"isPickupStore":false},"price":650,"shippingEstimate":"6bd","shippingEstimateDate":null,"tax":0},{"availableDeliveryWindows":[],"deliveryIds":[{"courierId":"2p1t","courierName":"Post_Test_2","dockId":"N2","quantity":1,"warehouseId":11}],"deliveryWindow":null,"id":"Normal","listPrice":650,"lockTTL":"7d","name":"Normal","pickupStoreInfo":{"additionalInfo":null,"address":null,"dockId":null,"friendlyName":null,"isPickupStore":false},"price":650,"shippingEstimate":"6bd","shippingEstimateDate":null,"tax":0},{"availableDeliveryWindows":[],"deliveryIds":[{"courierId":"1p1t","courierName":"Post_Teste","dockId":"N2","quantity":1,"warehouseId":11}],"deliveryWindow":null,"id":"P_T","listPrice":1462,"lockTTL":"7d","name":"P_T","pickupStoreInfo":{"additionalInfo":null,"address":null,"dockId":null,"friendlyName":null,"isPickupStore":false},"price":1462,"shippingEstimate":"6bd","shippingEstimateDate":null,"tax":0},{"availableDeliveryWindows":[],"deliveryIds":[{"courierId":"2B9C2C7D-7A76-485D-94EF-701D041E448C","courierName":"Leve 30kg (De: 10000-000 Até: 25999-999) ","dockId":111,"quantity":1,"warehouseId":11}],"deliveryWindow":null,"id":"Econômica","listPrice":2265,"lockTTL":"7d","name":"Econômica","pickupStoreInfo":{"additionalInfo":null,"address":null,"dockId":null,"friendlyName":null,"isPickupStore":false},"price":2265,"shippingEstimate":"20bd","shippingEstimateDate":null,"tax":0}]}]},"state":"order-created","storeId":null,"storePreferencesData":{"checkToSavePersonDataByDefault":false,"countryCode":"BRA","currencyCode":"BRL","currencyFormatInfo":{"currencyDecimalDigits":2,"currencyDecimalSeparator":",","currencyGroupSeparator":".","currencyGroupSize":3,"startsWithCurrencySymbol":true},"currencyLocale":1046,"currencySymbol":"R$","templateOptions":{"toggleCorporate":false},"timeZone":"E. South America Standard Time"},"timeZoneCreationDate":"2025-04-15T13:52:27.988Z","timeZoneLastChange":"2025-04-15T13:52:27.988Z","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}],"userType":"","value":15650}],"transactionData":{"gatewayCallbackTemplatePath":"/checkout/gatewayCallback/v976778amgh/{messageCode}","merchantTransactions":[{"id":"STORE","merchantName":"STORE","payments":[{"accountId":null,"bin":null,"giftCardId":null,"giftCardProvider":null,"giftCardRedemptionCode":null,"paymentSystem":"6","referenceValue":15650,"value":15650}],"transactionId":"62FEDE228E2144649CF67812C4E5ER79"}],"receiverUri":"https://store.vtexpayments.com.br/split/v976778amgh/payments"}},"schema":{"type":"object"}}},"description":"","headers":{}}},"security":[],"summary":"Place order from an existing cart","tags":["Order placement"]}},"/api/checkout/pub/orderForms/simulation":{"post":{"deprecated":false,"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 ID of the **Seller**.\r\n\r\nIt sends back all information about the cart, such as the selling price of each item, rates and benefits data, payment and logistics info.\r\n\r\nThis is useful whenever you need to know the 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**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.","operationId":"CartSimulation","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"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`.","in":"query","name":"RnbBehavior","required":false,"schema":{"default":0,"type":"integer"},"style":"form"},{"description":"Trade Policy (Sales Channel) identification.","in":"query","name":"sc","required":false,"schema":{"example":1,"type":"integer"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"country":{"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","type":"string"},"geoCoordinates":{"default":[-47.924747467041016,-15.832582473754883],"description":"Array containing two floats with geocoordinates, first longitude, then latitude.","items":{"example":-47.924747467041016,"type":"number"},"type":"array"},"items":{"description":"Array containing information about the SKUs inside the cart to be simulated.","items":{"properties":{"id":{"description":"The SKU ID.","example":"1","type":"string"},"quantity":{"description":"The quantity of items of this specific SKU in the cart to be simulated.","example":1,"format":"int32","type":"integer"},"seller":{"description":"The ID of the seller responsible for this SKU. This ID can be found in your VTEX Admin.","example":"1","type":"string"}},"type":"object"},"type":"array"},"postalCode":{"description":"Postal code.","example":"12345-000","type":"string"}},"required":["id","quantity","seller"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"country":"BRA","geoCoordinates":[-47.924747467041016,-15.832582473754883],"itemMetadata":{"items":[{"assemblyOptions":[{"composition":null,"id":"T-Shirt Customization","inputValues":{"T-Shirt Name":{"domain":["[]"],"maximumNumberOfCharacters":2}},"name":"T-Shirt Customization","required":false}],"id":"1","seller":"1"}]},"items":[{"availability":"available","id":"1","listPrice":9999,"measurementUnit":"un","offerings":[],"parentAssemblyBinding":null,"parentItemIndex":null,"price":9999,"priceDefinition":{"calculatedSellingPrice":2999700,"sellingPrices":[{"quantity":1,"value":2999700}],"total":2999700},"priceTags":[{"identifier":"1234abc-5678b-1234c","isPercentual":false,"name":"DISCOUNT@MANUALPRICE","rawValue":-50,"value":-5000}],"priceValidUntil":"2025-04-15T13:52:27.989Z","quantity":1,"requestIndex":0,"rewardValue":0,"seller":"1","sellerChain":["1"],"sellingPrice":2999700,"tax":0,"unitMultiplier":300}],"logisticsInfo":[{"addressId":null,"deliveryChannels":[{"id":"pickup-in-point"},{"id":"delivery"}],"itemIndex":0,"quantity":1,"selectedDeliveryChannel":null,"selectedSla":null,"shipsTo":["BRA"],"slas":[{"availableDeliveryWindows":{"endDateUtc":"2025-04-15T13:52:27.989Z","lisPrice":0,"price":0,"startDateUtc":"2025-04-15T13:52:27.989Z","tax":0},"deliveryChannel":"delivery","deliveryIds":[{"courierId":"1","courierName":"Transportadora","dockId":"1","kitItemDetails":[],"quantity":1,"warehouseId":11}],"deliveryWindow":{"endDateUtc":"2025-04-15T13:52:27.989Z","listprice":1000,"price":0,"startDateUtc":"2025-04-15T13:52:27.989Z","tax":0},"id":"Normal","listPrice":1500,"lockTTL":"10d","name":"Normal","pickupDistance":0,"pickupPointId":null,"pickupStoreInfo":{"additionalInfo":null,"address":null,"dockId":null,"friendlyName":null,"isPickupStore":false},"polygonName":null,"price":1500,"shippingEstimate":"3bd","shippingEstimateDate":null,"tax":0,"transitTime":"3bd"}]}],"marketingData":{"coupon":null,"marketingTags":["tag1","tag2"],"utmCampaign":"Black friday","utmMedium":"CPC","utmSource":"app","utmiCampaign":"true","utmiPart":"true","utmipage":"true"},"messages":[],"paymentData":{"availableAccounts":[],"availableAssociations":{},"availableTokens":[],"giftCardMessages":[],"giftCards":[],"installmentOptions":[{"bin":null,"installments":[{"count":1,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":1,"hasInterestRate":false,"id":"LOJADOBRENO","interestRate":0,"total":2999700,"value":2999700}],"total":2999700,"value":2999700}],"paymentGroupName":"creditCardPaymentGroup","paymentName":"Visa","paymentSystem":"2","value":2999700},{"bin":null,"installments":[{"count":1,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":1,"hasInterestRate":false,"id":"LOJADOBRENO","interestRate":0,"total":2999700,"value":2999700}],"total":2999700,"value":2999700}],"paymentGroupName":"bankInvoicePaymentGroup","paymentName":"Boleto Bancário","paymentSystem":"6","value":2999700},{"bin":null,"installments":[{"count":1,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":1,"hasInterestRate":false,"id":"LOJADOBRENO","interestRate":0,"total":2999700,"value":2999700}],"total":2999700,"value":2999700}],"paymentGroupName":"MercadoPagoProPaymentGroup","paymentName":"MercadoPagoPro","paymentSystem":"127","value":2999700},{"bin":null,"installments":[{"count":1,"hasInterestRate":false,"interestRate":0,"sellerMerchantInstallments":[{"count":1,"hasInterestRate":false,"id":"LOJADOBRENO","interestRate":0,"total":2999700,"value":2999700}],"total":2999700,"value":2999700}],"paymentGroupName":"custom202PaymentGroupPaymentGroup","paymentName":"Dinheiro","paymentSystem":"202","value":2999700}],"paymentSystems":[{"availablePayments":null,"description":"","displayDocument":false,"dueDate":"2025-04-15T13:52:27.989Z","groupName":"custom202PaymentGroupPaymentGroup","id":202,"isCustom":true,"name":"Dinheiro","requiresAuthentication":false,"requiresDocument":false,"stringId":"202","template":"custom202PaymentGroupPaymentGroup-template","validator":null},{"availablePayments":null,"description":"","displayDocument":false,"dueDate":"2025-04-15T13:52:27.989Z","groupName":"bankInvoicePaymentGroup","id":6,"isCustom":false,"name":"Boleto Bancário","requiresAuthentication":false,"requiresDocument":false,"stringId":"6","template":"bankInvoicePaymentGroup-template","validator":null},{"availablePayments":null,"description":"","displayDocument":false,"dueDate":"2025-04-15T13:52:27.989Z","groupName":"creditCardPaymentGroup","id":2,"isCustom":false,"name":"Visa","requiresAuthentication":false,"requiresDocument":false,"stringId":"2","template":"creditCardPaymentGroup-template","validator":null},{"availablePayments":null,"description":"","displayDocument":false,"dueDate":"2025-04-15T13:52:27.989Z","groupName":"MercadoPagoProPaymentGroup","id":127,"isCustom":false,"name":"MercadoPagoPro","requiresAuthentication":false,"requiresDocument":false,"stringId":"127","template":"MercadoPagoProPaymentGroup-template","validator":null}],"payments":[]},"pickupPoints":[],"postalCode":"12345-000","purchaseConditions":{"itemPurchaseConditions":[{"id":"1","listPrice":9999,"price":9999,"seller":"1","sellerChain":["1"],"slas":[{"availableDeliveryWindows":{"endDateUtc":"2025-04-15T13:52:27.989Z","lisPrice":0,"price":0,"startDateUtc":"2025-04-15T13:52:27.989Z","tax":0},"deliveryChannel":"delivery","deliveryIds":[{"courierId":"1","courierName":"Transportadora","dockId":"1","kitItemDetails":[],"quantity":1,"warehouseId":11}],"deliveryWindow":{"endDateUtc":"2025-04-15T13:52:27.989Z","listprice":1000,"price":0,"startDateUtc":"2025-04-15T13:52:27.989Z","tax":0},"id":"Normal","listPrice":1500,"lockTTL":"10d","name":"Normal","pickupDistance":0,"pickupPointId":null,"pickupStoreInfo":{"additionalInfo":null,"address":null,"dockId":null,"friendlyName":null,"isPickupStore":false},"polygonName":null,"price":1500,"shippingEstimate":"3bd","shippingEstimateDate":null,"tax":0,"transitTime":"3bd"}]}]},"ratesAndBenefitsData":{"rateAndBenefitsIdentifiers":[],"teaser":[]},"selectableGifts":[],"subscriptionData":null,"totals":[{"id":"Items","name":"Total dos Itens","value":2999700}]},"schema":{"properties":{"country":{"description":"Three letter ISO code of the country of the shipping address.","type":"string"},"items":{"description":"Information on each item in the cart.","items":{"properties":{"availability":{"description":"Availability.","type":"string"},"id":{"description":"ID of the item.","type":"string"},"listPrice":{"description":"List price in cents.","type":"integer"},"measurementUnit":{"description":"Measurement unit.","type":"string"},"offerings":{"description":"Array containing offering information.","items":{},"type":"array"},"parentAssemblyBinding":{"description":"Parent assembly binding.","nullable":true,"type":"string"},"parentItemIndex":{"description":"Parent item index.","nullable":true,"type":"integer"},"price":{"description":"Price in cents.","type":"integer"},"priceDefinition":{"description":"Price information for all units of a specific item.","properties":{"calculatedSellingPrice":{"description":"Item's calculated unitary selling price in cents.","type":"integer"},"sellingPrices":{"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":{"properties":{"quantity":{"description":"Rounding quantity, meaning how many items are rounded to this value.","type":"integer"},"value":{"description":"Value in cents for that specific rounding.","type":"integer"}},"type":"object"},"type":"array"},"total":{"description":"Total value for all units of the item in cents.","type":"integer"}},"type":"object"},"priceTags":{"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":{"properties":{"identifier":{"description":"Price tag identifier.","type":"string"},"isPercentual":{"description":"Indicates whether price tag value is applied through a percentage.","type":"boolean"},"name":{"description":"Price tag name.","type":"string"},"owner":{"description":"Identification of the responsible for the price tag.","type":"string"},"rawValue":{"description":"Price tag raw value.","type":"integer"},"value":{"description":"Price tag value.","type":"integer"}},"type":"object"},"type":"array"},"priceValidUntil":{"description":"Price expiration date and time.","type":"string"},"quantity":{"description":"The quantity of the item the cart.","type":"integer"},"requestIndex":{"description":"Request index information.","type":"integer"},"rewardValue":{"description":"Reward value in cents.","type":"integer"},"seller":{"description":"The seller responsible for the SKU.","type":"string"},"sellerChain":{"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":{"description":"Seller.","type":"string"},"type":"array"},"sellingPrice":{"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.","type":"integer"},"tax":{"description":"Tax value in cents.","type":"integer"},"unitMultiplier":{"description":"Unit multiplier.","type":"integer"}},"type":"object"},"type":"array"},"logisticsInfo":{"description":"Array with logistics information on each item of the `items` array in the `orderForm`.","items":{"properties":{"addressId":{"description":"Address ID.","nullable":true,"type":"string"},"deliveryChannels":{"description":"List of available delivery channels.","items":{"properties":{"id":{"description":"Delivery channel ID.","type":"string"}},"type":"object"},"type":"array"},"itemIndex":{"description":"Index of item in items array.","type":"integer"},"itemMetadata":{"description":"Item metadata.","properties":{"items":{"description":"List of objects containing metadata on each item in the order.","items":{"properties":{"assemblyOptions":{"description":"Assembly options information.","items":{},"properties":{"composition":{"description":"Composition information.","nullable":true,"type":"string"},"id":{"description":"Item ID.","type":"string"},"inputValues":{"description":"Input values information.","type":"object"},"name":{"description":"Item name.","type":"string"},"required":{"description":"Indicates whether the item is required.","type":"boolean"}},"type":"array"},"id":{"description":"Item ID.","type":"string"},"seller":{"description":"Seller.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"messages":{"description":"Array containing an object for each message generated by our servers while processing the request.","items":{},"type":"array"},"pickupPoints":{"description":"Array containing pickup points information.","items":{},"type":"array"},"purchaseConditions":{"description":"Purchase conditions information.","properties":{"itemPurchaseConditions":{"description":"List of objects containing purchase condition information on each item in the order.","items":{"properties":{"id":{"description":"Item ID.","type":"string"},"listPrice":{"description":"List price in cents.","type":"integer"},"price":{"description":"Price in cents.","type":"integer"},"seller":{"description":"Seller.","type":"string"},"sellerChain":{"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":"array"},"slas":{"description":"Information on available SLAs.","items":{"properties":{"availableDeliveryWindows":{"description":"This object contains information about the delivery window available to the shopper.","properties":{"endDateUtc":{"description":"Delivery window ending day and time in UTC.","type":"string"},"lisPrice":{"description":"Delivery window list price.","type":"integer"},"price":{"description":"Delivery window price.","type":"integer"},"startDateUtc":{"description":"Delivery window starting day and time in UTC.","type":"string"},"tax":{"description":"Delivery window tax.","type":"integer"}},"type":"object"},"deliveryChannel":{"description":"Delivery channel.","type":"string"},"deliveryIds":{"description":"Information on each delivery ID.","items":{"properties":{"courierId":{"description":"Courier ID.","type":"string"},"courierName":{"description":"Courier name.","type":"string"},"dockId":{"description":"Warehouse ID.","type":"string"},"quantity":{"description":"Quantity.","type":"integer"},"warehouseId":{"description":"Warehouse ID.","type":"string"}},"type":"object"},"type":"array"},"deliveryWindow":{"description":"In case of scheduled delivery, this object will contain information on the delivery window selected by the shopper.","properties":{"endDateUtc":{"description":"Delivery window ending day and time in UTC.","type":"string"},"lisPrice":{"description":"Delivery window list price.","type":"integer"},"price":{"description":"Delivery window price.","type":"integer"},"startDateUtc":{"description":"Delivery window starting day and time in UTC.","type":"string"},"tax":{"description":"Delivery window tax.","type":"integer"}},"type":"object"},"id":{"description":"SLA ID.","type":"string"},"listPrice":{"description":"List price in cents.","type":"integer"},"lockTTL":{"description":"Estimate date of delivery.","type":"string"},"name":{"description":"SLA name.","type":"string"},"pickupDistance":{"description":"Pickup point distance.","type":"integer"},"pickupPointId":{"description":"Pickup point ID.","nullable":true,"type":"string"},"pickupStoreInfo":{"description":"Information on the pickup store.","properties":{"additionalInfo":{"description":"Additional information.","nullable":true,"type":"string"},"address":{"description":"Address information.","nullable":true,"type":"object"},"dockId":{"description":"Corresponding dock ID.","nullable":true,"type":"string"},"friendlyName":{"description":"Friendly name.","nullable":true,"type":"string"},"isPickupStore":{"description":"Indicates whether it is the pickup store.","type":"boolean"}},"type":"object"},"polygonName":{"description":"Polygon name.","nullable":true,"type":"string"},"price":{"description":"Price in cents.","type":"integer"},"shippingEstimate":{"description":"Shipping estimate. For instance, \"three business days\" will be represented as `3bd`.","type":"string"},"shippingEstimateDate":{"description":"Shipping estimate date.","nullable":true,"type":"string"},"tax":{"description":"Tax in cents.","type":"integer"},"transitTime":{"description":"Transit time. For instance, \"three business days\" is represented as `3bd`.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"}},"type":"object"},"quantity":{"description":"Quantity.","type":"integer"},"selectedDeliveryChannel":{"description":"Delivery channel selected by the customer. For example, `\"delivery\"` or `\"pickup-in-point\"`.","nullable":true,"type":"string"},"selectedSla":{"description":"Selected SLA. For example, `\"normal\"` or `\"express\"`.","nullable":true,"type":"string"},"shipsTo":{"description":"List of countries that the item may be shipped to.","items":{},"type":"array"},"slas":{"description":"Information on available SLAs.","items":{"properties":{"availableDeliveryWindows":{"description":"This object contains information about the delivery window available to the shopper.","properties":{"endDateUtc":{"description":"Delivery window ending day and time in UTC.","type":"string"},"lisPrice":{"description":"Delivery window list price.","type":"integer"},"price":{"description":"Delivery window price.","type":"integer"},"startDateUtc":{"description":"Delivery window starting day and time in UTC.","type":"string"},"tax":{"description":"Delivery window tax.","type":"integer"}},"type":"object"},"deliveryChannel":{"description":"Delivery channel.","type":"string"},"deliveryIds":{"description":"Information on each delivery ID.","items":{"properties":{"courierId":{"description":"Courier ID.","type":"string"},"courierName":{"description":"Courier name.","type":"string"},"dockId":{"description":"Warehouse ID.","type":"string"},"quantity":{"description":"Quantity.","type":"integer"},"warehouseId":{"description":"Warehouse ID.","type":"string"}},"type":"object"},"type":"array"},"deliveryWindow":{"description":"In case of scheduled delivery, this object will contain information on the delivery window selected by the shopper.","properties":{"endDateUtc":{"description":"Delivery window ending day and time in UTC.","type":"string"},"lisPrice":{"description":"Delivery window list price.","type":"integer"},"price":{"description":"Delivery window price.","type":"integer"},"startDateUtc":{"description":"Delivery window starting day and time in UTC.","type":"string"},"tax":{"description":"Delivery window tax.","type":"integer"}},"type":"object"},"id":{"description":"SLA ID.","type":"string"},"listPrice":{"description":"List price in cents.","type":"integer"},"lockTTL":{"description":"Estimate date of delivery.","type":"string"},"name":{"description":"SLA name.","type":"string"},"pickupDistance":{"description":"Pickup point distance.","type":"integer"},"pickupPointId":{"description":"Pickup point ID.","nullable":true,"type":"string"},"pickupStoreInfo":{"description":"Information on the pickup store.","properties":{"additionalInfo":{"description":"Additional information.","nullable":true,"type":"string"},"address":{"description":"Address information.","nullable":true,"type":"object"},"dockId":{"description":"Corresponding dock ID.","nullable":true,"type":"string"},"friendlyName":{"description":"Friendly name.","nullable":true,"type":"string"},"isPickupStore":{"description":"Indicates whether it is the pickup store.","type":"boolean"}},"type":"object"},"polygonName":{"description":"Polygon name.","nullable":true,"type":"string"},"price":{"description":"Price in cents.","type":"integer"},"shippingEstimate":{"description":"Shipping estimate. For instance, \"three business days\" will be represented as `3bd`.","type":"string"},"shippingEstimateDate":{"description":"Shipping estimate date.","nullable":true,"type":"string"},"tax":{"description":"Tax in cents.","type":"integer"},"transitTime":{"description":"Transit time. For instance, \"three business days\" is represented as `3bd`.","type":"string"}},"type":"object"},"type":"array"},"subscriptionData":{"description":"Subscription information.","nullable":true,"type":"object"},"totals":{"description":"Information on order totals.","items":{"properties":{"id":{"description":"Total ID.","type":"string"},"name":{"description":"Total name.","type":"string"},"value":{"description":"Total value.","type":"integer"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"},"marketingData":{"description":"Object containing promotion data such as coupon tracking information and internal or external UTMs.","nullable":true,"type":"object"},"paymentData":{"description":"Payment data information.","properties":{"availableAccounts":{"description":"Available accounts.","items":{},"type":"array"},"availableAssociations":{"description":"Available associations.","type":"object"},"availableTokens":{"description":"Available tokens.","items":{},"type":"array"},"giftCardMessages":{"description":"Array of gift card messages.","items":{},"type":"array"},"giftCards":{"description":"Gift card information, if it applies to the order.","items":{},"type":"array"},"installmentOptions":{"description":"Installment options information.","items":{},"properties":{"bin":{"description":"Bin.","nullable":true,"type":"string"},"installments":{"description":"Installments information.","items":{},"properties":{"count":{"description":"Count information.","type":"integer"},"hasInterestRate":{"description":"Indicates whether the payment has interest.","type":"boolean"},"interestRate":{"description":"Interest rate value.","type":"integer"},"sellerMerchantInstallments":{"description":"Seller merchant installments information.","items":{},"type":"array"},"total":{"description":"Total value of the order without separating cents. For example, $24.99 is represented `2499`.","type":"integer"},"value":{"description":"Value of the order without the interest rate. The value is shown without separating cents.","type":"integer"}},"type":"array"},"paymentGroupName":{"description":"Payment group name.","type":"string"},"paymentName":{"description":"Payment name.","type":"string"},"paymentSystem":{"description":"Payment system identification.","type":"integer"},"value":{"description":"Total value assigned to this payment.","type":"integer"}},"type":"array"},"paymentSystems":{"description":"Information on payment systems.","items":{"properties":{"availablePayments":{"description":"Availability of payment.","nullable":true,"type":"string"},"description":{"description":"Description.","type":"string"},"displayDocument":{"description":"Indicates whether a document is shown.","type":"boolean"},"dueDate":{"description":"Payment due date.","type":"string"},"groupName":{"description":"Payment group name.","type":"string"},"id":{"description":"Payment system ID.","type":"integer"},"isCustom":{"description":"Indicates whether it is custom.","type":"boolean"},"name":{"description":"Payment system name.","type":"string"},"requiresAuthentication":{"description":"Indicates whether a authentication is required.","type":"boolean"},"requiresDocument":{"description":"Indicates whether a document is required.","type":"boolean"},"stringId":{"description":"String ID.","type":"string"},"template":{"description":"Template.","type":"string"},"validator":{"description":"Payment system validator.","nullable":true,"type":"object"}},"type":"object"},"type":"array"},"payments":{"description":"Information on each payment.","items":{},"type":"array"}},"type":"object"},"postalCode":{"description":"Postal Code.","nullable":true,"type":"string"},"ratesAndBenefitsData":{"description":"Information on rates and benefits that apply to the order.","properties":{"rateAndBenefitsIdentifiers":{"description":"List with rates and benefits identifiers.","items":{},"type":"array"},"teaser":{"description":"List with rates and benefits teasers.","items":{},"type":"array"}},"type":"object"},"selectableGifts":{"description":"Array containing the data of the item selected as a gift.","items":{},"type":"array"}},"type":"object"}}},"description":"OK","headers":{}}},"security":[],"summary":"Cart simulation","tags":["Shopping cart"]}},"/api/checkout/pub/orders":{"put":{"deprecated":false,"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).","operationId":"PlaceOrder","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Trade Policy (Sales Channel) identification. This query can be used to create an order for a specific sales channel.","in":"query","name":"sc","required":false,"schema":{"example":1,"type":"integer"},"style":"form"}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"clientProfileData":{"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.","properties":{"corporateDocument":{"default":"12345678000100","description":"Corporate document, if the customer is a legal entity.","type":"string"},"corporateName":{"default":"company-name","description":"Company name, if the customer is a legal entity.","type":"string"},"corporatePhone":{"default":"+551100988887777","description":"Corporate phone number, if the customer is a legal entity.","type":"string"},"document":{"default":"123456789","description":"Document number informed by the customer.","type":"string"},"documentType":{"default":"cpf","description":"Type of the document informed by the customer.","type":"string"},"email":{"default":"customer@examplemail.com","description":"Customer's email address.","type":"string"},"firstName":{"default":"first-name","description":"Customer's first name.","type":"string"},"isCorporate":{"default":false,"description":"`true` if the customer is a legal entity.","type":"boolean"},"lastName":{"default":"last-name","description":"Customer's last name.","type":"string"},"phone":{"default":"+55110988887777","description":"Customer's phone number.","type":"string"},"stateInscription":{"default":"12345678","description":"State inscription, if the customer is a legal entity.","type":"string"},"tradeName":{"default":"trade-name","description":"Trade name, if the customer is a legal entity.","type":"string"}},"required":["email"],"type":"object"},"items":{"description":"Array of objects containing information on each of the order's items.","items":{"example":{"id":"123456789","quantity":1,"seller":"1"},"properties":{"attachments":{"description":"Array containing information on attachments.","items":{"type":"string"},"type":"array"},"bundleItems":{"description":"Information on services sold along with the SKU. Example: a gift package.","items":{"properties":{"id":{"description":"Service identifier.","example":"id-example","type":"string"},"name":{"description":"Service name.","example":"name-example","type":"string"},"price":{"description":"Service price. The last two digits are the cents.","example":199,"type":"integer"},"type":{"description":"Service type.","example":"type-example","type":"string"}},"type":"object"},"type":"array"},"commission":{"description":"Comission.","example":10,"type":"integer"},"freightCommission":{"description":"Freight comission","example":10,"type":"integer"},"id":{"description":"The SKU ID.","example":"123","type":"string"},"isGift":{"default":false,"description":"Indicates whether the order is a gift.","type":"boolean"},"itemAttachment":{"description":"Item attachment.","properties":{"content":{"description":"Content referring to the customization requested by the customer.","example":"content-example","type":"string"},"name":{"description":"Attachment name.","example":"name-example","type":"string"}},"type":"object"},"measurementUnit":{"default":"g","description":"SKU measurement unit.","type":"string"},"price":{"description":"Item price within the context of the order without separating cents. For example, $24.99 is represented `2499`.","example":2499,"type":"integer"},"priceTags":{"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":{"properties":{"identifier":{"default":"1234abc-5678b-1234c","description":"Price tag identifier.","type":"string"},"isPercentual":{"default":false,"description":"`true` if price tag value is applied through a percentage.","type":"boolean"},"name":{"default":"discount@name-1234abc-5678b-1234c","description":"Price tag name.","type":"string"},"rawValue":{"default":-12,"description":"Price tag raw value.","type":"integer"},"value":{"default":-1200,"description":"Price tag value.","type":"integer"}},"type":"object"},"type":"array"},"quantity":{"description":"The quantity of items of this specific SKU in the cart to be simulated.","example":1,"format":"int32","type":"integer"},"seller":{"description":"The ID of the seller responsible for this SKU. This ID can be found in your VTEX Admin.","example":"1","type":"string"},"unitMultiplier":{"default":1,"description":"SKU unit multiplier.","type":"integer"}},"required":["id","quantity","seller"],"type":"object"},"type":"array"},"marketingData":{"properties":{"coupon":{"default":"free-shipping","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.","type":"string"},"utmCampaign":{"default":"Black friday","description":"UTM campaign","type":"string"},"utmMedium":{"default":"CPC","description":"UTM medium.","type":"string"},"utmSource":{"default":"Facebook","description":"UTM source.","type":"string"},"utmiCampaign":{"default":"utmi_campaign-exmaple","description":"utmi_campaign (internal utm)","type":"string"},"utmiPage":{"default":"utmi_page-example","description":"utmi_page (internal utm)","type":"string"},"utmiPart":{"default":"utmi_part-exmaple","description":"utmi_part (internal utm)","type":"string"}},"type":"object"},"openTextField":{"default":"open-text-example","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)","type":"string"},"paymentData":{"description":"Payment infomation.","properties":{"giftCardMessages":{"description":"Array of gift card messages.","items":{"default":"message-example"},"type":"array"},"giftCards":{"description":"Gift card information, if it applies to the order.","items":{"properties":{"balance":{"description":"Gift card balance.","example":500,"type":"integer"},"id":{"description":"Gift card ID.","example":"1390324156495k195pmab4rall3di","type":"string"},"inUse":{"description":"Indicates whether gift card is in use.","example":true,"type":"boolean"},"isSpecialCard":{"description":"Indicates whether gift card is special.","example":false,"type":"boolean"},"name":{"description":"Gift card name.","example":"name-example","type":"string"},"redemptionCode":{"description":"Gift card redemption code.","example":"HYUO-TEZZ-QFFT-HTFR","type":"string"},"value":{"description":"Gift card value.","example":500,"type":"integer"}},"required":["redemptionCode","value"],"type":"object"},"type":"array"},"paymentSystems":{"description":"Information on payment systems.","items":{"properties":{"description":{"default":"description-example","description":"Description.","type":"string"},"groupName":{"description":"Payment group name.","example":"creditCardPaymentGroup","type":"string"},"id":{"description":"Payment system ID.","example":2,"type":"integer"},"isCustom":{"default":false,"description":"Indicates whether it is custom.","type":"boolean"},"name":{"description":"Payment system name.","example":"Visa","type":"string"},"requiresDocument":{"default":false,"description":"Indicates whether a document is required.","type":"boolean"},"selected":{"default":false,"description":"Indicates whether this payment system has been selected.","type":"boolean"},"stringId":{"default":"12345abc","description":"String ID.","type":"string"},"template":{"default":"creditCardPaymentGroup-template","description":"Template.","type":"string"},"validator":{"description":"Payment system validator.","properties":{"cardCodeMask":{"description":"Card code mask.","example":"999","type":"string"},"cardCodeRegex":{"description":"Card code regular expression.","example":"[^0-9]","type":"string"},"mask":{"description":"Validator mask.","example":"9999 9999 9999 9999","type":"string"},"regex":{"description":"","example":"^4","type":"string"},"weights":{"default":[2,1,2,1,2,1,2,1,2,1,2,1,2,1,2,1,2,1,2],"description":"Weights.","items":{"type":"integer"},"type":"array"}},"type":"object"}},"type":"object"},"type":"array"},"payments":{"description":"Payment information.","items":{"description":"","properties":{"accountId":{"default":"accountID-example","description":"Account ID.","type":"string"},"bin":{"default":"2","description":"Payment bin.","type":"string"},"installments":{"default":2,"description":"Number of installments.","type":"integer"},"paymentSystem":{"default":"12","description":"Payment system.","type":"string"},"referenceValue":{"default":16175,"description":"Reference value for calculating interest rates, in case it applies.","type":"integer"},"value":{"default":16175,"description":"Value including interest, in case it applies.","type":"integer"}},"required":["paymentSystem","referenceValue","value","installments"],"type":"object"},"type":"array"},"updateStatus":{"default":"updated","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\"`","type":"string"}},"required":["payments"],"type":"object"},"salesAssociateData":{"description":"Sales Associate information.","properties":{"salesAssociateId":{"default":"seller123","description":"Sales Associate (Seller) identification code. All information should be registered by the merchant. Maximum of 100 characters.","type":"string"}},"type":"object"},"shippingData":{"description":"Shipping information.","properties":{"address":{"description":"Shipping address.\n\r\n\rFor customers already in your data base, it is enough to send this object only with an `addressId`, which you may obtain from a [Cart simulation request](https://developers.vtex.com/vtex-rest-api/reference/shopping-cart#cartsimulation), for example.","properties":{"addressId":{"default":"Home","description":"Address ID.","type":"string"},"addressType":{"description":"Type of address. For example, `Residential` or `Pickup`, among others.","example":"residential","type":"string"},"city":{"default":"Rio de Janeiro","description":"City of the shipping address.","type":"string"},"complement":{"default":"3rd floor","description":"Complement to the shipping address in case it applies.","type":"string"},"country":{"default":"BRA","description":"Three letter ISO code of the country of the shipping address.","type":"string"},"geoCoordinates":{"default":[-47.924747467041016,-15.832582473754883],"description":"Array containing two floats with geocoordinates, first longitude, then latitude.","items":{"example":-47.924747467041016,"type":"number"},"type":"array"},"neighborhood":{"default":"Botafogo","description":"Neighborhood of the shipping address.","type":"string"},"number":{"default":"300","description":"Number of the building, house or apartment in the shipping address.","type":"string"},"postalCode":{"default":"12345-000","description":"Postal Code.","type":"string"},"receiverName":{"default":"receiver-name","description":"Name of the person who is going to receive the order.","type":"string"},"reference":{"default":"Grey building","description":"Complement that might help locate the shipping address more precisely in case of delivery.","type":"string"},"state":{"default":"Rio de Janeiro","description":"State of the shipping address.","type":"string"},"street":{"default":"Praia de Botafogo","description":"Street of the shipping address.","type":"string"}},"type":"object"},"logisticsInfo":{"description":"Array of objects containing logistics information of each item.","items":{"properties":{"deliveryWindow":{"description":"In case of scheduled delivery, this object will contain information on the delivery window selected by the shopper.","properties":{"endDateUtc":{"default":"2025-04-15T13:52:27.990Z","description":"Delivery window ending day and time in UTC.","type":"string"},"lisPrice":{"default":0,"description":"Delivery window list price.","type":"integer"},"price":{"default":0,"description":"Delivery window price.","type":"integer"},"startDateUtc":{"default":"2025-04-15T13:52:27.990Z","description":"Delivery window starting day and time in UTC.","type":"string"},"tax":{"default":0,"description":"Delivery window tax.","type":"integer"}},"type":"object"},"itemIndex":{"default":0,"description":"Index of the item in the `items` array, starting from 0.","type":"integer"},"lockTTL":{"default":"8d","description":"Logistics reservation waiting time.","type":"string"},"price":{"default":1099,"description":"Shipping price for the item. Does not account for the whole order's shipping price.","type":"integer"},"selectedSla":{"default":"Express","description":"Selected shipping option","type":"string"},"shippingEstimate":{"default":"7d","description":"Estimated time until delivery for the item.","type":"string"}},"required":["itemIndex","selectedSla","price"],"type":"object"},"type":"array"},"updateStatus":{"default":"updated","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\"`","type":"string"}},"type":"object"}},"required":["items","clientProfileData","shippingData","paymentData"],"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"example":{"orderForm":null,"orders":[{"allowCancellation":false,"allowChangeSeller":false,"allowEdition":false,"changeData":null,"checkedInPickupPointId":null,"clientPreferencesData":null,"clientProfileData":{"corporateDocument":null,"corporateName":null,"corporatePhone":null,"customerClass":null,"document":"12345678900","documentType":"cpf","email":"clark.kent@example.com","firstName":"Clark","isCorporate":false,"lastName":"Kent","phone":"+5521998765432","profileCompleteOnLoading":false,"profileErrorOnLoading":null,"stateInscription":null,"tradeName":null},"commercialConditionData":null,"creationDate":"2025-04-15T13:52:27.990Z","customData":null,"followUpEmail":"6c10d76b5170456d89823b38b7c8f6ac@ct.vtex.com.br","giftRegistryData":null,"hooksData":null,"hostName":"mystore","invoiceData":null,"isCheckedIn":false,"isCompleted":false,"isUserDataVisible":true,"itemMetadata":{"items":[{"assemblyOptions":[],"detailUrl":"/chopp-brahma-claro-30l/p","ean":null,"id":"2","imageUrl":"http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000","name":"Chopp Brahma Claro 30L","productId":"2","refId":"CBC30L","seller":"1","skuName":"Chopp Brahma Claro 30L"}]},"items":[{"additionalInfo":{"brandId":"2000000","brandName":"Brahma","dimension":null,"offeringInfo":null,"offeringType":null,"offeringTypeId":null},"assemblies":[],"attachmentOfferings":[],"attachments":[],"availability":"available","bundleItems":[],"components":[],"detailUrl":"/chopp-brahma-claro-30l/p","ean":null,"id":"2","imageUrl":"http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000","isGift":false,"listPrice":49900,"manualPrice":null,"manualPriceAppliedBy":null,"manufacturerCode":null,"measurementUnit":"un","modalType":null,"name":"Chopp Brahma Claro 30L","offerings":[],"parentAssemblyBinding":null,"parentItemIndex":null,"preSaleDate":null,"price":32890,"priceDefinition":{"calculatedSellingPrice":32890,"sellingPrices":[{"quantity":1,"value":32890}],"total":32890},"priceTags":[],"priceValidUntil":"2025-04-15T13:52:27.990Z","productCategories":{"1":"Bebidas"},"productCategoryIds":"/1/","productId":"2","productRefId":"","quantity":1,"refId":"CBC30L","rewardValue":0,"seller":"1","sellerChain":["1"],"sellingPrice":32890,"skuName":"Chopp Brahma Claro 30L","tax":0,"uniqueId":"9D6E447B3FF64CEDA33B17C01379C119","unitMultiplier":1}],"lastChange":"2025-04-15T13:52:27.990Z","marketingData":null,"merchantName":null,"openTextField":{"value":null},"orderFormCreationDate":"2025-04-15T13:52:27.990Z","orderGroup":"1146512005522","orderId":"1146512005522-01","paymentData":{"giftCards":[],"transactions":[{"isActive":true,"merchantName":"MYSTORE","payments":[],"sharedTransaction":false,"transactionId":"296D6D245C17437E823EB77E403FC88D"}]},"ratesAndBenefitsData":{"rateAndBenefitsIdentifiers":[],"teaser":[]},"roundingError":0,"salesChannel":"1","sellerOrderId":"00-1146512005522-01","sellers":[{"id":"1","logo":"","name":"Tracking QA"}],"shippingData":{"address":{"addressId":"teste","addressType":"residential","city":"Brasília","complement":"15º andar","country":"BRA","geoCoordinates":[-47.924747467041016,-15.832582473754883],"isDisposable":true,"neighborhood":"Copacabana","number":"123","postalCode":"70386000","receiverName":"Clark Kent","reference":null,"state":"DF","street":"Rua da minha casa"},"availableAddresses":[{"addressId":"teste","addressType":"residential","city":"Rio de Janeiro","complement":"15º andar","country":"BRA","geoCoordinates":[-47.924747467041016,-15.832582473754883],"isDisposable":true,"neighborhood":"Copacabana","number":"123","postalCode":"12345000","receiverName":"Clark Kent","reference":null,"state":"RJ","street":"Rua da minha casa"}],"logisticsInfo":[{"addressId":"teste","deliveryChannels":[{"id":"delivery"},{"id":"pickup-in-point"}],"itemId":"2","itemIndex":0,"selectedDeliveryChannel":"delivery","selectedSla":"Normal","shipsTo":["BRA","COL","USA"],"slas":[{"availableDeliveryWindows":[],"deliveryChannel":"delivery","deliveryIds":[{"courierId":"1","courierName":"Transportadora","dockId":"1","kitItemDetails":[],"quantity":1,"warehouseId":11}],"deliveryWindow":null,"id":"Normal","listPrice":1500,"lockTTL":"10d","name":"Normal","pickupDistance":0,"pickupPointId":null,"pickupStoreInfo":{"additionalInfo":null,"address":null,"dockId":null,"friendlyName":null,"isPickupStore":false},"polygonName":null,"price":1500,"shippingEstimate":"3bd","shippingEstimateDate":null,"tax":0,"transitTime":"3bd"}]}],"pickupPoints":[],"selectedAddresses":[{"addressId":"teste","addressType":"residential","city":"Rio de Janeiro","complement":"15º andar","country":"BRA","geoCoordinates":[-47.924747467041016,-15.832582473754883],"isDisposable":true,"neighborhood":"Copacabana","number":"123","postalCode":"12345000","receiverName":"Clark Kent","reference":null,"state":"RJ","street":"Rua da minha casa"}]},"state":null,"storeId":null,"storePreferencesData":{"countryCode":"BRA","currencyCode":"BRL","currencyFormatInfo":{"currencyDecimalDigits":2,"currencyDecimalSeparator":",","currencyGroupSeparator":".","currencyGroupSize":3,"startsWithCurrencySymbol":true},"currencyLocale":1046,"currencySymbol":"R$","saveUserData":false,"timeZone":"E. South America Standard Time"},"subscriptionData":null,"taxData":null,"timeZoneCreationDate":"2025-04-15T13:52:27.990Z","timeZoneLastChange":"2025-04-15T13:52:27.990Z","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}],"userType":"","value":34390}],"salesAssociateData":{"salesAssociateId":"seller123"},"transactionData":{"gatewayCallbackTemplatePath":"/checkout/gatewayCallback/1146512005522/{messageCode}","merchantTransactions":[{"id":"MYSTORE","merchantName":"MYSTORE","payments":[{"accountId":null,"bin":null,"giftCardId":null,"giftCardProvider":null,"giftCardRedemptionCode":null,"paymentSystem":"6","referenceValue":34390,"tokenId":null,"value":34390}],"transactionId":"296D6D245C17437E823EB77E403FC88D"}],"receiverUri":"https://mystore.vtexpayments.com.br/split/1146512005522/payments"}},"schema":{"properties":{"orderForm":{"description":"This is `null` since this request does not depend on any previously existing orderForm information in the platform.","nullable":true,"type":"string"},"orders":{"description":"Information on each of the orders created.","items":{"properties":{"allowCancelation":{"description":"Indicates whether cancelation is allowed.","type":"boolean"},"allowChangeSeller":{"description":"Indicates whether seller changing is allowed.","type":"boolean"},"allowEdition":{"description":"Indicates whether edition is allowed.","type":"boolean"},"checkedInPickupPointId":{"description":"Checked in pickuppoint.","nullable":true,"type":"string"},"clientProfileData":{"description":"Customer's profile information.","properties":{"corporateDocument":{"description":"Corporate document, if the customer is a legal entity.","nullable":true,"type":"string"},"corporateName":{"description":"Company name, if the customer is a legal entity.","nullable":true,"type":"string"},"corporatePhone":{"description":"Corporate phone number, if the customer is a legal entity.","nullable":true,"type":"string"},"customerClass":{"description":"Customer class.","nullable":true,"type":"string"},"document":{"description":"Document informed by the customer.","type":"string"},"documentType":{"description":"Type of the document informed by the customer.","type":"string"},"email":{"description":"Email address.","type":"string"},"firstName":{"description":"First name.","type":"string"},"isCorporate":{"description":"Indicates whether the customer is a legal entity.","type":"boolean"},"lastName":{"description":"Last name.","type":"string"},"phone":{"description":"Phone number.","type":"string"},"profileCompleteOnLoading":{"description":"Indicates whether profile is complete on loading.","type":"boolean"},"profileErrorOnLoading":{"description":"Indicates whether profile presents error on loading.","nullable":true,"type":"boolean"},"stateInscription":{"description":"State inscription, if the customer is a legal entity.","nullable":true,"type":"string"},"tradeName":{"description":"Trade name, if the customer is a legal entity.","nullable":true,"type":"string"}},"type":"object"},"creationDate":{"description":"Creation date.","type":"string"},"followUpEmail":{"description":"Follow up email address.","type":"string"},"hostName":{"description":"Host name.","type":"string"},"isCheckedIn":{"default":false,"description":"Indicates whether order is checked in.","type":"boolean"},"isCompleted":{"description":"Indicates whether order is completed.","type":"boolean"},"isUserDataVisible":{"description":"Indicates whether user data is visible.","type":"boolean"},"itemMetadata":{"description":"Item metadata.","properties":{"items":{"description":"List of objects containing metadata on each item in the order.","items":{"properties":{"detailUrl":{"description":"Detail URL.","type":"string"},"ean":{"description":"European Article Number.","nullable":true,"type":"string"},"id":{"description":"Item ID.","type":"string"},"imageUrl":{"description":"Image URL.","type":"string"},"name":{"description":"Product name.","type":"string"},"productId":{"description":"Product ID.","type":"string"},"refId":{"description":"Ref ID.","type":"string"},"seller":{"description":"Seller.","type":"string"},"skuName":{"description":"SKU name.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"items":{"description":"Information on each item in the order.","items":{"properties":{"additionalInfo":{"description":"Additional information.","properties":{"brandId":{"description":"Brand ID.","type":"string"},"brandName":{"description":"Brand name.","type":"string"},"dimension":{"description":"Dimension.","nullable":true,"type":"string"},"offeringInfo":{"description":"Offering information.","nullable":true,"type":"string"},"offeringType":{"description":"Offering type.","nullable":true,"type":"string"},"offeringTypeId":{"description":"Offering type ID.","nullable":true,"type":"string"}},"type":"object"},"attachments":{"description":"Array containing information on attachments.","items":{"type":"string"},"type":"array"},"availability":{"description":"Availability","type":"string"},"bundleItems":{"description":"Information on services sold along with the SKU. Example: a gift package.","items":{"properties":{"id":{"description":"Service identifier.","type":"integer"},"name":{"description":"Service name.","type":"string"},"price":{"description":"Service price in cents.","type":"integer"},"type":{"description":"Service type.","type":"string"}},"type":"object"},"type":"array"},"detailUrl":{"description":"Detail URL.","type":"string"},"ean":{"description":"European Article Number.","nullable":true,"type":"string"},"id":{"description":"ID of the item.","type":"string"},"imageUrl":{"description":"Image URL.","type":"string"},"isGift":{"description":"Indicates whether item is a gift.","type":"boolean"},"listPrice":{"description":"List price in cents.","type":"integer"},"manualPrice":{"description":"Manual price in cents.","nullable":true,"type":"integer"},"manualPriceAppliedBy":{"description":"User that applied the manual price, if that is the case.","nullable":true,"type":"string"},"manufacturerCode":{"description":"Manufacturer code.","nullable":true,"type":"string"},"measurementUnit":{"description":"Measurement unit","type":"string"},"modalType":{"description":"Modal type.","nullable":true,"type":"string"},"name":{"description":"Product name.","type":"string"},"parentAssemblyBinding":{"description":"Parent assembly binding.","nullable":true,"type":"string"},"parentItemIndex":{"description":"Parent item index.","nullable":true,"type":"integer"},"preSaleDate":{"description":"Presale date.","nullable":true,"type":"string"},"price":{"description":"Price in cents.","type":"integer"},"priceDefinition":{"description":"Price information for all units of a specific item.","properties":{"calculatedSellingPrice":{"description":"Item's calculated unitary selling price in cents.","type":"integer"},"sellingPrices":{"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":{"properties":{"quantity":{"description":"Rounding quantity, meaning how many items are rounded to this value.","type":"integer"},"value":{"description":"Value in cents for that specific rounding.","type":"integer"}},"type":"object"},"type":"array"},"total":{"description":"Total value for all units of the item in cents.","type":"integer"}},"type":"object"},"priceTags":{"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":{"properties":{"identifier":{"description":"Price tag identifier.","type":"string"},"isPercentual":{"description":"Indicates whether price tag value is applied through a percentage.","type":"boolean"},"name":{"description":"Price tag name.","type":"string"},"rawValue":{"description":"Price tag raw value.","type":"integer"},"value":{"description":"Price tag value.","type":"integer"}},"type":"object"},"type":"array"},"priceValidUntil":{"description":"Price expiration date and time.","type":"string"},"productCategories":{"description":"Object, where each field is an ID from `productCategoryIds`.","properties":{"{ID}":{"description":"Product category corresponding to the ID in the field key.","type":"string"}},"type":"object"},"productCategoryIds":{"description":"Product category IDs.","type":"string"},"productId":{"description":"Product ID.","type":"string"},"productRefId":{"description":"Product Ref ID.","type":"string"},"quantity":{"description":"Quantity.","type":"integer"},"refId":{"description":"Ref ID.","type":"string"},"rewardValue":{"description":"Reward value in cents.","type":"integer"},"seller":{"description":"Seller.","type":"string"},"sellerChain":{"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":{"description":"Seller.","type":"string"},"type":"array"},"sellingPrice":{"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.","type":"integer"},"skuName":{"description":"SKU name.","type":"string"},"tax":{"description":"Tax value in cents.","type":"integer"},"uniqueId":{"description":"Unique ID.","type":"string"},"unitMultiplier":{"description":"Unit multiplier","type":"integer"}},"type":"object"},"type":"array"},"lastChange":{"description":"Last change.","type":"string"},"merchantName":{"description":"Merchant name.","nullable":true,"type":"string"},"orderFormCreationDate":{"description":"`orderForm` creation date.","type":"string"},"orderGroup":{"description":"Order group. Orders that involve different sellers are split into different orders of a same order group.","type":"string"},"orderId":{"description":"ID of the order in the Order Management System (OMS).","type":"string"},"paymentData":{"description":"Information on the order's payment.","properties":{"giftCards":{"description":"Gift card information, if it applies to the order.","items":{"properties":{"balance":{"description":"Gift card balance in cents.","type":"integer"},"id":{"description":"Gift card ID.","type":"string"},"inUse":{"description":"Indicates whether gift card is in use.","type":"boolean"},"isSpecialCard":{"description":"Indicates whether gift card is special.","type":"boolean"},"name":{"description":"Gift card name.","type":"string"},"redemptionCode":{"description":"Gift card redemption code.","type":"string"},"value":{"description":"Gift card value in cents.","type":"integer"}},"type":"object"},"type":"array"},"transactions":{"description":"Information on each transaction pertinent to the order.","items":{"properties":{"isActive":{"description":"Indicates whether transaction is active.","type":"boolean"},"merchantName":{"description":"Merchant name.","type":"string"},"payments":{"description":"Information on each payment.","items":{"properties":{"accountId":{"description":"Account ID.","type":"string"},"bin":{"description":"Bin.","type":"string"},"installments":{"description":"Number of installments.","type":"integer"},"paymentSystem":{"description":"Payment system.","type":"string"},"referenceValue":{"description":"Reference value for calculating interest rates, in case it applies. Displayed in cents.","type":"integer"},"value":{"description":"Value including interest, in case it applies. Displayed in cents.","type":"integer"}},"type":"object"},"type":"array"},"sharedTransaction":{"description":"Indicates whather transaction is shared.","type":"boolean"},"transactionId":{"description":"Transaction ID.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"ratesAndBenefitsData":{"description":"Information on rates and benefits that apply to the order.","properties":{"rateAndBenefitsIdentifiers":{"description":"List with rates and benefits identifiers.","items":{"type":"string"},"type":"array"},"teaser":{"description":"List with rates and benefits teasers.","items":{"type":"string"},"type":"array"}},"type":"object"},"roundingError":{"description":"Rounding error.","type":"integer"},"salesAssociateId":{"description":"Sales Associate (Seller) identification code.","type":"string"},"salesChannel":{"description":"Sales channel.","type":"string"},"sellerOrderId":{"description":"ID of the order in the seller.","nullable":true,"type":"string"},"sellers":{"description":"Information on each seller.","items":{"properties":{"id":{"description":"Seller ID.","type":"string"},"logo":{"description":"Seller logo.","nullable":true,"type":"string"},"name":{"description":"Seller name.","type":"string"}},"type":"object"},"type":"array"},"shippingData":{"description":"Shipping information pertinent to the order.","properties":{"address":{"description":"Address information.","properties":{"addressId":{"description":"Address ID.","type":"string"},"addressType":{"description":"Type of address. For example, `Residential` or `Pickup`.","type":"string"},"city":{"description":"City of the shipping address.","type":"string"},"complement":{"description":"Complement to the shipping address, in case it applies.","nullable":true,"type":"string"},"country":{"description":"Three letter ISO code of the country of the shipping address.","type":"string"},"geoCoordinates":{"description":"Array containing two floats with geocoordinates, first longitude, then latitude.","items":{"type":"number"},"type":"array"},"isDisposable":{"description":"Indicates whether address is disposable.","type":"boolean"},"neighborhood":{"description":"Neighborhood of the shipping address.","type":"string"},"number":{"description":"Number of the building, house or apartment in the shipping address.","type":"string"},"postalCode":{"description":"Postal code.","type":"string"},"receiverName":{"description":"Name of the person who is going to receive the order.","type":"string"},"reference":{"description":"Complement that might help locate the shipping address more precisely in case of delivery.","nullable":true,"type":"string"},"state":{"description":"State of the shipping address.","type":"string"},"street":{"description":"Street of the shipping address.","type":"string"}},"type":"object"},"availableAddresses":{"description":"Array with information on the available addresses for the order.","items":{"properties":{"addressId":{"description":"Address ID.","type":"string"},"addressType":{"description":"Type of address. For example, `Residential` or `Pickup`.","type":"string"},"city":{"description":"City of the shipping address.","type":"string"},"complement":{"description":"Complement to the shipping address, in case it applies.","type":"string"},"country":{"description":"Three letter ISO code of the country of the shipping address.","type":"string"},"geoCoordinates":{"description":"Array containing two floats with geocoordinates, first longitude, then latitude.","items":{"type":"number"},"type":"array"},"isDisposable":{"description":"Indicates whether address is disposable.","type":"boolean"},"neighborhood":{"description":"Neighborhood of the shipping address.","type":"string"},"number":{"description":"Number of the building, house or apartment in the shipping address.","type":"string"},"postalCode":{"description":"Postal code.","type":"string"},"receiverName":{"description":"Name of the person who is going to receive the order.","type":"string"},"reference":{"description":"Complement that might help locate the shipping address more precisely in case of delivery.","nullable":true,"type":"string"},"state":{"description":"State of the shipping address.","type":"string"},"street":{"description":"Street of the shipping address.","type":"string"}},"type":"object"},"type":"array"},"logisticsInfo":{"description":"Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.","items":{"properties":{"addressId":{"description":"Address ID.","type":"string"},"deliveryChannels":{"description":"List of available delivery channels.","items":{"properties":{"id":{"description":"Delivery channel ID.","type":"string"}},"type":"object"},"type":"array"},"itemId":{"description":"Item ID.","type":"string"},"itemIndex":{"description":"Index corresponding to the position of the object in the `items` array.","type":"integer"},"selectedDeliveryChannel":{"description":"Delivery channel selected by the customer.","type":"string"},"selectedSla":{"description":"SLA selected by the customer.","type":"string"},"shipsTo":{"description":"List of countries that the item may be shipped to.","items":{"description":"Three letter country code.","type":"string"},"type":"array"},"slas":{"description":"Information on available SLAs.","items":{"properties":{"deliveryChannel":{"description":"Delivery channel.","type":"string"},"deliveryIds":{"description":"Information on each delivery ID.","items":{"properties":{"courierId":{"description":"Courier ID.","type":"string"},"courierName":{"description":"Courier name.","type":"string"},"dockId":{"description":"Warehouse ID.","type":"string"},"quantity":{"description":"Quantity.","type":"integer"},"warehouseId":{"description":"Warehouse ID.","type":"string"}},"type":"object"},"type":"array"},"id":{"description":"SLA ID.","type":"string"},"listPrice":{"description":"List price in cents.","type":"integer"},"lockTTL":{"description":"Estimate date of delivery.","type":"string"},"name":{"description":"SLA name.","type":"string"},"pickupDistance":{"description":"Pickup point distance.","type":"integer"},"pickupPointId":{"description":"Pickup point ID.","nullable":true,"type":"string"},"pickupStoreInfo":{"description":"Information on the pickup store.","properties":{"additionalInfo":{"description":"Additional information.","nullable":true,"type":"string"},"address":{"description":"Address information.","nullable":true,"properties":{"addressType":{"description":"Type of address. For example, `Residential` or `Pickup`.","type":"string"},"city":{"description":"City of the shipping address.","type":"string"},"complement":{"description":"Complement to the shipping address, in case it applies.","nullable":true,"type":"string"},"country":{"description":"Three letter ISO code of the country of the shipping address.","type":"string"},"geoCoordinates":{"description":"Array containing two floats with geocoordinates, first longitude, then latitude.","items":{"type":"number"},"type":"array"},"neighborhood":{"description":"Neighborhood of the shipping address.","type":"string"},"number":{"description":"Number of the building, house or apartment in the shipping address.","type":"string"},"postalCode":{"description":"Postal code.","type":"string"},"reference":{"description":"Complement that might help locate the shipping address more precisely in case of delivery.","nullable":true,"type":"string"},"state":{"description":"State of the shipping address.","type":"string"},"street":{"description":"Street of the shipping address.","type":"string"}},"type":"object"},"dockId":{"description":"Corresponding dock ID.","nullable":true,"type":"string"},"friendlyName":{"description":"Friendly name.","nullable":true,"type":"string"},"isPickupStore":{"description":"Indicates whether it is the pickup store.","type":"boolean"}},"type":"object"},"polygonName":{"description":"Polygon name.","nullable":true,"type":"string"},"price":{"description":"Price in cents.","type":"integer"},"shippingEstimate":{"description":"Shipping estimate. For instance, Three business days will be represented `3bd`.","type":"string"},"shippingEstimateDate":{"description":"Shipping estimate date.","nullable":true,"type":"string"},"tax":{"description":"Tax in cents.","type":"integer"},"transitTime":{"description":"Transit time. For instance, \"three business days\" is represented `3bd`.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"type":"array"},"selectedAddresses":{"description":"Array with information on the selected addresses for the order.","items":{"properties":{"addressId":{"description":"Address ID.","type":"string"},"addressType":{"description":"Type of address. For example, `Residential` or `Pickup`.","type":"string"},"city":{"description":"City of the shipping address.","type":"string"},"complement":{"description":"Complement to the shipping address, in case it applies.","type":"string"},"country":{"description":"Three letter ISO code of the country of the shipping address.","type":"string"},"geoCoordinates":{"description":"Array containing two floats with geocoordinates, first longitude, then latitude.","items":{"type":"number"},"type":"array"},"isDisposable":{"description":"Indicates whether address is disposable.","type":"boolean"},"neighborhood":{"description":"Neighborhood of the shipping address.","type":"string"},"number":{"description":"Number of the building, house or apartment in the shipping address.","type":"string"},"postalCode":{"description":"Postal code.","type":"string"},"receiverName":{"description":"Name of the person who is going to receive the order.","type":"string"},"reference":{"description":"Complement that might help locate the shipping address more precisely in case of delivery.","nullable":true,"type":"string"},"state":{"description":"State of the shipping address.","type":"string"},"street":{"description":"Street of the shipping address.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"state":{"description":"State.","nullable":true,"type":"string"},"storeId":{"description":"Store ID.","nullable":true,"type":"string"},"timeZoneCreationDate":{"description":"Time zone creation date.","type":"string"},"timeZoneLastChange":{"description":"Time zone last change.","type":"string"},"totals":{"description":"Information on order totals.","items":{"properties":{"id":{"description":"Total ID.","type":"string"},"name":{"description":"Total name.","type":"string"},"value":{"description":"Total value.","type":"integer"}},"type":"object"},"type":"array"},"userType":{"description":"User type.","type":"string"},"value":{"description":"Value of the order.","type":"integer"}},"type":"object"},"type":"array"},"transactionData":{"description":"Information on each transaction pertinent to the order placed.","properties":{"gatewayCallbackTemplatePath":{"description":"Template of the gateway callback path, which may later be used to send information about the transaction.","type":"string"},"merchantTransactions":{"description":"Information on each merchant transaction.","items":{"properties":{"id":{"description":"ID of the seller.","type":"string"},"merchantName":{"description":"Name of the merchant responsible for the sale.","type":"string"},"payments":{"description":"Information on each payment pertinent to the transaction.","items":{"properties":{"accountId":{"description":"Account ID.","nullable":true,"type":"string"},"bin":{"description":"Payment bin.","nullable":true,"type":"string"},"giftCardId":{"description":"Gift card ID.","nullable":true,"type":"string"},"giftCardProvider":{"description":"Gift card provider.","nullable":true,"type":"string"},"giftCardRedemptionCode":{"description":"Gift card redemption code.","nullable":true,"type":"string"},"paymentSystem":{"description":"Payment system.","type":"string"},"referenceValue":{"description":"Reference value over which interests may be applied.","type":"integer"},"tokenId":{"description":"Token ID.","nullable":true,"type":"string"},"value":{"description":"Total value to be paid in this payment.","type":"integer"}},"type":"object"},"type":"array"},"transactionId":{"description":"ID of the transaction in the platform.","type":"string"}},"type":"object"},"type":"array"},"receiverUri":{"description":"Receiver URI.","type":"string"}},"type":"object"}},"type":"object"}}},"description":"OK"}},"summary":"Place order","tags":["Order placement"]}},"/api/checkout/pub/pickup-points":{"get":{"description":"Retrieves information on pickup points close to a given location determined by geocoordinates or postal code.\n\r\n\rThe pickup points returned are not necessarily all active ones. Make sure to validate the information consumed by integrations.","operationId":"ListPickupPpointsByLocation","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"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.","in":"query","name":"geoCoordinates","required":false,"schema":{"default":[-47.924747467041016,-15.832582473754883],"items":{"example":-47.924747467041016,"type":"number"},"type":"array"},"style":"form"},{"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`.","in":"query","name":"postalCode","required":false,"schema":{"default":"1234000","type":"string"},"style":"form"},{"description":"Three letter country code refering to the `postalCode` field. Pass the country code only if you are searching pickup points by postal code.","in":"query","name":"countryCode","required":false,"schema":{"default":"BRA","type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"items":[{"distance":0.8469786518616546,"pickupPoint":{"additionalInfo":null,"address":{"addressId":"physical-store-02","addressType":"pickup","city":"Rio de Janeiro","complement":"","country":"BRA","geoCoordinates":[-47.924747467041016,-15.832582473754883],"isDisposable":true,"neighborhood":"Botafogo","number":"132","postalCode":"23450-070","receiverName":null,"reference":null,"state":"RJ","street":"Praia de Botafogo"},"businessHours":[{"ClosingTime":86340,"DayOfWeek":0,"OpeningTime":"00:00:00"},{"ClosingTime":86340,"DayOfWeek":1,"OpeningTime":"00:00:00"},{"ClosingTime":86340,"DayOfWeek":2,"OpeningTime":"00:00:00"},{"ClosingTime":86340,"DayOfWeek":3,"OpeningTime":"00:00:00"},{"ClosingTime":85800,"DayOfWeek":4,"OpeningTime":"00:00:00"},{"ClosingTime":86340,"DayOfWeek":5,"OpeningTime":"00:00:00"},{"ClosingTime":86340,"DayOfWeek":6,"OpeningTime":"00:00:00"}],"friendlyName":"physical-store-02","id":"02_Physical"}}],"paging":{"page":1,"pageSize":30,"pages":1,"total":1}}}},"description":"OK"}},"security":[],"summary":"List pickup points by location","tags":["Fulfillment"]}},"/api/checkout/pub/postal-code/{countryCode}/{postalCode}":{"get":{"description":"Retrieves address information for a given postal code and country.\r\n\r\nThis request can be used to implement auto complete functionality when a customer needs to fill in an address.","operationId":"GetAddressByPostalCode","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Three letter country code refering to the `postalCode` field.","in":"path","name":"countryCode","required":true,"schema":{"default":"BRA","type":"string"},"style":"simple"},{"description":"Postal code.","in":"path","name":"postalCode","required":true,"schema":{"default":"1234000","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":{"city":"Rio de Janeiro","complement":"","country":"BRA","geoCoordinates":[],"neighborhood":"My neighborhood","number":"","postalCode":"12345000","reference":"","state":"RJ","street":"My street"}}},"description":"OK"}},"security":[],"summary":"Get address by postal code","tags":["Fulfillment"]}},"/api/checkout/pub/profiles":{"get":{"deprecated":false,"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. 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","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"Client's email address to be searched.","in":"query","name":"email","required":true,"schema":{"default":"clark.kent@examplemail.com","type":"string"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"availableAccounts":[],"availableAddresses":[{"addressId":"666c2e830bd9474ab6f6cc53fb6dd2d2","addressType":"residential","city":"Metropolis","complement":null,"country":"USA","geoCoordinates":[-47.924747467041016,-15.832582473754883],"isDisposable":false,"neighborhood":"My neighborhood","number":"123","postalCode":"12345-000","receiverName":"Clark Kent","reference":null,"state":"NY","street":"My street"}],"isComplete":true,"profileProvider":"VTEX","userProfile":{"corporateDocument":null,"corporateName":null,"corporatePhone":null,"customerClass":null,"document":"12345678900","documentType":"cpf","email":"clark.kent@example.com","firstName":"Clark","isCorporate":false,"lastName":"Kent","phone":"+556199999999","profileCompleteOnLoading":null,"profileErrorOnLoading":null,"stateInscription":null,"tradeName":null},"userProfileId":"fb542e51-5488-4c34-8d17-ed8fcf597a94"},"schema":{"properties":{"availableAccounts":{"description":"Available accounts.","items":{"type":"string"},"type":"array"},"availableAddresses":{"description":"Information on each available address.","items":{"properties":{"addressId":{"description":"Address ID.","type":"string"},"addressType":{"description":"Address type.","type":"string"},"city":{"description":"City of the address.","type":"string"},"complement":{"description":"Complement to the address.","nullable":true,"type":"string"},"country":{"description":"Country of the address. ISO three-letter code.","type":"string"},"geoCoordinates":{"description":"Array containing two floats with geocoordinates, first longitude, then latitude.","items":{"type":"number"},"type":"array"},"isDisposable":{"description":"Indicates whether address is disposable.","type":"boolean"},"neighborhood":{"description":"Neighborhood of the address.","type":"string"},"number":{"description":"Number of the address.","type":"string"},"receiverName":{"description":"Name of the receiver.","type":"string"},"reference":{"description":"Reference that may help in the location of the address.","nullable":true,"type":"string"},"state":{"description":"State of the address.","type":"string"},"street":{"description":"Street of the address.","type":"string"}},"type":"object"},"type":"array"},"isComplete":{"description":"Indicates whether customer profile is complete.","type":"boolean"},"profileProvider":{"description":"Profile provider.","type":"string"},"userProfile":{"description":"Customer profile information.","properties":{"corporateDocument":{"description":"Document. Used for corporate clients.","nullable":true,"type":"string"},"corporateName":{"description":"Name of the company. Used for corporate clients.","nullable":true,"type":"string"},"corporatePhone":{"description":"Telephone number. Used for corporate clients.","nullable":true,"type":"string"},"customerClass":{"description":"Customer class.","nullable":true,"type":"string"},"document":{"description":"Document.","type":"string"},"documentType":{"description":"Document type.","type":"string"},"email":{"description":"Email address.","type":"string"},"firstName":{"description":"First name.","type":"string"},"isCorporate":{"default":false,"description":"Indicates whether client is corporate.","type":"boolean"},"lastName":{"description":"Last name.","type":"string"},"phone":{"description":"Telephone number.","type":"string"},"profileCompleteOnLoading":{"description":"Profile complete when loading.","nullable":true,"type":"string"},"profileErrorOnLoading":{"description":"Profile error when loading.","nullable":true,"type":"string"},"stateInscription":{"description":"State inscription. Used for corporate clients.","nullable":true,"type":"string"},"tradeName":{"description":"Trade name. Used for corporate clients.","nullable":true,"type":"string"}},"type":"object"},"userProfileId":{"description":"Unique ID associated with the customer profile.","type":"string"}},"type":"object"}}},"description":"OK"}},"security":[],"summary":"Get client profile by email","tags":["Cart attachments"]}},"/api/checkout/pub/regions/{regionId}":{"get":{"description":"Retrieve a list of sellers that cater to a specific region or address, according to your set up of our [regionalization feature](https://help.vtex.com/en/tutorial/setting-up-price-and-availability-of-skus-by-region--12ne58BmvYsYuGsimmugoc#). Learn more about [Region v2](https://developers.vtex.com/vtex-developer-docs/changelog/region-v2).\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.","operationId":"GetSellersByRegion","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"ID of the region corresponding to the shopper's location.","in":"path","name":"regionId","required":true,"schema":{"example":"v2.1BB18CE648B5111D0933734ED83EC783","type":"string"},"style":"simple"},{"description":"Three letter country code refering to the `postalCode` field.","in":"query","name":"country","required":true,"schema":{"default":"BRA","type":"string"},"style":"form"},{"description":"Postal code corresponding to the shopper's location.","in":"query","name":"postalCode","required":false,"schema":{"default":"1234000","type":"string"},"style":"form"},{"description":"Geocoordinates (first longitude, semicolon, then latitude) corresponding to the shopper's location.","in":"query","name":"geoCoordinates","required":false,"schema":{"default":[-47.924747467041016,-15.832582473754883],"items":{"example":-47.924747467041016,"type":"number"},"type":"array"},"style":"form"}],"responses":{"200":{"content":{"application/json":{"example":{"id":"v2.1BB18CE648B5111D0933734ED83EC783","sellers":[{"id":"abacaba","logo":null,"name":"Abacaba Store"},{"id":"abacaba2","logo":null,"name":"Abacaba VTEX Outlet"},{"id":"abacaba3","logo":null,"name":"Abacaba VTEX Mall"}]},"schema":{"properties":{"id":{"description":"Region ID.","type":"string"},"sellers":{"description":"Array with information on each seller retrieved for the given region.","items":{"properties":{"id":{"description":"Seller ID.","type":"string"},"logo":{"description":"Seller logo.","nullable":true,"type":"string"},"name":{"description":"Seller name.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"}}},"description":"OK"}},"security":[],"summary":"Get sellers by region or address","tags":["Region"]}},"/api/checkout/pvt/configuration/orderForm":{"get":{"deprecated":false,"description":"Retrieves the settings that are currently applied to every orderForm in the account.\n\r\n\rThese settings are defined by the request [Update orderForm configuration](https://developers.vtex.com/reference/configuration#updateorderformconfiguration).\n\r\n\rAlways use this request to retrieve the current configuration before performing an update. By doing so you ensure that you are modifying only the properties you want.","operationId":"GetorderFormconfiguration","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"application/json":{"example":{"allowManualPrice":true,"allowMultipleDeliveries":false,"apps":[{"fields":["name","age"],"id":"abcd","major":1}],"decimalDigitsPrecision":2,"maskFirstPurchaseData":null,"maxNumberOfWhiteLabelSellers":null,"minimumQuantityAccumulatedForItems":1,"minimumValueAccumulated":null,"paymentConfiguration":{"allowInstallmentsMerge":null,"blockPaymentSession":null,"requiresAuthenticationForPreAuthorizedPaymentOption":false},"recaptchaValidation":"vtexCriteria","taxConfiguration":null},"schema":{}}},"description":"","headers":{}}},"summary":"Get orderForm configuration","tags":["Configuration"]},"post":{"deprecated":false,"description":"Determines settings that will apply to every orderForm in the account.\n\r\n\rFor example, if you create an app using this request, every orderForm of this account will have the custom fields created though it.\n\r\n\r**Important**: always retrieve the current configuration before performing an update to ensure that you are modifying only the properties you want. Otherwise, old values can be overwritten. To retrieve the current configuration, use the request [Get orderForm configuration](https://developers.vtex.com/reference#getorderformconfiguration).","operationId":"UpdateorderFormconfiguration","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"example":{"allowManualPrice":null,"allowMultipleDeliveries":null,"apps":null,"decimalDigitsPrecision":2,"minimumQuantityAccumulatedForItems":1,"minimumValueAccumulated":null,"paymentConfiguration":{"requiresAuthenticationForPreAuthorizedPaymentOption":false},"taxConfiguration":null},"schema":{"$ref":"#/components/schemas/UpdateorderFormconfigurationRequest"}}},"description":"","required":true},"responses":{"204":{"description":"","headers":{}}},"summary":"Update orderForm configuration","tags":["Configuration"]}},"/api/checkout/pvt/configuration/window-to-change-seller":{"get":{"deprecated":false,"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":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"text/plain":{"example":"2"}},"description":"OK"}},"summary":"Get window to change seller","tags":["Configuration"]},"post":{"deprecated":false,"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":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"}],"requestBody":{"content":{"application/json":{"example":{"waitingTime":4},"schema":{"$ref":"#/components/schemas/WaitingTime"}}},"description":"","required":true},"responses":{"201":{"description":"Created","headers":{}}},"summary":"Update window to change seller","tags":["Configuration"]}},"/checkout/changeToAnonymousUser/{orderFormId}":{"get":{"deprecated":false,"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","parameters":[{"description":"Type of the content being sent.","in":"header","name":"Content-Type","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.","in":"header","name":"Accept","required":true,"schema":{"default":"application/json","type":"string"},"style":"simple"},{"description":"ID of the orderForm corresponding to the cart whose user's personal data you want to remove.","in":"path","name":"orderFormId","required":true,"schema":{"default":"ede846222cd44046ba6c638442c3505a","type":"string"},"style":"simple"}],"responses":{"200":{"content":{"text/plain":{"example":{},"schema":{"type":"object"}}},"description":"OK"}},"security":[],"summary":"Remove all personal data","tags":["Shopping cart"]}}},"components":{"schemas":{"Item":{"example":{"id":"{{skuId}}","quantity":1,"seller":"1"},"properties":{"id":{"description":"The SKU ID.","type":"string"},"quantity":{"description":"The quantity of items of this specific SKU in the cart to be simulated.","format":"int32","type":"integer"},"seller":{"description":"The ID of the seller responsible for this SKU. This ID can be found in your VTEX Admin.","type":"string"}},"required":["id","quantity","seller"],"title":"Item","type":"object"},"OrderFormSimulationRequest":{"example":{"country":"{{countryCode-ISO-3-digits}}","items":[{"id":"{{skuId}}","quantity":1,"seller":"1"}]},"properties":{"country":{"type":"string"},"items":{"description":"Array containing information about the SKUs inside the cart to be simulated.","items":{"$ref":"#/components/schemas/Item"},"type":"array"}},"required":["items","country"],"type":"object"},"PaymentConfiguration":{"description":"Payment Configuration object","example":{"allowInstallmentsMerge":false,"requiresAuthenticationForPreAuthorizedPaymentOption":false},"properties":{"allowInstallmentsMerge":{"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.","type":"boolean"},"requiresAuthenticationForPreAuthorizedPaymentOption":{"description":"Determines whether pre-authorized payments require authentication","type":"boolean"}},"required":["requiresAuthenticationForPreAuthorizedPaymentOption"],"title":"PaymentConfiguration","type":"object"},"PriceChangeRequest":{"example":{"price":10000},"properties":{"price":{"description":"The new price of the item.","format":"int32","type":"integer"}},"required":["price"],"type":"object"},"SetsinglecustomfieldvalueRequest":{"properties":{"value":{"description":"The value you want to set to the specified field.","type":"string"}},"required":["value"],"type":"object"},"UpdateorderFormconfigurationRequest":{"example":{"allowManualPrice":null,"allowMultipleDeliveries":null,"apps":null,"decimalDigitsPrecision":2,"minimumQuantityAccumulatedForItems":1,"minimumValueAccumulated":null,"paymentConfiguration":{"requiresAuthenticationForPreAuthorizedPaymentOption":false},"taxConfiguration":null},"properties":{"allowManualPrice":{"description":"Allows the editing of SKU prices right in the cart.","nullable":true,"type":"boolean"},"allowMultipleDeliveries":{"description":"On the same purchase, allows the selection of items from multiple delivery channels.","nullable":true,"type":"boolean"},"apps":{"description":"Array of objects containing Apps configuration information.","items":{"properties":{"fields":{"description":"Array of fields available to the app.","items":{"example":"birthdayField","type":"string"},"type":"array"},"id":{"description":"App ID.","example":"birthdayApp","type":"string"},"major":{"description":"App major version.","example":1,"type":"integer"}},"type":"object"},"nullable":true,"type":"array"},"decimalDigitsPrecision":{"description":"Number of price digits.","format":"int32","type":"integer"},"maskFirstPurchaseData":{"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.","type":"boolean"},"maxNumberOfWhiteLabelSellers":{"description":"Allows the input of a limit of white label sellers involved on the cart.","type":"integer"},"minimumQuantityAccumulatedForItems":{"description":"Minimum SKU quantity by cart.","format":"int32","type":"integer"},"minimumValueAccumulated":{"description":"Minimum cart value.","nullable":true,"type":"integer"},"paymentConfiguration":{"$ref":"#/components/schemas/PaymentConfiguration"},"paymentSystemToCheckFirstInstallment":{"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","type":"string"},"recaptchaValidation":{"default":"vtexCriteria","description":"Configures reCAPTCHA validation for the account, defining in which situations the shopper will be prompted to validate a purchase with reCAPTCHA. Learn more about [reCAPTCHA validation for VTEX stores](https://help.vtex.com/tutorial/recaptcha-no-checkout--18Te3oDd7f4qcjKu9jhNzP)\n\r\n\rPossible values are:\n\r- `\"never\"`: no purchases are validated with reCAPTCHA.\n\r- `\"always\"`: every purchase is validated with reCAPTCHA.\n\r- `\"vtexCriteria\"`: only some purchases are validated with reCAPTCHA in order to minimize friction and improve shopping experience. VTEX’s algorithm determines which sessions are trustworthy and which should be validated with reCAPTCHA. This is the recommended option.","type":"string"},"taxConfiguration":{"description":"External tax service configuration.","nullable":true,"properties":{"appId":{"description":"Custom data ID sent to the tax system.","type":"string"},"authorizationHeader":{"description":"Authorization header.","nullable":true,"type":"string"},"url":{"description":"Endpoint URL.","nullable":true,"type":"string"}},"type":"object"}},"required":["paymentConfiguration","taxConfiguration","minimumQuantityAccumulatedForItems","decimalDigitsPrecision","minimumValueAccumulated","apps","allowMultipleDeliveries","allowManualPrice"],"type":"object"},"WaitingTime":{"properties":{"waitingTime":{"description":"Number of days after order cancelation by a seller, during which another seller may be assigned to fulfill the order.","type":"integer"}},"required":["waitingTime"],"type":"object"}},"securitySchemes":{"appKey":{"in":"header","name":"X-VTEX-API-AppKey","type":"apiKey"},"appToken":{"in":"header","name":"X-VTEX-API-AppToken","type":"apiKey"}}}}