openapi-directory/api/vtex.local/Checkout-API.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"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":"