openapi: 3.0.0 info: title: VTex Anti-fraud Provider Account Shopping Cart API description: ">ℹ️ Onboarding guide\r\n>\r\n> Check the new [Payments onboarding guide](https://developers.vtex.com/docs/guides/payments-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey.\r\n\r\nThe Anti-fraud Provider Protocol is a set of definitions to help you integrate your anti-fraud service API into VTEX platform.\r\n\r\nTo achieve this, you need to implement a web API (REST) following the specifications described in this documentation.\r\n\r\n>⚠️ You can also access our [template on GitHub](https://github.com/vtex-apps/antifraud-provider-example) to help you quickly develop your anti-fraud connector using the Anti-fraud Provider Protocol and VTEX IO.\r\n\r\nTo learn more about the Anti-fraud Provider Protocol, check our [developer guide](https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works).\r\n\r\n## Anti-fraud Provider API Index\r\n\r\n### Anti-fraud Flow\r\n\r\n- `POST` [Send Anti-fraud Pre-Analysis Data (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/pre-analysis)\r\n- `POST` [Send Anti-fraud Data](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/transactions)\r\n- `PUT` [Update Anti-fraud Transactions (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#put-/transactions/-transactionId-)\r\n- `GET` [List Anti-fraud Provider Manifest](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/manifest)\r\n- `GET` [Get Anti-fraud Status](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/transactions/-transactions.id-)\r\n- `DELETE` [Stop Anti-fraud Analysis (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#delete-/transactions/-transactions.Id-)\r\n\r\n### OAuth Flow\r\n\r\n1. `POST` [Retrieve Token](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/authorization/token)\r\n2. `GET` [Redirect](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/redirect)\r\n3. `GET` [Return to VTEX](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorizationCode)\r\n4. `GET` [Get Credentials](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorization/credentials)" version: '1.0' servers: - url: https://{providerApiEndpoint} description: Anti-fraud provider endpoint URL. variables: providerApiEndpoint: description: Anti-fraud provider endpoint URL. default: '{providerApiEndpoint}' tags: - name: Shopping Cart paths: /api/checkout/pub/orderForms/simulation: post: tags: - Shopping Cart summary: VTex Cart simulation description: "This endpoint is used to simulate a cart in VTEX Checkout.\r\n\r\nIt receives an SKU ID, the quantity of items in the cart and the seller ID.\r\n\r\nIt returns all information about the cart, such as the selling price of each item, pricing and promotion data, payment and logistics info.\r\n\r\nThis request is useful whenever you need to know the availability of fulfilling an order for a specific cart setting, since the API response will let you know the updated price, inventory and shipping data.\r\n\r\n>⚠️ The fields (`sku id`, `quantity`, `seller`, `country`, `postalCode` and `geoCoordinates`) are just examples of content that you can simulate in your cart. You can add more fields to the request as per your need. Access the [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) guide to check the available fields.\r\n\r\n## Permissions\r\n\r\nThis endpoint does not require [authentication](https://developers.vtex.com/docs/guides/authentication) or [permissions](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3)." operationId: CartSimulation security: [] parameters: - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' - name: RnbBehavior in: query description: "This parameter defines which promotions apply to the simulation. Use `0` for simulations at cart stage, which means all promotions apply. In case of window simulation use `1`, which indicates promotions that apply nominal discounts over the total purchase value shouldn't be considered on the simulation.\n\r\n\rNote that if this not sent, the parameter is `1`." required: false style: form schema: type: integer example: 0 - name: sc in: query description: Trade Policy (Sales Channel) identification. required: false style: form schema: type: integer example: 1 requestBody: content: application/json: schema: type: object required: - id - quantity - seller properties: items: type: array description: Array containing information about the SKUs inside the cart to be simulated. items: type: object description: SKU information. properties: id: type: string description: The SKU ID. example: '1' quantity: type: integer format: int32 description: The quantity of items of this specific SKU in the cart to be simulated. example: 1 seller: type: string description: The ID of the seller responsible for this SKU. This ID can be found in your VTEX Admin. example: '1' country: type: string description: Three letter ISO code of the country of the shipping address. This value must be sent along with the `postalCode` or `geoCoordinates` values. example: BRA postalCode: type: string description: Postal code. example: 12345-000 geoCoordinates: type: array description: Array containing two floats with geocoordinates, first longitude, then latitude. example: - -47.924747467041016 - -15.832582473754883 items: description: Geocoordinates. type: number example: -47.924747467041016 responses: '200': description: OK content: application/json: schema: type: object properties: items: type: array description: Information on each item in the cart. items: type: object description: Object containing information of the item. properties: id: type: string description: ID of the item. requestIndex: type: integer description: Request index information. quantity: type: integer description: The quantity of the item the cart. seller: type: string description: The seller responsible for the SKU. sellerChain: type: array description: Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order. items: type: string description: Seller. tax: type: integer description: Tax value in cents. taxCode: type: string description: A unique identifier code assigned to a tax within the VTEX Admin. priceValidUntil: type: string description: Price expiration date and time. price: type: integer description: Price in cents. listPrice: type: integer description: List price in cents. rewardValue: type: integer description: Reward value in cents. sellingPrice: type: integer description: Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead. offerings: type: array description: Array containing offering information of SKU service. A service is an item that may come with a product, optionally and with cost. It is used to assign a value of an additional service itself to an SKU. items: type: object description: Service general information. properties: type: type: string description: Service type. id: type: string description: Service type ID. name: type: string description: Name of the service type. allowGiftMessage: type: boolean description: Option to display the service type on the gift card. attachmentOfferings: type: array description: Array of attachments that will be added to the service type. The attachment is used to add customized information to the service. items: type: string description: Attachment of the product. price: type: integer description: Service type price. priceTags: type: array description: Array of price tags, each of which, modifies the price in some way, like discounts or rates that apply to the item in the context of the order. items: type: object description: Price tag information. properties: name: type: string description: Price tag name. value: type: integer description: Price tag value. rawValue: type: integer description: Price tag raw value. isPercentual: type: boolean description: Indicates whether price tag value is applied through a percentage. identifier: type: string description: Price tag identifier. nullable: true owner: type: string description: Identification of the responsible for the price tag. measurementUnit: type: string description: Measurement unit. unitMultiplier: type: integer description: Unit multiplier. parentItemIndex: type: integer description: Parent item index. nullable: true parentAssemblyBinding: type: string description: Parent assembly binding. nullable: true availability: type: string description: Availability. priceDefinition: type: object description: Price information for all units of a specific item. properties: calculatedSellingPrice: type: integer description: Item's calculated unitary selling price in cents. total: type: integer description: Total value for all units of the item in cents. sellingPrices: type: array description: Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total. items: type: object description: Item value and rounding quantity. properties: value: type: integer description: Value in cents for that specific rounding. quantity: type: integer description: Rounding quantity, meaning how many items are rounded to this value. ratesAndBenefitsData: type: object description: Information on pricing and promotions that apply to the order. properties: rateAndBenefitsIdentifiers: type: array description: List with pricing and promotions identifiers. items: type: string description: Promotion identifier. teaser: type: array description: List with pricing and promotions teaser. items: type: string description: Promotion teaser. paymentData: type: object description: Payment data information. properties: installmentOptions: type: array description: List of Installment options. items: type: object description: Information about the installment option. properties: paymentSystem: type: integer description: Payment system identification. bin: type: string description: Card bin. nullable: true paymentName: type: string description: Payment name. nullable: true paymentGroupName: type: string description: Payment group name. nullable: true value: type: integer description: Total value assigned to this payment. installments: type: array description: Installment information. items: type: object description: Installment information. properties: count: type: integer description: Count information. hasInterestRate: type: boolean description: Indicates whether the payment has interest. interestRate: type: integer description: Interest rate value. value: type: integer description: Value of the order without the interest rate. The value is shown without separating cents. total: type: integer description: Total value of the order without separating cents. For example, $24.99 is represented `2499`. sellerMerchantInstallments: type: array description: Seller merchant installments information. items: type: object description: Installment information. paymentSystems: type: array description: Information on payment systems. items: type: object description: Payment system information. properties: id: type: integer description: Payment system ID. name: type: string description: Payment system name. groupName: type: string description: Payment group name. validator: type: object description: Payment system validator. nullable: true stringId: type: string description: String ID. template: type: string description: Template. requiresDocument: type: boolean description: Indicates whether a document is required. displayDocument: type: boolean description: Indicates whether a document is shown. isCustom: type: boolean description: Indicates whether it is custom. description: type: string description: Description. requiresAuthentication: type: boolean description: Indicates whether a authentication is required. dueDate: type: string description: Payment due date. availablePayments: type: string description: Availability of payment. nullable: true payments: type: array description: Information on each payment. items: type: string description: Payment information. giftCards: type: array description: Gift card information, if it applies to the order. items: type: string description: Gift card. giftCardMessages: type: array description: Array of gift card messages. items: type: string description: Gift card message. availableAccounts: type: array description: Available accounts. items: type: string description: Available account. availableTokens: type: array description: Available tokens. items: type: string description: Available token. availableAssociations: type: object description: Available associations. selectableGifts: type: array description: Array containing the data of the items selected as a gift. items: type: string description: Selected gift item. marketingData: type: object description: Object containing promotion data such as coupon tracking information and internal or external UTMs. nullable: true postalCode: type: string description: Postal code. nullable: true country: type: string description: Three letter ISO code of the country of the shipping address. logisticsInfo: type: array description: Array with logistics information on each item of the `items` array in the `orderForm`. items: description: Logistics information of a item. type: object properties: itemIndex: type: integer description: Index of item in items array. addressId: type: string description: Address ID. nullable: true selectedSla: type: string description: Selected SLA. For example, `"normal"` or `"express"`. nullable: true selectedDeliveryChannel: type: string description: Delivery channel selected by the customer. For example, `"delivery"` or `"pickup-in-point"`. nullable: true quantity: type: integer description: Quantity. shipsTo: type: array description: List of countries that the item may be shipped to. items: type: string example: Brazil description: Country that the item may be shipped to. slas: type: array description: Information on available SLAs. items: description: SLA information. type: object properties: id: type: string description: SLA ID. deliveryChannel: type: string description: Delivery channel. name: type: string description: SLA name. deliveryIds: type: array description: Information on each delivery ID. items: type: object description: Object with delivery infomation. properties: courierId: type: string description: Courier ID. warehouseId: type: string description: Warehouse ID. dockId: type: string description: Warehouse ID. courierName: type: string description: Courier name. quantity: type: integer description: Quantity. shippingEstimate: type: string description: Shipping estimate. For instance, "three business days" will be represented as `3bd`. shippingEstimateDate: type: string description: Shipping estimate date. nullable: true lockTTL: type: string description: Estimate date of delivery. nullable: true availableDeliveryWindows: type: object description: This object contains information about the delivery window available to the shopper. properties: startDateUtc: type: string description: Delivery window starting day and time in UTC. endDateUtc: type: string description: Delivery window ending day and time in UTC. price: type: integer description: Delivery window price. lisPrice: type: integer description: Delivery window list price. tax: type: integer description: Delivery window tax. deliveryWindow: type: object description: In case of scheduled delivery, this object will contain information on the delivery window selected by the shopper. properties: startDateUtc: type: string description: Delivery window starting day and time in UTC. endDateUtc: type: string description: Delivery window ending day and time in UTC. price: type: integer description: Delivery window price. lisPrice: type: integer description: Delivery window list price. tax: type: integer description: Delivery window tax. price: type: integer description: Price in cents. listPrice: type: integer description: List price in cents. tax: type: integer description: Tax in cents. pickupStoreInfo: type: object description: Information on the pickup store. properties: isPickupStore: type: boolean description: Indicates whether it is the pickup store. friendlyName: type: string description: Friendly name. nullable: true address: type: object description: Address information. nullable: true additionalInfo: type: string description: Additional information. nullable: true dockId: type: string description: Corresponding dock ID. nullable: true pickupPointId: type: string description: Pickup point ID. nullable: true pickupDistance: type: integer description: Pickup point distance. polygonName: type: string description: Polygon name. nullable: true transitTime: type: string description: Transit time. For instance, "three business days" is represented as `3bd`. deliveryChannels: type: array description: List of available delivery channels. items: type: object description: Object containing delivery channel ID. properties: id: type: string description: Delivery channel ID. messages: type: array description: Array containing an object for each message generated by our servers while processing the request. items: type: string description: Message. purchaseConditions: type: object description: Purchase conditions information. properties: itemPurchaseConditions: type: array description: List of objects containing purchase condition information on each item in the order. items: type: object description: Purchase condition information. properties: id: type: string description: Item ID. seller: type: string description: Seller. sellerChain: type: array description: Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order. items: type: string description: Seller ID. slas: type: array description: Information on available SLAs. items: type: object description: SLA information. properties: id: type: string description: SLA ID. deliveryChannel: type: string description: Delivery channel. name: type: string description: SLA name. deliveryIds: type: array description: Information on each delivery ID. items: type: object description: Object with delivery inforamtion. properties: courierId: type: string description: Courier ID. warehouseId: type: string description: Warehouse ID. dockId: type: string description: Warehouse ID. courierName: type: string description: Courier name. quantity: type: integer description: Quantity. shippingEstimate: type: string description: Shipping estimate. For instance, "three business days" will be represented as `3bd`. shippingEstimateDate: type: string description: Shipping estimate date. nullable: true lockTTL: type: string description: Estimate date of delivery. nullable: true availableDeliveryWindows: type: object description: This object contains information about the delivery window available to the shopper. properties: startDateUtc: type: string description: Delivery window starting day and time in UTC. endDateUtc: type: string description: Delivery window ending day and time in UTC. price: type: integer description: Delivery window price. lisPrice: type: integer description: Delivery window list price. tax: type: integer description: Delivery window tax. deliveryWindow: type: object description: In case of scheduled delivery, this object will contain information on the delivery window selected by the shopper. properties: startDateUtc: type: string description: Delivery window starting day and time in UTC. endDateUtc: type: string description: Delivery window ending day and time in UTC. price: type: integer description: Delivery window price. lisPrice: type: integer description: Delivery window list price. tax: type: integer description: Delivery window tax. price: type: integer description: Price in cents. listPrice: type: integer description: List price in cents. tax: type: integer description: Tax in cents. pickupStoreInfo: type: object description: Information on the pickup store. properties: isPickupStore: type: boolean description: Indicates whether it is the pickup store. friendlyName: type: string description: Friendly name. nullable: true address: type: object description: Address information. nullable: true additionalInfo: type: string description: Additional information. nullable: true dockId: type: string description: Corresponding dock ID. nullable: true pickupPointId: type: string description: Pickup point ID. nullable: true pickupDistance: type: integer description: Pickup point distance. polygonName: type: string description: Polygon name. nullable: true transitTime: type: string description: Transit time. For instance, "three business days" is represented as `3bd`. price: type: integer description: Price in cents. listPrice: type: integer description: List price in cents. pickupPoints: type: array description: Array containing pickup points information. items: type: string description: Pickup points. subscriptionData: type: object description: Subscription information. nullable: true totals: type: array description: Information on order totals. items: type: object description: Order information. properties: id: type: string description: Total ID. name: type: string description: Total name. value: type: integer description: Total value. itemMetadata: type: object description: Item metadata. properties: items: type: array description: List of objects containing metadata on each item in the order. items: type: object description: Object containing item metadata. properties: id: type: string description: Item ID. seller: type: string description: Seller. assemblyOptions: type: array description: Assembly options information. items: type: string description: Assembly option. properties: id: type: string description: Item ID. name: type: string description: Item name. required: type: boolean description: Indicates whether the item is required. inputValues: type: object description: Input values information. composition: type: string description: Composition information. nullable: true example: items: - id: '1' requestIndex: 0 quantity: 1 seller: '1' sellerChain: - '1' tax: 0 taxCode: 54WC8ZN6K8 priceValidUntil: '2023-07-12T11:49:01Z' price: 9999 listPrice: 9999 rewardValue: 0 sellingPrice: 2999700 offerings: - type: removal of additional old appliance id: '1' name: removal of additional old appliance allowGiftMessage: false attachmentOfferings: [] price: 2999 priceTags: - name: DISCOUNT@MANUALPRICE value: -5000 rawValue: -50 isPercentual: false identifier: 1234abc-5678b-1234c measurementUnit: un unitMultiplier: 300 parentItemIndex: null parentAssemblyBinding: null availability: available priceDefinition: calculatedSellingPrice: 2999700 total: 2999700 sellingPrices: - value: 2999700 quantity: 1 ratesAndBenefitsData: rateAndBenefitsIdentifiers: [] teaser: [] paymentData: installmentOptions: - paymentSystem: 2 bin: null paymentName: Visa paymentGroupName: creditCardPaymentGroup value: 2999700 installments: - count: 1 hasInterestRate: false interestRate: 0 value: 2999700 total: 2999700 sellerMerchantInstallments: - id: LOJADOBRENO count: 1 hasInterestRate: false interestRate: 0 value: 2999700 total: 2999700 - paymentSystem: 6 bin: null paymentName: Boleto Bancário paymentGroupName: bankInvoicePaymentGroup value: 2999700 installments: - count: 1 hasInterestRate: false interestRate: 0 value: 2999700 total: 2999700 sellerMerchantInstallments: - id: LOJADOBRENO count: 1 hasInterestRate: false interestRate: 0 value: 2999700 total: 2999700 - paymentSystem: 127 bin: null paymentName: MercadoPagoPro paymentGroupName: MercadoPagoProPaymentGroup value: 2999700 installments: - count: 1 hasInterestRate: false interestRate: 0 value: 2999700 total: 2999700 sellerMerchantInstallments: - id: LOJADOBRENO count: 1 hasInterestRate: false interestRate: 0 value: 2999700 total: 2999700 - paymentSystem: 202 bin: null paymentName: Dinheiro paymentGroupName: custom202PaymentGroupPaymentGroup value: 2999700 installments: - count: 1 hasInterestRate: false interestRate: 0 value: 2999700 total: 2999700 sellerMerchantInstallments: - id: LOJADOBRENO count: 1 hasInterestRate: false interestRate: 0 value: 2999700 total: 2999700 paymentSystems: - id: 202 name: Dinheiro groupName: custom202PaymentGroupPaymentGroup validator: regex: ^4[0-9]{15}$ mask: 9999 9999 9999 9999 cardCodeRegex: ^[0-9]{3}$ cardCodeMask: '999' weights: - 2 - 1 - 2 - 1 - 2 useCvv: true useExpirationDate: true useCardHolderName: true useBillingAddress: true stringId: '202' template: custom202PaymentGroupPaymentGroup-template requiresDocument: false displayDocument: false isCustom: true description: Payment description requiresAuthentication: false dueDate: '2022-07-22T11:39:36.37197Z' availablePayments: null - id: 6 name: Boleto Bancário groupName: bankInvoicePaymentGroup validator: regex: ^4[0-9]{15}$ mask: 9999 9999 9999 9999 cardCodeRegex: ^[0-9]{3}$ cardCodeMask: '999' weights: - 2 - 1 - 2 - 1 - 2 useCvv: true useExpirationDate: true useCardHolderName: true useBillingAddress: true stringId: '6' template: bankInvoicePaymentGroup-template requiresDocument: false displayDocument: false isCustom: false description: Payment description requiresAuthentication: false dueDate: '2022-07-19T11:39:36.37197Z' availablePayments: null - id: 2 name: Visa groupName: creditCardPaymentGroup validator: regex: ^4[0-9]{15}$ mask: 9999 9999 9999 9999 cardCodeRegex: ^[0-9]{3}$ cardCodeMask: '999' weights: - 2 - 1 - 2 - 1 - 2 useCvv: true useExpirationDate: true useCardHolderName: true useBillingAddress: true stringId: '2' template: creditCardPaymentGroup-template requiresDocument: false displayDocument: false isCustom: false description: Payment description requiresAuthentication: false dueDate: '2022-07-19T11:39:36.37197Z' availablePayments: null - id: 127 name: MercadoPagoPro groupName: MercadoPagoProPaymentGroup validator: regex: ^4[0-9]{15}$ mask: 9999 9999 9999 9999 cardCodeRegex: ^[0-9]{3}$ cardCodeMask: '999' weights: - 2 - 1 - 2 - 1 - 2 useCvv: true useExpirationDate: true useCardHolderName: true useBillingAddress: true stringId: '127' template: MercadoPagoProPaymentGroup-template requiresDocument: false displayDocument: false isCustom: false description: Payment description requiresAuthentication: false dueDate: '2022-07-19T11:39:36.37197Z' availablePayments: null payments: - paymentSystem: 6 bin: null accountId: '12' tokenId: null value: 34390 referenceValue: 34390 giftCardRedemptionCode: null giftCardProvider: null giftCardId: null giftCards: [] giftCardMessages: [] availableAccounts: [] availableTokens: [] availableAssociations: {} selectableGifts: [] marketingData: utmSource: app utmMedium: CPC utmCampaign: Black friday utmipage: 'true' utmiPart: 'true' utmiCampaign: 'true' coupon: blackfriday marketingTags: - tag1 - tag2 country: BRA postalCode: 12345-000 geoCoordinates: - -47.924747467041016 - -15.832582473754883 logisticsInfo: - itemIndex: 0 addressId: 666c2e830bd9474ab6f6cc53fb6dd2d2 selectedSla: Normal selectedDeliveryChannel: delivery quantity: 1 shipsTo: - BRA slas: - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] shippingEstimate: 3bd shippingEstimateDate: null lockTTL: 10d availableDeliveryWindows: startDateUtc: '2017-03-27T00:00:00+00:00' endDateUtc: '2017-03-27T00:00:00+00:00' price: 0 lisPrice: 0 tax: 0 deliveryWindow: startDateUtc: '2014-04-21T09:00:00+00:00' endDateUtc: '2014-04-21T12:00:00+00:00' price: 0 listprice: 1000 tax: 0 price: 1500 listPrice: 1500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: null address: null additionalInfo: null dockId: null pickupPointId: null pickupDistance: 0 polygonName: null transitTime: 3bd deliveryChannels: - id: pickup-in-point - id: delivery messages: [] purchaseConditions: itemPurchaseConditions: - id: '1' seller: '1' sellerChain: - '1' slas: - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] shippingEstimate: 3bd shippingEstimateDate: null lockTTL: 10d availableDeliveryWindows: startDateUtc: '2017-03-27T00:00:00+00:00' endDateUtc: '2017-03-27T00:00:00+00:00' price: 0 lisPrice: 0 tax: 0 deliveryWindow: startDateUtc: '2014-04-21T09:00:00+00:00' endDateUtc: '2014-04-21T12:00:00+00:00' price: 0 listprice: 1000 tax: 0 price: 1500 listPrice: 1500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: null address: null additionalInfo: null dockId: null pickupPointId: null pickupDistance: 0 polygonName: null transitTime: 3bd price: 9999 listPrice: 9999 pickupPoints: [] subscriptionData: null totals: - id: Items name: Total dos Itens value: 2999700 itemMetadata: items: - id: '1' seller: '1' assemblyOptions: - id: T-Shirt Customization name: T-Shirt Customization required: false inputValues: T-Shirt Name: maximumNumberOfCharacters: 2 domain: - '[]' composition: null deprecated: false /api/checkout/pub/orderForm: get: tags: - Shopping Cart summary: VTex Get current or create a new cart description: "You can use this request to get your current shopping cart information (`orderFormId`) or to create a new cart.\r\n\r\n**Important**: To create a new empty shopping cart you need to send this request with the query param `forceNewCart=true`.\r\n\r\nThe [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` obtained in response is the identification code of the newly created cart.\n\r\n\r> This request has a time out of 45 seconds.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations." operationId: CreateANewCart security: [] parameters: - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' - name: forceNewCart in: query description: Use this query parameter to create a new empty shopping cart. required: false style: form schema: type: boolean example: true responses: '200': description: OK content: application/json: example: orderFormId: 9ceee0fde6db489fbc682a0e2ab13a86 salesChannel: '1' loggedIn: false isCheckedIn: false storeId: '1' checkedInPickupPointId: '21' allowManualPrice: false canEditData: true userProfileId: fb542e51-5488-4c34-8d17-ed8fcf597a94 userType: User type ignoreProfileData: false value: 0 messages: [] items: [] selectableGifts: [] totalizers: [] shippingData: null clientProfileData: email: clark.kent@examplemail.com firstName: Clark lastName: Kent document: '12345678900' documentType: cpf phone: '+5500123456789' corporateName: company-name tradeName: trade-name corporateDocument: '12345678000100' stateInscription: '12345678' corporatePhone: '551100988887777' isCorporate: false profileCompleteOnLoading: false profileErrorOnLoading: false customerClass: null paymentData: installmentOptions: [] paymentSystems: [] payments: - paymentSystem: 6 bin: null accountId: '12' tokenId: null value: 34390 referenceValue: 34390 giftCardRedemptionCode: null giftCardProvider: null giftCardId: null giftCards: [] giftCardMessages: [] availableAccounts: [] availableTokens: [] marketingData: null sellers: [] clientPreferencesData: locale: pt-BR optinNewsLetter: null commercialConditionData: null storePreferencesData: countryCode: BRA saveUserData: true timeZone: E. South America Standard Time currencyCode: BRL currencyLocale: 1046 currencySymbol: R$ currencyFormatInfo: currencyDecimalDigits: 2 currencyDecimalSeparator: ',' currencyGroupSeparator: . currencyGroupSize: 3 startsWithCurrencySymbol: true giftRegistryData: null openTextField: null invoiceData: null customData: null itemMetadata: items: - id: '1' seller: '1' name: Ração Royal Canin Feline Urinary 500g skuName: Ração Royal Canin Feline Urinary 500g productId: '1' refId: '0001' ean: '123456789' imageUrl: http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000 detailUrl: /racao-royal-canin-feline-urinary/p assemblyOptions: [] hooksData: null ratesAndBenefitsData: rateAndBenefitsIdentifiers: [] teaser: [] subscriptionData: null itemsOrdination: criteria: NAME ascending: true schema: $ref: '#/components/schemas/orderForm' deprecated: false /api/checkout/pub/orderForm/{orderFormId}: get: tags: - Shopping Cart summary: VTex Get cart information by ID description: "Retrieves all information associated to a given shopping cart.\r\n\r\nThe [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.\n\r\n\r> This request has a time out of 45 seconds.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | Checkout | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations." operationId: GetCartInformationById security: [] parameters: - name: orderFormId in: path description: ID of the orderForm corresponding to the cart whose information you want to retrieve. required: true style: simple schema: type: string example: ede846222cd44046ba6c638442c3505a - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' - name: refreshOutdatedData in: query description: It is possible to use the [Update cart items request](https://developers.vtex.com/vtex-rest-api/reference/cart-update#itemsupdate) so as to allow outdated information in the `orderForm`, which may improve performance in some cases. To guarantee that all cart information is updated, send this request with this parameter as `true`. We recommend doing this in the final stages of the shopping experience, starting from the checkout page. required: false style: form schema: type: boolean example: true responses: '200': description: OK content: application/json: example: orderFormId: ede846222cd44046ba6c638442c3505a salesChannel: '1' loggedIn: false isCheckedIn: false storeId: '1' checkedInPickupPointId: '21' allowManualPrice: false canEditData: true userProfileId: fb542e51-5488-4c34-8d17-ed8fcf597a94 userType: User type ignoreProfileData: false value: 15000 messages: [] items: - uniqueId: E0F2B7AF5CD74D668F1E27537206912C id: '1' productId: '1' productRefId: '1' refId: '0001' ean: '123456789' name: Ração Royal Canin Feline Urinary 500g skuName: Ração Royal Canin Feline Urinary 500g modalType: null parentItemIndex: null parentAssemblyBinding: null assemblies: [] priceValidUntil: '2021-02-27T14:59:00.8288784Z' tax: 0 taxCode: 54WC8ZN6K8 price: 15000 listPrice: 30000 manualPrice: null sellingPrice: 15000 rewardValue: 0 isGift: false additionalInfo: brandName: Royal Canin brandId: '2000000' offeringInfo: null offeringType: null offeringTypeId: null preSaleDate: null productCategoryIds: /1/10/ productCategories: '1': Alimentação '10': Ração Seca quantity: 1 seller: '1' sellerChain: - '1' imageUrl: http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000 detailUrl: /racao-royal-canin-feline-urinary/p components: [] bundleItems: [] attachments: [] attachmentOfferings: [] offerings: [] priceTags: [] availability: available measurementUnit: un unitMultiplier: 1 manufacturerCode: null selectableGifts: [] totalizers: - id: Items name: Total dos Itens value: 15000 shippingData: address: null logisticsInfo: - itemIndex: 0 selectedSla: Normal selectedDeliveryChannel: delivery addressId: 666c2e830bd9474ab6f6cc53fb6dd2d2 slas: [] shipsTo: - BRA itemId: '1' deliveryChannels: - id: pickup-in-point - id: delivery selectedAddresses: [] availableAddresses: [] pickupPoints: [] clientProfileData: email: clark.kent@examplemail.com firstName: Clark lastName: Kent document: '12345678900' documentType: cpf phone: '+5500123456789' corporateName: company-name tradeName: trade-name corporateDocument: '12345678000100' stateInscription: '12345678' corporatePhone: '551100988887777' isCorporate: false profileCompleteOnLoading: false profileErrorOnLoading: false customerClass: null paymentData: installmentOptions: - paymentSystem: 2 bin: null paymentName: null paymentGroupName: null value: 15000 installments: - count: 1 hasInterestRate: false interestRate: 0 value: 15000 total: 15000 sellerMerchantInstallments: - id: LOJADOBRENO count: 1 hasInterestRate: false interestRate: 0 value: 15000 total: 15000 - count: 2 hasInterestRate: false interestRate: 0 value: 7500 total: 15000 sellerMerchantInstallments: - id: LOJADOBRENO count: 2 hasInterestRate: false interestRate: 0 value: 7500 total: 15000 paymentSystems: - id: 2 name: Visa groupName: creditCardPaymentGroup validator: regex: ^2[1-8]{17}$ mask: 9999 9999 9999 9999 cardCodeRegex: ^[0-3]{8}$ cardCodeMask: '999' weights: - 2 - 1 - 2 - 1 - 2 - 1 useCvv: true useExpirationDate: true useCardHolderName: true useBillingAddress: true stringId: '2' template: creditCardPaymentGroup-template requiresDocument: false isCustom: false description: Payment description requiresAuthentication: false dueDate: '2020-03-05T14:59:00.7879306Z' availablePayments: null payments: - paymentSystem: 6 bin: null accountId: '12' tokenId: null value: 34390 referenceValue: 34390 giftCardRedemptionCode: null giftCardProvider: null giftCardId: null giftCards: [] giftCardMessages: [] availableAccounts: [] availableTokens: [] marketingData: null sellers: - id: '1' name: lojadobreno logo: Logo clientPreferencesData: locale: pt-BR optinNewsLetter: null commercialConditionData: null storePreferencesData: countryCode: BRA saveUserData: true timeZone: E. South America Standard Time currencyCode: BRL currencyLocale: 1046 currencySymbol: R$ currencyFormatInfo: currencyDecimalDigits: 2 currencyDecimalSeparator: ',' currencyGroupSeparator: . currencyGroupSize: 3 startsWithCurrencySymbol: true giftRegistryData: null openTextField: null invoiceData: null customData: null itemMetadata: items: - id: '1' seller: '1' name: Ração Royal Canin Feline Urinary 500g skuName: Ração Royal Canin Feline Urinary 500g productId: '1' refId: '0001' ean: '123456789' imageUrl: http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000 detailUrl: /racao-royal-canin-feline-urinary/p assemblyOptions: [] hooksData: null ratesAndBenefitsData: rateAndBenefitsIdentifiers: [] teaser: [] subscriptionData: null itemsOrdination: criteria: NAME ascending: true schema: $ref: '#/components/schemas/orderForm' deprecated: false /api/checkout/pub/orderForm/{orderFormId}/items/removeAll: post: tags: - Shopping Cart summary: VTex Remove all items from shopping cart description: "This request removes all items from a given cart, leaving it empty.\r\n\r\nYou must send an empty JSON in the body of the request.\r\n\r\nThe [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.\r\n\r\n>ℹ️ Request body must always be sent with empty value \"{ }\" in this endpoint.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Shopping Cart Full Access** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations." operationId: RemoveAllItems security: [] parameters: - name: orderFormId in: path description: ID of the orderForm corresponding to the cart whose items you want to remove. required: true style: simple schema: type: string example: ede846222cd44046ba6c638442c3505a - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' requestBody: content: application/json: schema: type: object description: This object must be empty. default: {} responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/orderForm' example: orderFormId: ede846222cd44046ba6c638442c3505a salesChannel: '1' loggedIn: false isCheckedIn: false storeId: '1' checkedInPickupPointId: '21' allowManualPrice: false canEditData: true userProfileId: fb542e51-5488-4c34-8d17-ed8fcf597a94 userType: User type ignoreProfileData: false value: 0 messages: [] items: [] selectableGifts: [] totalizers: [] shippingData: address: null logisticsInfo: [] selectedAddresses: [] availableAddresses: [] pickupPoints: [] clientProfileData: email: john.doe@google.com firstName: John lastName: Doe document: '769387308' documentType: dni phone: '+5491111223344' corporateName: company-name tradeName: trade-name corporateDocument: '12345678000100' stateInscription: '12345678' corporatePhone: '551100988887777' isCorporate: false profileCompleteOnLoading: false profileErrorOnLoading: false customerClass: null paymentData: installmentOptions: - paymentSystem: 2 bin: null paymentName: null paymentGroupName: null value: 15000 installments: - count: 1 hasInterestRate: false interestRate: 0 value: 15000 total: 15000 sellerMerchantInstallments: - id: LOJADOBRENO count: 1 hasInterestRate: false interestRate: 0 value: 15000 total: 15000 paymentSystems: - id: 4 name: Mastercard groupName: creditCardPaymentGroup validator: regex: ^((5(([1-2]|[5-5])[0-3]{8}|0((2|9)([0-2]{5}))|1(0(5((0|[4-8])[1-7]{6})|([2-3]|[1-9])[0-9]{6})|[1-9][0-9]{7})))|((508116)\d{4,10})|((502121)\d{4,10})|((589916)\d{4,10})|(2[0-9]{15})|(67[0-9]{14})|(506387)\d{4,10}) mask: 9999 9999 9999 9999 cardCodeRegex: ^[1-3]{9}$ cardCodeMask: '999' weights: - 2 - 1 - 2 - 1 - 2 useCvv: true useExpirationDate: true useCardHolderName: true useBillingAddress: true stringId: '4' template: creditCardPaymentGroup-template requiresDocument: false isCustom: false description: Payment description requiresAuthentication: false dueDate: '2020-03-05T14:23:23.8196668Z' availablePayments: null payments: - paymentSystem: 6 bin: null accountId: '12' tokenId: null value: 34390 referenceValue: 34390 giftCardRedemptionCode: null giftCardProvider: null giftCardId: null giftCards: [] giftCardMessages: [] availableAccounts: [] availableTokens: [] marketingData: null sellers: [] clientPreferencesData: locale: pt-BR optinNewsLetter: null commercialConditionData: null storePreferencesData: countryCode: BRA saveUserData: true timeZone: E. South America Standard Time currencyCode: BRL currencyLocale: 1046 currencySymbol: R$ currencyFormatInfo: currencyDecimalDigits: 2 currencyDecimalSeparator: ',' currencyGroupSeparator: . currencyGroupSize: 3 startsWithCurrencySymbol: true giftRegistryData: null openTextField: null invoiceData: null customData: null itemMetadata: items: [] hooksData: null ratesAndBenefitsData: rateAndBenefitsIdentifiers: [] teaser: [] subscriptionData: null itemsOrdination: criteria: NAME ascending: true deprecated: false /checkout/changeToAnonymousUser/{orderFormId}: get: tags: - Shopping Cart summary: VTex Remove all personal data from shopping cart description: "This call removes all user information, making a cart anonymous while leaving the items.\r\n\r\nThe [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure that represents a shopping cart and contains all information about it. Hence, the `orderFormId` is the identification code of a given cart.\r\n\r\nThis call works by creating a new orderForm, setting a new cookie, and returning a redirect 302 to the cart URL (`/checkout/#/orderform`).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Save OrderForm Configuration** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations." operationId: Removeallpersonaldata security: [] parameters: - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' - name: orderFormId in: path description: ID of the orderForm corresponding to the cart whose user's personal data you want to remove. required: true style: simple schema: type: string example: ede846222cd44046ba6c638442c3505a responses: '200': description: OK content: text/plain: schema: type: object description: Empty object. example: {} deprecated: false /api/checkout/pub/orderForm/{orderFormId}/items/update: post: tags: - Shopping Cart summary: VTex Update cart items description: "You can use this request to:\n\r\n\r1. Change the quantity of one or more items in a specific cart.\n\r2. Remove an item from the cart (by sending the `quantity` value = `0` in the request body).\r\n\r\n>ℹ️ To remove all items from the cart at the same time, use the [Remove all items](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pub/orderForm/-orderFormId-/items/removeAll?endpoint=post-/api/checkout/pub/orderForm/-orderFormId-/items/removeAll) endpoint.\r\n\r\nThe [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure that represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.\n\r\n\r> This request has a time out of 45 seconds.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations." operationId: ItemsUpdate security: [] parameters: - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' - name: orderFormId in: path description: ID of the `orderForm` corresponding to the cart whose items you want to update. required: true style: simple schema: type: string example: ede846222cd44046ba6c638442c3505a - name: allowedOutdatedData in: query description: "In order to optimize performance, this parameter allows some information to not be updated when there are changes in the minicart. For instance, if a shopper adds another unit of a given SKU to the cart, it may not be necessary to recalculate payment information, which could impact performance.\n\r\n\rThis array accepts strings and currently the only possible value is `”paymentData”`." required: false style: form schema: type: array example: - paymentData items: type: string description: Information that will not be updated when there are changes in the minicart. requestBody: content: application/json: schema: type: object properties: orderItems: type: array description: Array containing the cart items. Each object inside this array corresponds to a different item. items: type: object description: Cart item information. properties: quantity: type: integer format: int32 description: The quantity of the item in the cart. example: 3 index: type: integer description: The position of the item in the array. example: 0 required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/orderForm' example: orderFormId: ede846222cd44046ba6c638442c3505a salesChannel: '1' loggedIn: false isCheckedIn: false storeId: '1' allowManualPrice: false canEditData: true userProfileId: fb542e51-5488-4c34-8d17-ed8fcf597a94 profileProvider: VTEX availableAccounts: [] availableAddresses: - addressType: residential receiverName: Clark Kent addressId: 666c2e830bd9474ab6f6cc53fb6dd2d2 isDisposable: true postalCode: '70386000' city: Brasília state: DF country: BRA street: Rua da minha casa number: '123' neighborhood: Copacabana complement: 15º andar reference: null geoCoordinates: - -47.924747467041016 - -15.832582473754883 userType: User type ignoreProfileData: false value: 34390 messages: [] items: - uniqueId: 9D6E447B3FF64CEDA33B17C01379C119 id: '2' productId: '2' productRefId: '1' refId: CBC30L ean: null name: Chopp Brahma Claro 30L skuName: Chopp Brahma Claro 30L modalType: null parentItemIndex: null parentAssemblyBinding: null assemblies: [] priceValidUntil: '2022-07-13T18:30:46Z' tax: 0 taxCode: 54WC8ZN6K8 price: 32890 listPrice: 49900 manualPrice: null manualPriceAppliedBy: null sellingPrice: 32890 rewardValue: 0 isGift: false additionalInfo: dimension: null brandName: Brahma brandId: '2000000' offeringInfo: null offeringType: null offeringTypeId: null preSaleDate: null productCategoryIds: /1/ productCategories: '1': Bebidas quantity: 1 seller: '1' sellerChain: - '1' imageUrl: http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000 detailUrl: /chopp-brahma-claro-30l/p components: [] bundleItems: [] attachments: [] attachmentOfferings: [] offerings: [] priceTags: [] availability: available measurementUnit: un unitMultiplier: 1 manufacturerCode: null priceDefinition: calculatedSellingPrice: 32890 total: 32890 sellingPrices: - value: 32890 quantity: 1 selectableGifts: [] totalizers: - id: Items name: Total dos Itens value: 15000 shippingData: address: addressType: residential receiverName: Clark Kent addressId: teste isDisposable: true postalCode: '70386000' city: Brasília state: DF country: BRA street: Rua da minha casa number: '123' neighborhood: Copacabana complement: 15º andar reference: null geoCoordinates: - -47.924747467041016 - -15.832582473754883 logisticsInfo: - itemIndex: 0 selectedSla: Normal selectedDeliveryChannel: delivery addressId: teste slas: - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] shippingEstimate: 3bd shippingEstimateDate: null lockTTL: 10d availableDeliveryWindows: [] deliveryWindow: null price: 1500 listPrice: 1500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: null address: null additionalInfo: null dockId: null pickupPointId: null pickupDistance: 0 polygonName: null transitTime: 3bd shipsTo: - BRA - COL - USA itemId: '2' deliveryChannels: - id: delivery - id: pickup-in-point selectedAddresses: - addressType: residential receiverName: Clark Kent addressId: teste isDisposable: true postalCode: '12345000' city: Rio de Janeiro state: RJ country: BRA street: Rua da minha casa number: '123' neighborhood: Copacabana complement: 15º andar reference: null geoCoordinates: - -47.924747467041016 - -15.832582473754883 availableAddresses: - addressType: residential receiverName: Clark Kent addressId: teste isDisposable: true postalCode: '12345000' city: Rio de Janeiro state: RJ country: BRA street: Rua da minha casa number: '123' neighborhood: Copacabana complement: 15º andar reference: null geoCoordinates: - -47.924747467041016 - -15.832582473754883 pickupPoints: [] clientProfileData: email: clark.kent@example.com firstName: Clark lastName: Kent document: '12345678900' documentType: cpf phone: '+5521998765432' corporateName: company-name tradeName: trade-name corporateDocument: '12345678000100' stateInscription: '12345678' corporatePhone: '551100988887777' isCorporate: false profileCompleteOnLoading: false profileErrorOnLoading: false customerClass: null paymentData: installmentOptions: - paymentSystem: 2 bin: null paymentName: null paymentGroupName: null value: 15000 installments: - count: 1 hasInterestRate: false interestRate: 0 value: 15000 total: 15000 sellerMerchantInstallments: - id: LOJADOBRENO count: 1 hasInterestRate: false interestRate: 0 value: 15000 total: 15000 - count: 2 hasInterestRate: false interestRate: 0 value: 7500 total: 15000 sellerMerchantInstallments: - id: LOJADOBRENO count: 2 hasInterestRate: false interestRate: 0 value: 7500 total: 15000 paymentSystems: - id: 2 name: Visa groupName: creditCardPaymentGroup validator: regex: ^2[1-8]{17}$ mask: 9999 9999 9999 9999 cardCodeRegex: ^[0-3]{8}$ cardCodeMask: '999' weights: - 2 - 1 - 2 - 1 - 2 - 1 useCvv: true useExpirationDate: true useCardHolderName: true useBillingAddress: true stringId: '2' template: creditCardPaymentGroup-template requiresDocument: false isCustom: false description: Payment description requiresAuthentication: false dueDate: '2020-03-05T14:59:00.7879306Z' availablePayments: null payments: - paymentSystem: 6 bin: null accountId: '12' tokenId: null value: 34390 referenceValue: 34390 giftCardRedemptionCode: null giftCardProvider: null giftCardId: null giftCards: [] giftCardMessages: [] availableAccounts: [] availableTokens: [] marketingData: coupon: free-shipping utmSource: app utmMedium: CPC utmCampaign: Black friday utmipage: null utmiPart: null utmiCampaign: null sellers: - id: '1' name: lojadobreno logo: Logo clientPreferencesData: locale: pt-BR optinNewsLetter: false commercialConditionData: null storePreferencesData: countryCode: BRA saveUserData: true timeZone: E. South America Standard Time currencyCode: BRL currencyLocale: 1046 currencySymboupdate cartl: R$ currencyFormatInfo: currencyDecimalDigits: 2 currencyDecimalSeparator: ',' currencyGroupSeparator: . currencyGroupSize: 3 startsWithCurrencySymbol: true giftRegistryData: null openTextField: null invoiceData: null customData: null itemMetadata: items: - id: '1' seller: '1' name: Ração Royal Canin Feline Urinary 500g skuName: Ração Royal Canin Feline Urinary 500g productId: '1' refId: '0001' ean: '123456789' imageUrl: http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000 detailUrl: /racao-royal-canin-feline-urinary/p assemblyOptions: [] hooksData: null ratesAndBenefitsData: rateAndBenefitsIdentifiers: [] teaser: [] subscriptionData: null itemsOrdination: criteria: NAME ascending: true deprecated: false /api/checkout/pub/orderForm/{orderFormId}/items: post: tags: - Shopping Cart summary: VTex Add cart items description: "Use this request to add a new item to the shopping cart.\r\n\r\nThe [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.\n\r\n\r> This request has a time out of 45 seconds.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations." operationId: Items security: [] parameters: - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' - name: orderFormId in: path description: ID of the orderForm corresponding to the cart in which the new item will be added. required: true style: simple schema: type: string example: ede846222cd44046ba6c638442c3505a - name: allowedOutdatedData in: query description: "In order to optimize performance, this parameter allows some information to not be updated when there are changes in the minicart. For instance, if a shopper adds another unit of a given SKU to the cart, it may not be necessary to recalculate payment information, which could impact performance.\n\r\n\rThis array accepts strings and currently the only possible value is `”paymentData”`." required: false style: form schema: type: array example: - paymentData items: type: string description: Information that will not be updated when there are changes in the minicart. requestBody: content: application/json: schema: type: object properties: orderItems: type: array description: Array containing the cart items. Each object inside this array corresponds to a different item. items: required: - quantity - seller - id - index type: object description: Cart item information properties: quantity: type: integer format: int32 description: The quantity of the item (SKU) in the cart. example: 3 seller: type: string description: The seller responsible for the SKU. example: '1' id: type: string description: The ID of the SKU in VTEX platform. example: '2005' index: type: integer description: The position of the item in the array. example: 0 price: type: integer description: Price of the item in cents. Send this value in case you want to make a bulk price change. example: 1099 required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/orderForm' example: orderFormId: ede846222cd44046ba6c638442c3505a salesChannel: '1' loggedIn: false isCheckedIn: false storeId: '1' allowManualPrice: false canEditData: true userProfileId: fb542e51-5488-4c34-8d17-ed8fcf597a94 profileProvider: VTEX availableAccounts: [] availableAddresses: - addressType: residential receiverName: Clark Kent addressId: 666c2e830bd9474ab6f6cc53fb6dd2d2 isDisposable: true postalCode: '70386000' city: Brasília state: DF country: BRA street: Rua da minha casa number: '123' neighborhood: Copacabana complement: 15º andar reference: null geoCoordinates: - -47.924747467041016 - -15.832582473754883 userType: User type ignoreProfileData: false value: 34390 messages: [] items: - uniqueId: 9D6E447B3FF64CEDA33B17C01379C119 id: '2' productId: '2005' productRefId: '1' refId: CBC30L ean: null name: Chopp Brahma Claro 30L skuName: Chopp Brahma Claro 30L modalType: null parentItemIndex: null parentAssemblyBinding: null assemblies: [] priceValidUntil: '2022-07-13T18:30:46Z' tax: 0 taxCode: 54WC8ZN6K8 price: 32890 listPrice: 49900 manualPrice: null manualPriceAppliedBy: null sellingPrice: 32890 rewardValue: 0 isGift: false additionalInfo: dimension: null brandName: Brahma brandId: '2000000' offeringInfo: null offeringType: null offeringTypeId: null preSaleDate: null productCategoryIds: /1/ productCategories: '1': Bebidas quantity: 3 seller: '1' sellerChain: - '1' imageUrl: http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000 detailUrl: /chopp-brahma-claro-30l/p components: [] bundleItems: [] attachments: [] attachmentOfferings: [] offerings: [] priceTags: [] availability: available measurementUnit: un unitMultiplier: 1 manufacturerCode: null priceDefinition: calculatedSellingPrice: 32890 total: 32890 sellingPrices: - value: 32890 quantity: 1 selectableGifts: [] totalizers: - id: Items name: Total dos Itens value: 15000 shippingData: address: addressType: residential receiverName: Clark Kent addressId: teste isDisposable: true postalCode: '70386000' city: Brasília state: DF country: BRA street: Rua da minha casa number: '123' neighborhood: Copacabana complement: 15º andar reference: null geoCoordinates: - -47.924747467041016 - -15.832582473754883 logisticsInfo: - itemIndex: 0 selectedSla: Normal selectedDeliveryChannel: delivery addressId: teste slas: - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] shippingEstimate: 3bd shippingEstimateDate: null lockTTL: 10d availableDeliveryWindows: [] deliveryWindow: null price: 1500 listPrice: 1500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: null address: null additionalInfo: null dockId: null pickupPointId: null pickupDistance: 0 polygonName: null transitTime: 3bd shipsTo: - BRA - COL - USA itemId: '2' deliveryChannels: - id: delivery - id: pickup-in-point selectedAddresses: - addressType: residential receiverName: Clark Kent addressId: teste isDisposable: true postalCode: '12345000' city: Rio de Janeiro state: RJ country: BRA street: Rua da minha casa number: '123' neighborhood: Copacabana complement: 15º andar reference: null geoCoordinates: - -47.924747467041016 - -15.832582473754883 availableAddresses: - addressType: residential receiverName: Clark Kent addressId: teste isDisposable: true postalCode: '12345000' city: Rio de Janeiro state: RJ country: BRA street: Rua da minha casa number: '123' neighborhood: Copacabana complement: 15º andar reference: null geoCoordinates: - -47.924747467041016 - -15.832582473754883 pickupPoints: [] clientProfileData: email: clark.kent@example.com firstName: Clark lastName: Kent document: '12345678900' documentType: cpf phone: '+5521998765432' corporateName: company-name tradeName: trade-name corporateDocument: '12345678000100' stateInscription: '12345678' corporatePhone: '551100988887777' isCorporate: false profileCompleteOnLoading: false profileErrorOnLoading: false customerClass: null paymentData: installmentOptions: - paymentSystem: 2 bin: null paymentName: null paymentGroupName: null value: 15000 installments: - count: 1 hasInterestRate: false interestRate: 0 value: 15000 total: 15000 sellerMerchantInstallments: - id: LOJADOBRENO count: 1 hasInterestRate: false interestRate: 0 value: 15000 total: 15000 - count: 2 hasInterestRate: false interestRate: 0 value: 7500 total: 15000 sellerMerchantInstallments: - id: LOJADOBRENO count: 2 hasInterestRate: false interestRate: 0 value: 7500 total: 15000 paymentSystems: - id: 2 name: Visa groupName: creditCardPaymentGroup validator: regex: ^2[1-8]{17}$ mask: 9999 9999 9999 9999 cardCodeRegex: ^[0-3]{8}$ cardCodeMask: '999' weights: - 2 - 1 - 2 - 1 - 2 - 1 useCvv: true useExpirationDate: true useCardHolderName: true useBillingAddress: true stringId: '2' template: creditCardPaymentGroup-template requiresDocument: false isCustom: false description: Payment description requiresAuthentication: false dueDate: '2020-03-05T14:59:00.7879306Z' availablePayments: null payments: - paymentSystem: 6 bin: null accountId: '12' tokenId: null value: 34390 referenceValue: 34390 giftCardRedemptionCode: null giftCardProvider: null giftCardId: null giftCards: [] giftCardMessages: [] availableAccounts: [] availableTokens: [] marketingData: coupon: free-shipping utmSource: app utmMedium: CPC utmCampaign: Black friday utmipage: null utmiPart: null utmiCampaign: null sellers: - id: '1' name: lojadobreno logo: Logo clientPreferencesData: locale: pt-BR optinNewsLetter: false commercialConditionData: null storePreferencesData: countryCode: BRA saveUserData: true timeZone: E. South America Standard Time currencyCode: BRL currencyLocale: 1046 currencySymboupdate cartl: R$ currencyFormatInfo: currencyDecimalDigits: 2 currencyDecimalSeparator: ',' currencyGroupSeparator: . currencyGroupSize: 3 startsWithCurrencySymbol: true giftRegistryData: null openTextField: null invoiceData: null customData: null itemMetadata: items: - id: '1' seller: '1' name: Ração Royal Canin Feline Urinary 500g skuName: Ração Royal Canin Feline Urinary 500g productId: '1' refId: '0001' ean: '123456789' imageUrl: http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000 detailUrl: /racao-royal-canin-feline-urinary/p assemblyOptions: [] hooksData: null ratesAndBenefitsData: rateAndBenefitsIdentifiers: [] teaser: [] subscriptionData: null itemsOrdination: criteria: NAME ascending: true deprecated: false patch: tags: - Shopping Cart summary: VTex Handle cart items description: "You can use this request to:\n\r\n\r1. Change the quantity or price of one or more items to the shopping cart.\n\r2. Add a new item to the shopping cart.\r\n\r\n**Important**: To add a new item to the shopping cart, do not send the string `index` in the request body.\r\n\r\nThe [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure that represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.\n\r\n\r> This request has a time out of 45 seconds.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations." operationId: ItemsHandle security: [] parameters: - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' - name: orderFormId in: path description: ID of the orderForm corresponding to the cart in which items will be handled. required: true style: simple schema: type: string example: ede846222cd44046ba6c638442c3505a requestBody: content: application/json: schema: type: object properties: orderItems: type: array description: Array containing the cart items. Each object inside this array corresponds to a different item. items: required: - id - quantity - seller type: object description: Cart item information. properties: id: type: string description: The ID of the SKU in VTEX platform. example: '2005' quantity: type: integer format: int32 description: The quantity of the item (SKU) in the cart. example: 3 seller: type: string description: The seller responsible for the SKU. example: '1' index: type: integer description: 'The position of the item in the array. This string should be sent only to modify price or quantity of an item. NOTE: This string should not be sent when you are adding a new item to the cart.' example: 0 price: type: integer description: Price of the item in cents. Send this value in case you want to make a bulk price change. example: 1099 attachments: type: array description: Array containing information on attachments. items: type: object description: Attachment information. properties: name: type: string description: Attachment identification. example: Packages content: type: object description: 'Attachment content data. E.g. `"Do you want to receive packages?": "Yes"`.' nullable: true properties: content: type: string description: Content referring to the customization requested by the customer. example: content-example noSplitItem: type: boolean description: Indicates whether the item can be splitted. example: false allowedOutdatedData: type: array description: In order to optimize performance, this parameter allows some information to not be updated when there are changes in the minicart. For instance, if a shopper adds another unit of a given SKU to the cart, it may not be necessary to recalculate payment information, which could impact performance. This array accepts strings and currently the only possible value is `"paymentData"`. items: type: string description: String that allows some information to not be updated when there are changes in the minicart. example: paymentData required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/orderForm' example: orderFormId: ede846222cd44046ba6c638442c3505a salesChannel: '1' loggedIn: false isCheckedIn: false storeId: '1' allowManualPrice: false canEditData: true userProfileId: fb542e51-5488-4c34-8d17-ed8fcf597a94 profileProvider: VTEX availableAccounts: [] availableAddresses: - addressType: residential receiverName: Clark Kent addressId: 666c2e830bd9474ab6f6cc53fb6dd2d2 isDisposable: true postalCode: '70386000' city: Brasília state: DF country: BRA street: Rua da minha casa number: '123' neighborhood: Copacabana complement: 15º andar reference: null geoCoordinates: - -47.924747467041016 - -15.832582473754883 userType: User type ignoreProfileData: false value: 34390 messages: [] items: - uniqueId: 9D6E447B3FF64CEDA33B17C01379C119 id: '2' productId: '2005' productRefId: '1' refId: CBC30L ean: null name: Chopp Brahma Claro 30L skuName: Chopp Brahma Claro 30L modalType: null parentItemIndex: null parentAssemblyBinding: null assemblies: [] priceValidUntil: '2022-07-13T18:30:46Z' tax: 0 taxCode: 54WC8ZN6K8 price: 32890 listPrice: 49900 manualPrice: null manualPriceAppliedBy: null sellingPrice: 32890 rewardValue: 0 isGift: false additionalInfo: dimension: null brandName: Brahma brandId: '2000000' offeringInfo: null offeringType: null offeringTypeId: null preSaleDate: null productCategoryIds: /1/ productCategories: '1': Bebidas quantity: 3 seller: '1' sellerChain: - '1' imageUrl: http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000 detailUrl: /chopp-brahma-claro-30l/p components: [] bundleItems: [] attachments: [] attachmentOfferings: [] offerings: [] priceTags: [] availability: available measurementUnit: un unitMultiplier: 1 manufacturerCode: null priceDefinition: calculatedSellingPrice: 32890 total: 32890 sellingPrices: - value: 32890 quantity: 1 selectableGifts: [] totalizers: - id: Items name: Total dos Itens value: 15000 shippingData: address: addressType: residential receiverName: Clark Kent addressId: teste isDisposable: true postalCode: '70386000' city: Brasília state: DF country: BRA street: Rua da minha casa number: '123' neighborhood: Copacabana complement: 15º andar reference: null geoCoordinates: - -47.924747467041016 - -15.832582473754883 logisticsInfo: - itemIndex: 0 selectedSla: Normal selectedDeliveryChannel: delivery addressId: teste slas: - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] shippingEstimate: 3bd shippingEstimateDate: null lockTTL: 10d availableDeliveryWindows: [] deliveryWindow: null price: 1500 listPrice: 1500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: null address: null additionalInfo: null dockId: null pickupPointId: null pickupDistance: 0 polygonName: null transitTime: 3bd shipsTo: - BRA - COL - USA itemId: '2' deliveryChannels: - id: delivery - id: pickup-in-point selectedAddresses: - addressType: residential receiverName: Clark Kent addressId: teste isDisposable: true postalCode: '12345000' city: Rio de Janeiro state: RJ country: BRA street: Rua da minha casa number: '123' neighborhood: Copacabana complement: 15º andar reference: null geoCoordinates: - -47.924747467041016 - -15.832582473754883 availableAddresses: - addressType: residential receiverName: Clark Kent addressId: teste isDisposable: true postalCode: '12345000' city: Rio de Janeiro state: RJ country: BRA street: Rua da minha casa number: '123' neighborhood: Copacabana complement: 15º andar reference: null geoCoordinates: - -47.924747467041016 - -15.832582473754883 pickupPoints: [] clientProfileData: email: clark.kent@example.com firstName: Clark lastName: Kent document: '12345678900' documentType: cpf phone: '+5521998765432' corporateName: company-name tradeName: trade-name corporateDocument: '12345678000100' stateInscription: '12345678' corporatePhone: '551100988887777' isCorporate: false profileCompleteOnLoading: false profileErrorOnLoading: false customerClass: null paymentData: installmentOptions: - paymentSystem: 2 bin: null paymentName: null paymentGroupName: null value: 15000 installments: - count: 1 hasInterestRate: false interestRate: 0 value: 15000 total: 15000 sellerMerchantInstallments: - id: LOJADOBRENO count: 1 hasInterestRate: false interestRate: 0 value: 15000 total: 15000 - count: 2 hasInterestRate: false interestRate: 0 value: 7500 total: 15000 sellerMerchantInstallments: - id: LOJADOBRENO count: 2 hasInterestRate: false interestRate: 0 value: 7500 total: 15000 paymentSystems: - id: 2 name: Visa groupName: creditCardPaymentGroup validator: regex: ^2[1-8]{17}$ mask: 9999 9999 9999 9999 cardCodeRegex: ^[0-3]{8}$ cardCodeMask: '999' weights: - 2 - 1 - 2 - 1 - 2 - 1 useCvv: true useExpirationDate: true useCardHolderName: true useBillingAddress: true stringId: '2' template: creditCardPaymentGroup-template requiresDocument: false isCustom: false description: Payment description requiresAuthentication: false dueDate: '2020-03-05T14:59:00.7879306Z' availablePayments: null payments: - paymentSystem: 6 bin: null accountId: '12' tokenId: null value: 34390 referenceValue: 34390 giftCardRedemptionCode: null giftCardProvider: null giftCardId: null giftCards: [] giftCardMessages: [] availableAccounts: [] availableTokens: [] marketingData: coupon: free-shipping utmSource: app utmMedium: CPC utmCampaign: Black friday utmipage: null utmiPart: null utmiCampaign: null sellers: - id: '1' name: lojadobreno logo: Logo clientPreferencesData: locale: pt-BR optinNewsLetter: false commercialConditionData: null storePreferencesData: countryCode: BRA saveUserData: true timeZone: E. South America Standard Time currencyCode: BRL currencyLocale: 1046 currencySymboupdate cartl: R$ currencyFormatInfo: currencyDecimalDigits: 2 currencyDecimalSeparator: ',' currencyGroupSeparator: . currencyGroupSize: 3 startsWithCurrencySymbol: true giftRegistryData: null openTextField: null invoiceData: null customData: null itemMetadata: items: - id: '1' seller: '1' name: Ração Royal Canin Feline Urinary 500g skuName: Ração Royal Canin Feline Urinary 500g productId: '1' refId: '0001' ean: '123456789' imageUrl: http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000 detailUrl: /racao-royal-canin-feline-urinary/p assemblyOptions: [] hooksData: null ratesAndBenefitsData: rateAndBenefitsIdentifiers: [] teaser: [] subscriptionData: null itemsOrdination: criteria: NAME ascending: true deprecated: false /api/checkout/pub/orderForm/{orderFormId}/items/{itemIndex}/price: put: tags: - Shopping Cart summary: VTex Change price of an SKU in a cart description: "This request changes the price of an SKU in a cart.\r\n\r\nThe [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.\n\r\n\rYou need to inform which cart you are referring to, by sending its `orderFormId` and what is the item whose price you want to change, by sending its `itemIndex`.\n\r\n\rYou also need to pass the new price value in the body.\n\r\n\rRemember that, to use this endpoint, the feature of *manual price* must be active. To check if it's active, use the [Get orderForm configuration](https://developers.vtex.com/docs/api-reference/checkout-api#get-/api/checkout/pvt/configuration/orderForm) endpoint. To make it active, use the [Update orderForm configuration](https://developers.vtex.com/docs/api-reference/checkout-api#post-/api/checkout/pvt/configuration/orderForm) endpoint, making the `allowManualPrice` field `true`.\n\r\n\r> Whenever you use this request to change the price of an item, all items in that cart with the same SKU are affected by this change. This applies even to items that share the SKU but have been separated into different objects in the `items` array due to customizations or attachments, for example.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations." operationId: PriceChange parameters: - name: orderFormId in: path description: ID of the orderForm corresponding to the cart whose items will have the price changed. required: true style: simple schema: type: string example: ede846222cd44046ba6c638442c3505a - name: itemIndex in: path description: The index of the item in the cart. Each cart item is identified by an index, starting in 0. required: true style: simple schema: type: string example: '0' - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' requestBody: content: application/json: schema: $ref: '#/components/schemas/PriceChangeRequest' example: price: 10000 required: true responses: '200': description: OK content: application/json: example: orderFormId: ede846222cd44046ba6c638442c3505a salesChannel: '1' loggedIn: true isCheckedIn: false storeId: '1' checkedInPickupPointId: '21' allowManualPrice: true canEditData: true userProfileId: fb542e51-5488-4c34-8d17-ed8fcf597a94 userType: User type ignoreProfileData: false value: 10000 messages: [] items: - uniqueId: E0F2B7AF5CD74D668F1E27537206912C id: '1' productId: '1' productRefId: '1' refId: '0001' ean: '123456789' name: Ração Royal Canin Feline Urinary 500g skuName: Ração Royal Canin Feline Urinary 500g modalType: null parentItemIndex: null parentAssemblyBinding: null assemblies: [] priceValidUntil: '2021-02-27T14:59:00.8288784Z' tax: 0 taxCode: 54WC8ZN6K8 price: 15000 listPrice: 30000 manualPrice: 10000 sellingPrice: 10000 rewardValue: 0 isGift: false additionalInfo: brandName: Royal Canin brandId: '2000000' offeringInfo: null offeringType: null offeringTypeId: null preSaleDate: null productCategoryIds: /1/10/ productCategories: '1': Alimentação '10': Ração Seca quantity: 1 seller: '1' sellerChain: - '1' imageUrl: http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000 detailUrl: /racao-royal-canin-feline-urinary/p components: [] bundleItems: [] attachments: [] attachmentOfferings: [] offerings: [] priceTags: - name: DISCOUNT@MANUALPRICE value: -5000 rawValue: -50 isPercentual: false identifier: null availability: available measurementUnit: un unitMultiplier: 1 manufacturerCode: null selectableGifts: [] totalizers: - id: Items name: Total dos Itens value: 15000 - id: Discounts name: Total dos Descontos value: -5000 shippingData: address: null logisticsInfo: - itemIndex: 0 selectedSla: Normal selectedDeliveryChannel: delivery addressId: 666c2e830bd9474ab6f6cc53fb6dd2d2 slas: [] shipsTo: - BRA itemId: '1' deliveryChannels: - id: pickup-in-point - id: delivery selectedAddresses: [] availableAddresses: [] pickupPoints: [] clientProfileData: null paymentData: installmentOptions: - paymentSystem: 2 bin: null paymentName: null paymentGroupName: null value: 10000 installments: - count: 1 hasInterestRate: false interestRate: 0 value: 10000 total: 10000 sellerMerchantInstallments: - id: LOJADOBRENO count: 1 hasInterestRate: false interestRate: 0 value: 10000 total: 10000 - count: 2 hasInterestRate: false interestRate: 0 value: 5000 total: 10000 sellerMerchantInstallments: - id: LOJADOBRENO count: 2 hasInterestRate: false interestRate: 0 value: 5000 total: 10000 paymentSystems: - id: 2 name: Visa groupName: creditCardPaymentGroup validator: regex: ^4[0-9]{15}$ mask: 9999 9999 9999 9999 cardCodeRegex: ^[0-9]{3}$ cardCodeMask: '999' weights: - 2 - 1 - 2 - 1 - 2 useCvv: true useExpirationDate: true useCardHolderName: true useBillingAddress: true stringId: '2' template: creditCardPaymentGroup-template requiresDocument: false isCustom: false description: Payment description requiresAuthentication: false dueDate: '2020-03-05T16:42:31.7836281Z' availablePayments: null payments: - paymentSystem: 6 bin: null accountId: '12' tokenId: null value: 34390 referenceValue: 34390 giftCardRedemptionCode: null giftCardProvider: null giftCardId: null giftCards: [] giftCardMessages: [] availableAccounts: [] availableTokens: [] marketingData: null sellers: - id: '1' name: lojadobreno logo: Logo clientPreferencesData: locale: pt-BR optinNewsLetter: null commercialConditionData: null storePreferencesData: countryCode: BRA saveUserData: true timeZone: E. South America Standard Time currencyCode: BRL currencyLocale: 1046 currencySymbol: R$ currencyFormatInfo: currencyDecimalDigits: 2 currencyDecimalSeparator: ',' currencyGroupSeparator: . currencyGroupSize: 3 startsWithCurrencySymbol: true giftRegistryData: null openTextField: null invoiceData: null customData: null itemMetadata: items: - id: '1' seller: '1' name: Ração Royal Canin Feline Urinary 500g skuName: Ração Royal Canin Feline Urinary 500g productId: '1' refId: '0001' ean: '123456789' imageUrl: http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000 detailUrl: /racao-royal-canin-feline-urinary/p assemblyOptions: [] hooksData: null ratesAndBenefitsData: rateAndBenefitsIdentifiers: [] teaser: [] subscriptionData: null itemsOrdination: criteria: NAME ascending: true schema: $ref: '#/components/schemas/orderForm' deprecated: false /api/checkout/pub/orderForm/{orderFormId}/profile: patch: tags: - Shopping Cart summary: VTex Ignore profile data on checkout description: "When a shopper provides an email address at Checkout, the platform tries to retrieve existing profile information for that email and add it to the shopping cart information. Use this request if you want to change this behavior for a given cart, meaning profile information will not be included in the order automatically.\r\n\r\nThe [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.\r\n\r\nNote that this request will only work if you have not sent the `clientProfileData` to the cart yet. Sending it to a cart that already has a `clientProfileData` should return a status `403 Forbidden` error, with an `Access denied` message.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations." operationId: IgnoreProfileData security: [] parameters: - name: orderFormId in: path description: ID of the orderForm corresponding to the cart whose items will have the price changed. required: true style: simple schema: type: string example: ede846222cd44046ba6c638442c3505a - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' requestBody: content: application/json: schema: type: object properties: ignoreProfileData: type: boolean description: Indicates whether profile data should be ignored. example: false example: ignoreProfileData: true required: true responses: '200': description: OK content: application/json: example: orderFormId: 68b287ae65534704b1a1e42e47c82abc salesChannel: '1' loggedIn: true isCheckedIn: false storeId: '1' checkedInPickupPointId: '21' allowManualPrice: false canEditData: true userProfileId: fb542e51-5488-4c34-8d17-ed8fcf597a94 userType: User type ignoreProfileData: true value: 0 messages: [] items: [] selectableGifts: [] totalizers: [] shippingData: null clientProfileData: email: clark.kent@examplemail.com firstName: Clark lastName: Kent document: '12345678900' documentType: cpf phone: '+5500123456789' corporateName: company-name tradeName: trade-name corporateDocument: '12345678000100' stateInscription: '12345678' corporatePhone: '551100988887777' isCorporate: false profileCompleteOnLoading: false profileErrorOnLoading: false customerClass: null paymentData: updateStatus: updated installmentOptions: [] paymentSystems: [] payments: - paymentSystem: 6 bin: null accountId: '12' tokenId: null value: 34390 referenceValue: 34390 giftCardRedemptionCode: null giftCardProvider: null giftCardId: null giftCards: [] giftCardMessages: [] availableAccounts: [] availableTokens: [] marketingData: null sellers: [] clientPreferencesData: locale: pt-BR optinNewsLetter: null commercialConditionData: null storePreferencesData: countryCode: BRA saveUserData: true timeZone: E. South America Standard Time currencyCode: BRL currencyLocale: 1046 currencySymbol: R$ currencyFormatInfo: currencyDecimalDigits: 2 currencyDecimalSeparator: ',' currencyGroupSeparator: . currencyGroupSize: 3 startsWithCurrencySymbol: true giftRegistryData: null openTextField: null invoiceData: null customData: null itemMetadata: items: - id: '1' seller: '1' name: Ração Royal Canin Feline Urinary 500g skuName: Ração Royal Canin Feline Urinary 500g productId: '1' refId: '0001' ean: '123456789' imageUrl: http://lojadobreno.vteximg.com.br/arquivos/ids/155450-55-55/Racao-Royal-Canin-Feline-Urinary-SO.jpg?v=637139444438700000 detailUrl: /racao-royal-canin-feline-urinary/p assemblyOptions: [] hooksData: null ratesAndBenefitsData: rateAndBenefitsIdentifiers: [] teaser: [] subscriptionData: null itemsOrdination: criteria: NAME ascending: true schema: $ref: '#/components/schemas/orderForm' deprecated: false /api/checkout/pub/orderForm/{orderFormId}/installments: get: tags: - Shopping Cart summary: VTex Cart installments description: "Retrieves possible amount of installments and respective values for a given cart with a given payment method.\r\n\r\nThe [orderForm](https://developers.vtex.com/docs/guides/orderform-fields) is the data structure which represents a shopping cart and contains all information pertaining to it. Hence, the `orderFormId` is the identification code of a given cart.\n\r\n\rThis endpoint can be used to get the installment options for only one payment method at a time.\n\r\n\rThis endpoint should be called only after the selected `orderForm` already has a `paymentData`.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations." operationId: GetCartInstallments security: [] parameters: - name: orderFormId in: path required: true description: ID of the `orderForm` to be consulted for installments. schema: type: string example: ede846222cd44046ba6c638442c3505a - name: paymentSystem in: query description: ID of the payment method to be consulted for installments. required: true style: form explode: true schema: type: integer example: 2 - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' responses: '200': description: OK content: application/json: example: paymentSystem: 2 bin: null paymentName: null paymentGroupName: null value: 32000 installments: - count: 1 hasInterestRate: false interestRate: 0 value: 32000 total: 32000 sellerMerchantInstallments: - id: MyStore count: 1 hasInterestRate: false interestRate: 0 value: 32000 total: 32000 - count: 2 hasInterestRate: false interestRate: 0 value: 1600 total: 32000 sellerMerchantInstallments: - id: MyStore count: 2 hasInterestRate: false interestRate: 0 value: 1600 total: 32000 - count: 3 hasInterestRate: false interestRate: 0 value: 10666 total: 32000 sellerMerchantInstallments: - id: MyStore count: 3 hasInterestRate: false interestRate: 0 value: 10666 total: 32000 schema: type: object properties: bin: type: string description: Bin. nullable: true installments: type: array description: Array of installments. items: description: Object with installments information. type: object properties: count: description: An explanation about the purpose of this instance. type: integer hasInterestRate: description: An explanation about the purpose of this instance. type: boolean interestRate: description: An explanation about the purpose of this instance. type: integer value: description: An explanation about the purpose of this instance. type: integer total: description: An explanation about the purpose of this instance. type: integer sellerMerchantInstallments: description: An explanation about the purpose of this instance. type: array items: description: An explanation about the purpose of this instance. type: object properties: id: description: Installment ID. type: string count: description: Count. type: integer hasInterestRate: description: If the installment has an interest rate. type: boolean interestRate: description: Interest rate number. type: integer value: description: Installment value. type: integer total: description: Installment total. type: integer paymentSystem: type: integer description: Payment system. value: type: integer description: Value including interest, in case it applies. Displayed in cents. paymentName: type: string description: Payment name. nullable: true paymentGroupName: type: string description: Payment group name. nullable: true deprecated: false /api/checkout/pub/orderForm/{orderFormId}/coupons: post: tags: - Shopping Cart summary: VTex Add coupons to the cart description: "Use this request to add coupons to a given shopping cart.\n\r\n\rTo add multiple coupons to the same cart, you need to:\n\r\n\r1. Request the activation of this feature through the [Support VTEX](https://help.vtex.com/support) if this is the first time you perform this action on your store.\n\r2. Submit all coupon codes in the same requisition separated by commas. E.g.: {\"text\": \"freeshipping, discount10, holiday30\"}.\r\n\r\nFor more information on multiple coupons, access the [coupons tutorial](https://help.vtex.com/en/tutorial/creating-a-coupon-beta--7lMk3MmhNp2IEccyGApxU).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Checkout | CheckoutResources | **Read Shopping Cart** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations." operationId: AddCoupons security: [] parameters: - name: orderFormId in: path required: true description: ID of the orderForm that will receive coupon information. style: simple schema: type: string example: ede846222cd44046ba6c638442c3505a - $ref: '#/components/parameters/Content-Type' - $ref: '#/components/parameters/Accept' requestBody: content: application/json: schema: type: object properties: text: type: string description: Sending an existing coupon code in this field will return the corresponding discount in the purchase. example: freeshipping required: true responses: '200': description: OK content: application/json: schema: type: object properties: orderFormId: type: string description: ID of the orderForm corresponding to a specific cart. salesChannel: type: string description: Attribute created by the seller, in their VTEX store configuration. loggedIn: type: boolean description: Indicates whether the user is logged into the store. isCheckedIn: type: boolean description: Indicates whether order is checked in. storeId: type: string description: ID of the store. nullable: true allowManualPrice: type: boolean description: Permission to modify item price manually. canEditData: type: boolean description: Data can be edited. userProfileId: type: string description: Unique ID associated with the customer profile. profileProvider: type: string description: Profile provider. availableAccounts: type: array description: Available accounts. items: type: string description: Available account. availableAddresses: type: array description: Information on each available address. items: type: object properties: addressType: type: string description: Address type. receiverName: type: string description: Name of the receiver. addressId: type: string description: Address ID. nullable: true isDisposable: type: boolean description: Indicates whether address is disposable. city: type: string description: City of the address. state: type: string description: State of the address. country: type: string description: Country of the address. ISO three-letter code. street: type: string description: Street of the address. number: type: string description: Number of the address. neighborhood: type: string description: Neighborhood of the address. complement: type: string description: Complement to the address. nullable: true reference: type: string description: Reference that may help in the location of the address. nullable: true geoCoordinates: type: array description: Array containing two floats with geocoordinates, first longitude, then latitude. items: type: number description: Geocoordinates numbers. userType: type: string description: User type. nullable: true ignoreProfileData: type: boolean description: Ignore customer profile data. value: type: integer description: Total value of the order without separating cents. For example, $24.99 is represented `2499`. messages: type: array description: Array containing an object for each message generated by our servers while processing the request. items: type: string description: Message. items: type: array description: Information on each item in the order. items: type: object properties: uniqueId: type: string description: Unique ID. id: type: string description: ID of the item. productId: type: string description: Product ID. productRefId: type: string description: Product Ref ID. refId: type: string description: Ref ID. ean: type: string description: European Article Number. nullable: true name: type: string description: Product name. skuName: type: string description: SKU name. modalType: type: string description: Modal type. nullable: true parentItemIndex: type: integer description: Parent item index. nullable: true parentAssemblyBinding: type: string description: Parent assembly binding. nullable: true priceValidUntil: type: string description: Price expiration date and time. tax: type: integer description: Tax value in cents. price: type: integer description: Price in cents. listPrice: type: integer description: List price in cents. manualPrice: type: integer description: Manual price in cents. nullable: true manualPriceAppliedBy: type: string description: User that applied the manual price, if that is the case. nullable: true sellingPrice: type: integer description: Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead. rewardValue: type: integer description: Reward value in cents. isGift: type: boolean description: Indicates whether item is a gift. additionalInfo: type: object description: Additional information. properties: dimension: type: string description: Dimension. nullable: true brandName: type: string description: Brand name. brandId: type: string description: Brand ID. offeringInfo: type: string description: Offering information. nullable: true offeringType: type: string description: Offering type. nullable: true offeringTypeId: type: string description: Offering type ID. nullable: true preSaleDate: type: string description: Presale date. nullable: true productCategoryIds: type: string description: Product category IDs. productCategories: type: object description: Object, where each field is an ID from `productCategoryIds`. properties: '{ID}': type: string description: Product category corresponding to the ID in the field key. quantity: type: integer description: Quantity. seller: type: string description: Seller. sellerChain: type: array description: Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order. items: type: string description: Seller. imageUrl: type: string description: Image URL. detailUrl: type: string description: Detail URL. bundleItems: type: array description: 'Information on services sold along with the SKU. Example: a gift package.' items: type: object properties: type: type: string description: Service type. id: type: integer description: Service identifier. name: type: string description: Service name. price: type: integer description: Service price in cents. attachments: type: array description: Array containing information on attachments. items: type: string description: Attachment information. priceTags: type: array description: Array of price tags, each of which, modifies the price in some way, like discounts or rates that apply to the item in the context of the order. items: type: object properties: identifier: type: string description: Price tag identifier. nullable: true isPercentual: type: boolean description: Indicates whether price tag value is applied through a percentage. name: type: string description: Price tag name. rawValue: type: integer description: Price tag raw value. value: type: integer description: Price tag value. availability: type: string description: Availability measurementUnit: type: string description: Measurement unit unitMultiplier: type: integer description: Unit multiplier manufacturerCode: type: string description: Manufacturer code. nullable: true priceDefinition: type: object description: Price information for all units of a specific item. properties: calculatedSellingPrice: type: integer description: Item's calculated unitary selling price in cents. total: type: integer description: Total value for all units of the item in cents. sellingPrices: type: array description: Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total. items: type: object properties: value: type: integer description: Value in cents for that specific rounding. quantity: type: integer description: Rounding quantity, meaning how many items are rounded to this value. selectableGifts: type: array description: Array containing the data of the item selected as a gift. items: type: string description: Gift. totalizers: type: array description: Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value). items: type: object description: Totalizer of purchases. shippingData: type: object nullable: true description: Shipping information pertinent to the order. properties: address: type: object description: Address information. properties: addressType: type: string description: Type of address. For example, `Residential` or `Pickup`. receiverName: type: string description: Name of the person who is going to receive the order. addressId: type: string description: Address ID. nullable: true isDisposable: type: boolean description: Indicates whether address is disposable. postalCode: type: string description: Postal code. city: type: string description: City of the shipping address. state: type: string description: State of the shipping address. country: type: string description: Three letter ISO code of the country of the shipping address. street: type: string description: Street of the shipping address. number: type: string description: Number of the building, house or apartment in the shipping address. neighborhood: type: string description: Neighborhood of the shipping address. complement: type: string description: Complement to the shipping address, in case it applies. nullable: true reference: type: string description: Complement that might help locate the shipping address more precisely in case of delivery. nullable: true geoCoordinates: type: array description: Array containing two floats with geocoordinates, first longitude, then latitude. items: type: number description: Geocoordinates numbers. logisticsInfo: type: array description: Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`. items: type: object properties: itemIndex: type: integer description: Index corresponding to the position of the object in the `items` array. selectedSla: type: string description: SLA selected by the customer. nullable: true selectedDeliveryChannel: type: string description: Delivery channel selected by the customer. nullable: true addressId: type: string description: Address ID. nullable: true slas: type: array description: Information on available SLAs. items: type: object properties: id: type: string description: SLA ID. deliveryChannel: type: string description: Delivery channel. name: type: string description: SLA name. deliveryIds: type: array description: Information on each delivery ID. items: type: object properties: courierId: type: string description: Courier ID. warehouseId: type: string description: Warehouse ID. dockId: type: string description: Warehouse ID. courierName: type: string description: Courier name. quantity: type: integer description: Quantity. shippingEstimate: type: string description: Shipping estimate. For instance, Three business days will be represented `3bd`. shippingEstimateDate: type: string description: Shipping estimate date. nullable: true lockTTL: type: string description: Estimate date of delivery. nullable: true price: type: integer description: Price in cents. listPrice: type: integer description: List price in cents. tax: type: integer description: Tax in cents. pickupStoreInfo: type: object description: Information on the pickup store. properties: isPickupStore: type: boolean description: Indicates whether it is the pickup store. friendlyName: type: string description: Friendly name. nullable: true address: type: object description: Address information. nullable: true properties: addressType: type: string description: Type of address. For example, `Residential` or `Pickup`. postalCode: type: string description: Postal code. city: type: string description: City of the shipping address. state: type: string description: State of the shipping address. country: type: string description: Three letter ISO code of the country of the shipping address. street: type: string description: Street of the shipping address. number: type: string description: Number of the building, house or apartment in the shipping address. neighborhood: type: string description: Neighborhood of the shipping address. complement: type: string description: Complement to the shipping address, in case it applies. nullable: true reference: type: string description: Complement that might help locate the shipping address more precisely in case of delivery. nullable: true geoCoordinates: type: array description: Array containing two floats with geocoordinates, first longitude, then latitude. items: type: number description: Geocoordinates numbers. additionalInfo: type: string description: Additional information. nullable: true dockId: type: string description: Corresponding dock ID. nullable: true pickupPointId: type: string description: Pickup point ID. nullable: true pickupDistance: type: integer description: Pickup point distance. polygonName: type: string description: Polygon name. nullable: true transitTime: type: string description: Transit time. For instance, "three business days" is represented `3bd`. shipsTo: type: array description: List of countries that the item may be shipped to. items: type: string description: Three letter country code. itemId: type: string description: Item ID. deliveryChannels: type: array description: List of available delivery channels. items: type: object properties: id: type: string description: Delivery channel ID. selectedAddresses: type: array description: Array with information on the selected addresses for the order. items: type: object properties: addressType: type: string description: Type of address. For example, `Residential` or `Pickup`. receiverName: type: string description: Name of the person who is going to receive the order. addressId: type: string description: Address ID. nullable: true isDisposable: type: boolean description: Indicates whether address is disposable. postalCode: type: string description: Postal code. city: type: string description: City of the shipping address. state: type: string description: State of the shipping address. country: type: string description: Three letter ISO code of the country of the shipping address. street: type: string description: Street of the shipping address. number: type: string description: Number of the building, house or apartment in the shipping address. neighborhood: type: string description: Neighborhood of the shipping address. complement: type: string description: Complement to the shipping address, in case it applies. reference: type: string description: Complement that might help locate the shipping address more precisely in case of delivery. nullable: true geoCoordinates: type: array description: Array containing two floats with geocoordinates, first longitude, then latitude. items: type: number description: Geocoordinates numbers. availableAddresses: type: array description: Array with information on the available addresses for the order. items: type: object properties: addressType: type: string description: Type of address. For example, `Residential` or `Pickup`. receiverName: type: string description: Name of the person who is going to receive the order. addressId: type: string description: Address ID. nullable: true isDisposable: type: boolean description: Indicates whether address is disposable. postalCode: type: string description: Postal code. city: type: string description: City of the shipping address. state: type: string description: State of the shipping address. country: type: string description: Three letter ISO code of the country of the shipping address. street: type: string description: Street of the shipping address. number: type: string description: Number of the building, house or apartment in the shipping address. neighborhood: type: string description: Neighborhood of the shipping address. complement: type: string description: Complement to the shipping address, in case it applies. reference: type: string description: Complement that might help locate the shipping address more precisely in case of delivery. nullable: true geoCoordinates: type: array description: Array containing two floats with geocoordinates, first longitude, then latitude. items: type: number description: Geocoordinates numbers. clientProfileData: type: object description: Customer's profile information. nullable: true properties: email: type: string description: Email address. nullable: true firstName: type: string description: First name. nullable: true lastName: type: string description: Last name. documentType: type: string description: Type of the document informed by the customer. document: type: string description: Document informed by the customer. phone: type: string description: Phone number. corporateName: type: string description: Company name, if the customer is a legal entity. nullable: true tradeName: type: string description: Trade name, if the customer is a legal entity. nullable: true corporateDocument: type: string description: Corporate document, if the customer is a legal entity. nullable: true stateInscription: type: string description: State inscription, if the customer is a legal entity. nullable: true corporatePhone: type: string description: Corporate phone number, if the customer is a legal entity. nullable: true isCorporate: type: boolean description: Indicates whether the customer is a legal entity. profileCompleteOnLoading: type: boolean description: Indicates whether profile is complete on loading. profileErrorOnLoading: type: boolean description: Indicates whether profile presents error on loading. nullable: true customerClass: type: string description: Customer class. nullable: true paymentData: type: object description: Information on the order's payment. properties: giftCards: type: array description: Gift card information, if it applies to the order. items: type: object properties: redemptionCode: type: string description: Gift card redemption code. value: type: integer description: Gift card value in cents. balance: type: integer description: Gift card balance in cents. name: type: string description: Gift card name. id: type: string description: Gift card ID. inUse: type: boolean description: Indicates whether gift card is in use. isSpecialCard: type: boolean description: Indicates whether gift card is special. transactions: type: array description: Information on each transaction pertinent to the order. items: type: object properties: isActive: type: boolean description: Indicates whether transaction is active. transactionId: type: string description: Transaction ID. merchantName: type: string description: Merchant name. payments: type: array description: Information on each payment. items: type: object properties: accountId: type: string description: Account ID. bin: type: string description: Bin. nullable: true installments: type: integer description: Number of installments. paymentSystem: type: integer description: Payment system. referenceValue: type: integer description: Reference value for calculating interest rates, in case it applies. Displayed in cents. value: type: integer description: Value including interest, in case it applies. Displayed in cents. sharedTransaction: type: boolean description: Indicates whather transaction is shared. marketingData: type: object description: Object containIng promotion data such as coupon tracking information and internal or external UTMs. nullable: true properties: coupon: type: string description: Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order. example: free-shipping utmSource: type: string description: UTM source. example: Facebook nullable: true utmMedium: type: string description: UTM medium. example: CPC nullable: true utmCampaign: type: string description: UTM campaign. example: Black friday nullable: true utmiPage: type: string description: utmi_page (internal utm). example: utmi_page-example nullable: true utmiPart: type: string description: utmi_part (internal utm). example: utmi_part-exmaple nullable: true utmiCampaign: type: string description: utmi_campaign (internal utm). example: utmi_campaign-exmaple nullable: true sellers: type: array description: Information on each seller. items: type: object properties: id: type: string description: Seller ID. name: type: string description: Seller name. logo: type: string description: Seller logo. nullable: true clientPreferencesData: type: object description: Object containing preferences from the client who placed the order. properties: locale: type: string description: 'Client''s locale. Examples: `pt-BR` and `en-US`.' optinNewsLetter: type: boolean description: '`true` if the client opted to receive newsletter from the store.' nullable: false commercialConditionData: type: object description: Object containing commercial condition information. nullable: true storePreferencesData: type: object description: Object containing data from the store's configuration (stored in VTEX's License Manager). giftRegistryData: type: object description: Gift registry list information. nullable: true openTextField: type: string description: Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1) example: open-text-example nullable: true invoiceData: type: object description: Object containing information pertinent to the order's invoice. nullable: true customData: type: object description: Customer additional information. nullable: true itemMetadata: type: object description: Item metadata. properties: items: type: array description: List of objects containing metadata on each item in the order. items: type: object properties: id: type: string description: Item ID. seller: type: string description: Seller. name: type: string description: Product name. skuName: type: string description: SKU name. productId: type: string description: Product ID. refId: type: string description: Ref ID. ean: type: string description: European Article Number. nullable: true imageUrl: type: string description: Image URL. detailUrl: type: string description: Detail URL. hooksData: type: object description: Hooks information. nullable: true ratesAndBenefitsData: type: object description: Information on rates and benefits that apply to the order. properties: rateAndBenefitsIdentifiers: type: array description: List with rates and benefits identifiers. items: type: string description: Benefit identifier. teaser: type: array description: List with rates and benefits teasers. items: type: string description: Benefit teaser. subscriptionData: type: object description: Subscription information. nullable: true itemsOrdination: type: object description: Object containing information about the ordering of items within the orderForm. properties: criteria: type: string description: Criteria adopted to order the items in the list. ascending: type: boolean description: Indicates whether the ordering is ascending. example: orderFormId: ede846222cd44046ba6c638442c3505a salesChannel: '1' loggedIn: false isCheckedIn: false storeId: '1' allowManualPrice: false canEditData: true userProfileId: fb542e51-5488-4c34-8d17-ed8fcf597a94 profileProvider: VTEX availableAccounts: [] availableAddresses: - addressType: residential receiverName: Clark Kent addressId: 666c2e830bd9474ab6f6cc53fb6dd2d2 isDisposable: true postalCode: '70386000' city: Brasília state: DF country: BRA street: Rua da minha casa number: '123' neighborhood: Copacabana complement: 15º andar reference: null geoCoordinates: - -47.924747467041016 - -15.832582473754883 userType: User type ignoreProfileData: false value: 34390 messages: [] items: - uniqueId: 9D6E447B3FF64CEDA33B17C01379C119 id: '2' productId: '2' productRefId: '1' refId: CBC30L ean: null name: Chopp Brahma Claro 30L skuName: Chopp Brahma Claro 30L modalType: null parentItemIndex: null parentAssemblyBinding: null assemblies: [] priceValidUntil: '2022-07-13T18:30:46Z' tax: 0 price: 32890 listPrice: 49900 manualPrice: null manualPriceAppliedBy: null sellingPrice: 32890 rewardValue: 0 isGift: false additionalInfo: dimension: null brandName: Brahma brandId: '2000000' offeringInfo: null offeringType: null offeringTypeId: null preSaleDate: null productCategoryIds: /1/ productCategories: '1': Bebidas quantity: 1 seller: '1' sellerChain: - '1' imageUrl: http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000 detailUrl: /chopp-brahma-claro-30l/p components: [] bundleItems: [] attachments: [] attachmentOfferings: [] offerings: [] priceTags: [] availability: available measurementUnit: un unitMultiplier: 1 manufacturerCode: null priceDefinition: calculatedSellingPrice: 32890 total: 32890 sellingPrices: - value: 32890 quantity: 1 selectableGifts: [] totalizers: - id: Items name: Total Items value: 32890 shippingData: address: addressType: residential receiverName: Clark Kent addressId: teste isDisposable: true postalCode: '70386000' city: Brasília state: DF country: BRA street: Rua da minha casa number: '123' neighborhood: Copacabana complement: 15º andar reference: null geoCoordinates: - -47.924747467041016 - -15.832582473754883 logisticsInfo: - itemIndex: 0 selectedSla: Normal selectedDeliveryChannel: delivery addressId: teste slas: - id: Normal deliveryChannel: delivery name: Normal deliveryIds: - courierId: '1' warehouseId: '1_1' dockId: '1' courierName: Transportadora quantity: 1 kitItemDetails: [] shippingEstimate: 3bd shippingEstimateDate: null lockTTL: 10d availableDeliveryWindows: [] deliveryWindow: null price: 1500 listPrice: 1500 tax: 0 pickupStoreInfo: isPickupStore: false friendlyName: null address: null additionalInfo: null dockId: null pickupPointId: null pickupDistance: 0 polygonName: null transitTime: 3bd shipsTo: - BRA - COL - USA itemId: '2' deliveryChannels: - id: delivery - id: pickup-in-point selectedAddresses: - addressType: residential receiverName: Clark Kent addressId: teste isDisposable: true postalCode: '12345000' city: Rio de Janeiro state: RJ country: BRA street: Rua da minha casa number: '123' neighborhood: Copacabana complement: 15º andar reference: null geoCoordinates: - -47.924747467041016 - -15.832582473754883 availableAddresses: - addressType: residential receiverName: Clark Kent addressId: teste isDisposable: true postalCode: '12345000' city: Rio de Janeiro state: RJ country: BRA street: Rua da minha casa number: '123' neighborhood: Copacabana complement: 15º andar reference: null geoCoordinates: - -47.924747467041016 - -15.832582473754883 pickupPoints: [] clientProfileData: email: clark.kent@example.com firstName: Clark lastName: Kent document: '12345678900' documentType: cpf phone: '+5521998765432' corporateName: company-name tradeName: trade-name corporateDocument: '12345678000100' stateInscription: '12345678' corporatePhone: '551100988887777' isCorporate: false profileCompleteOnLoading: false profileErrorOnLoading: false customerClass: null paymentData: giftCards: [] transactions: - isActive: true transactionId: 296D6D245C17437E823EB77E403FC88D merchantName: MYSTORE payments: - paymentSystem: 6 bin: null accountId: '12' tokenId: null value: 34390 referenceValue: 34390 giftCardRedemptionCode: null giftCardProvider: null giftCardId: null sharedTransaction: false marketingData: utmSource: null utmMedium: null utmCampaign: null utmipage: null utmiPart: null utmiCampaign: null coupon: freeshipping marketingTags: [] sellers: - id: '1' name: lojadobreno logo: Logo clientPreferencesData: locale: pt-BR optinNewsLetter: false commercialConditionData: null storePreferencesData: {} giftRegistryData: null openTextField: null invoiceData: null customData: null itemMetadata: items: - id: '2' seller: '1' name: Chopp Brahma Claro 30L skuName: Chopp Brahma Claro 30L productId: '2' refId: CBC30L ean: null imageUrl: http://mystore.vteximg.com.br/arquivos/ids/155400-55-55/30l_v2.png?v=637303412106100000 detailUrl: /chopp-brahma-claro-30l/p assemblyOptions: [] hooksData: null ratesAndBenefitsData: rateAndBenefitsIdentifiers: [] teaser: [] subscriptionData: null itemsOrdination: criteria: NAME ascending: true deprecated: false components: schemas: orderForm: type: object properties: orderFormId: type: string description: ID of the orderForm corresponding to a specific cart. salesChannel: type: string description: Attribute created by the seller, in their VTEX store configuration. loggedIn: type: boolean description: Indicates whether the user is logged into the store. isCheckedIn: type: boolean description: Indicates whether order is checked in. storeId: type: string description: ID of the store. nullable: true allowManualPrice: type: boolean description: Permission to modify item price manually. canEditData: type: boolean description: Data can be edited. userProfileId: type: string description: Unique ID associated with the customer profile. profileProvider: type: string description: Profile provider. availableAccounts: type: array description: Available accounts. items: type: string description: Account. availableAddresses: type: array description: Information on each available address. items: type: object properties: addressType: type: string description: Address type. receiverName: type: string description: Name of the receiver. addressId: type: string description: Address ID. nullable: true isDisposable: type: boolean description: Indicates whether address is disposable. city: type: string description: City of the address. state: type: string description: State of the address. country: type: string description: Country of the address. ISO three-letter code. street: type: string description: Street of the address. number: type: string description: Number of the address. neighborhood: type: string description: Neighborhood of the address. complement: type: string description: Complement to the address. nullable: true reference: type: string description: Reference that may help in the location of the address. nullable: true geoCoordinates: type: array description: 'Array with two strings that represent geocoordinates: first latitude, then longitude.' items: type: number description: Geocoordinates. userType: type: string description: User type. nullable: true ignoreProfileData: type: boolean description: Ignore customer profile data. value: type: integer description: Total value of the order without separating cents. For example, $24.99 is represented as `2499`. messages: type: array description: Array containing an object for each message generated by our servers while processing the request. items: type: string description: Message. items: type: array description: Information on each item in the order. items: type: object properties: uniqueId: type: string description: Unique ID. id: type: string description: ID of the item. productId: type: string description: Product ID. productRefId: type: string description: Product Ref ID. refId: type: string description: Ref ID. ean: type: string description: European Article Number. nullable: true name: type: string description: Product name. skuName: type: string description: SKU name. modalType: type: string description: Modal type. nullable: true parentItemIndex: type: integer description: Parent item index. nullable: true parentAssemblyBinding: type: string description: Parent assembly binding. nullable: true priceValidUntil: type: string description: Price expiration date and time. tax: type: integer description: Tax value in cents. taxCode: type: string description: A unique identifier code assigned to a tax within the VTEX Admin. price: type: integer description: Price in cents. listPrice: type: integer description: List price in cents. manualPrice: type: integer description: Manual price in cents. nullable: true manualPriceAppliedBy: type: string description: User that applied the manual price, if that is the case. nullable: true sellingPrice: type: integer description: Selling price in cents. Note that this field may be subject to rounding discrepancies. We recommend retrieving data from the `priceDefinition` data structure instead. rewardValue: type: integer description: Reward value in cents. isGift: type: boolean description: Indicates whether item is a gift. additionalInfo: type: object description: Additional information. properties: dimension: type: string description: Dimension. nullable: true brandName: type: string description: Brand name. brandId: type: string description: Brand ID. offeringInfo: type: string description: Offering information. nullable: true offeringType: type: string description: Offering type. nullable: true offeringTypeId: type: string description: Offering type ID. nullable: true preSaleDate: type: string description: Presale date. nullable: true productCategoryIds: type: string description: Product category IDs. productCategories: type: object description: Object, where each field is an ID from `productCategoryIds`. properties: '{ID}': type: string description: Product category corresponding to the ID in the field key. quantity: type: integer description: Quantity. seller: type: string description: Seller. sellerChain: type: array description: Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order. items: type: string description: Seller. imageUrl: type: string description: Image URL. detailUrl: type: string description: Detail URL. bundleItems: type: array description: 'Information on services sold along with the SKU. Example: a gift package.' items: type: object properties: type: type: string description: Service type. id: type: integer description: Service identifier. name: type: string description: Service name. price: type: integer description: Service price in cents. attachments: type: array description: Array containing information on attachments. items: type: string priceTags: type: array description: Array of price tags, each of which, modifies the price in some way, like discounts or rates that apply to the item in the context of the order. items: type: object properties: identifier: type: string description: Price tag identifier. nullable: true isPercentual: type: boolean description: Indicates whether price tag value is applied through a percentage. name: type: string description: Price tag name. rawValue: type: integer description: Price tag raw value. value: type: integer description: Price tag value. availability: type: string description: Availability. measurementUnit: type: string description: Measurement unit. unitMultiplier: type: integer description: Unit multiplier. manufacturerCode: type: string description: Manufacturer code. nullable: true priceDefinition: type: object description: Price information for all units of a specific item. properties: calculatedSellingPrice: type: integer description: Item's calculated unitary selling price in cents. total: type: integer description: Total value for all units of the item in cents. sellingPrices: type: array description: Array of objects, each containing value (in cents) and quantity for the different rounding instances that can be combined to form the correctly rounded total. items: type: object properties: value: type: integer description: Value in cents for that specific rounding. quantity: type: integer description: Rounding quantity, meaning how many items are rounded to this value. selectableGifts: type: array description: Array containing the data of the item selected as a gift. items: type: string description: Gift. totalizers: type: array description: Array containing an object for each totalizer for the purchase. Totalizers contain the sum of values for a specific part of the order (e.g. Total item value, Total shipping value). items: type: object description: Totalizer of purchases. shippingData: type: object description: Shipping information pertinent to the order. nullable: true properties: address: type: object description: Address information. nullable: true properties: addressType: type: string description: Type of address. For example, `Residential` or `Pickup`. receiverName: type: string description: Name of the person who is going to receive the order. addressId: type: string description: Address ID. nullable: true isDisposable: type: boolean description: Indicates whether address is disposable. postalCode: type: string description: Postal code. city: type: string description: City of the shipping address. state: type: string description: State of the shipping address. country: type: string description: Three letter ISO code of the country of the shipping address. street: type: string description: Street of the shipping address. number: type: string description: Number of the building, house or apartment in the shipping address. neighborhood: type: string description: Neighborhood of the shipping address. complement: type: string description: Complement to the shipping address, in case it applies. nullable: true reference: type: string description: Complement that might help locate the shipping address more precisely in case of delivery. nullable: true geoCoordinates: type: array description: 'Array with two strings that represent geocoordinates: first latitude, then longitude.' items: type: number description: Geocoordinates. logisticsInfo: type: array description: Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`. items: type: object properties: itemIndex: type: integer description: Index corresponding to the position of the object in the `items` array. selectedSla: type: string description: SLA selected by the customer. nullable: true selectedDeliveryChannel: type: string description: Delivery channel selected by the customer. nullable: true addressId: type: string description: Address ID. nullable: true slas: type: array description: Information on available SLAs. items: type: object properties: id: type: string description: SLA ID. deliveryChannel: type: string description: Delivery channel. name: type: string description: SLA name. deliveryIds: type: array description: Information on each delivery ID. items: type: object properties: courierId: type: string description: Courier ID. warehouseId: type: string description: Warehouse ID. dockId: type: string description: Warehouse ID. courierName: type: string description: Courier name. quantity: type: integer description: Quantity. shippingEstimate: type: string description: Shipping estimate. For instance, "three business days" will be represented as `3bd`. shippingEstimateDate: type: string description: Shipping estimate date. nullable: true lockTTL: type: string description: Estimate date of delivery. nullable: true price: type: integer description: Price in cents. listPrice: type: integer description: List price in cents. tax: type: integer description: Tax in cents. pickupStoreInfo: type: object description: Information on the pickup store. properties: isPickupStore: type: boolean description: Indicates whether it is the pickup store. friendlyName: type: string description: Friendly name. nullable: true address: type: object description: Address information. nullable: true properties: addressType: type: string description: Type of address. For example, `Residential` or `Pickup`. postalCode: type: string description: Postal code. city: type: string description: City of the shipping address. state: type: string description: State of the shipping address. country: type: string description: Three letter ISO code of the country of the shipping address. street: type: string description: Street of the shipping address. number: type: string description: Number of the building, house or apartment in the shipping address. neighborhood: type: string description: Neighborhood of the shipping address. complement: type: string description: Complement to the shipping address, in case it applies. nullable: true reference: type: string description: Complement that might help locate the shipping address more precisely in case of delivery. nullable: true geoCoordinates: type: array description: 'Array with two strings that repesent geocoordinates: first latitude, then longitude.' items: type: number description: Geocoordinates. additionalInfo: type: string description: Additional information. nullable: true dockId: type: string description: Corresponding dock ID. nullable: true pickupPointId: type: string description: Pickup point ID. nullable: true pickupDistance: type: integer description: Pickup point distance. polygonName: type: string description: Polygon name. nullable: true transitTime: type: string description: Transit time. For instance, "three business days" is represented as `3bd`. shipsTo: type: array description: List of countries that the item may be shipped to. items: type: string description: Three letter country code. itemId: type: string description: Item ID. deliveryChannels: type: array description: List of available delivery channels. items: type: object properties: id: type: string description: Delivery channel ID. selectedAddresses: type: array description: Array with information on the selected addresses for the order. items: type: object properties: addressType: type: string description: Type of address. For example, `Residential` or `Pickup`. receiverName: type: string description: Name of the person who is going to receive the order. addressId: type: string description: Address ID. nullable: true isDisposable: type: boolean description: Indicates whether address is disposable. postalCode: type: string description: Postal code. city: type: string description: City of the shipping address. state: type: string description: State of the shipping address. country: type: string description: Three letter ISO code of the country of the shipping address. street: type: string description: Street of the shipping address. number: type: string description: Number of the building, house or apartment in the shipping address. neighborhood: type: string description: Neighborhood of the shipping address. complement: type: string description: Complement to the shipping address, in case it applies. reference: type: string description: Complement that might help locate the shipping address more precisely in case of delivery. nullable: true geoCoordinates: type: array description: 'Array with two strings that represent geocoordinates: first latitude, then longitude.' items: type: number description: Geocoordinates. availableAddresses: type: array description: Array with information on the available addresses for the order. items: type: object properties: addressType: type: string description: Type of address. For example, `Residential` or `Pickup`. receiverName: type: string description: Name of the person who is going to receive the order. addressId: type: string description: Address ID. nullable: true isDisposable: type: boolean description: Indicates whether address is disposable. postalCode: type: string description: Postal code. city: type: string description: City of the shipping address. state: type: string description: State of the shipping address. country: type: string description: Three letter ISO code of the country of the shipping address. street: type: string description: Street of the shipping address. number: type: string description: Number of the building, house or apartment in the shipping address. neighborhood: type: string description: Neighborhood of the shipping address. complement: type: string description: Complement to the shipping address, in case it applies. reference: type: string description: Complement that might help locate the shipping address more precisely in case of delivery. nullable: true geoCoordinates: type: array description: 'Array with two strings that represent geocoordinates: first latitude, then longitude.' items: type: number description: Geocoordinates. clientProfileData: type: object description: Customer's profile information. nullable: true properties: email: type: string description: Email address. nullable: true firstName: type: string description: First name. nullable: true lastName: type: string description: Last name. documentType: type: string description: Type of the document informed by the customer. document: type: string description: Document informed by the customer. phone: type: string description: Phone number. corporateName: type: string description: Company name, if the customer is a legal entity. nullable: true tradeName: type: string description: Trade name, if the customer is a legal entity. nullable: true corporateDocument: type: string description: Corporate document, if the customer is a legal entity. nullable: true stateInscription: type: string description: State inscription, if the customer is a legal entity. nullable: true corporatePhone: type: string description: Corporate phone number, if the customer is a legal entity. nullable: true isCorporate: type: boolean description: Indicates whether the customer is a legal entity. profileCompleteOnLoading: type: boolean description: Indicates whether profile is complete on loading. profileErrorOnLoading: type: boolean description: Indicates whether profile presents error on loading. nullable: true customerClass: type: string description: Customer class. nullable: true paymentData: type: object description: Information on the order's payment. properties: giftCards: type: array description: Gift card information, if it applies to the order. items: type: object properties: redemptionCode: type: string description: Gift card redemption code. value: type: integer description: Gift card value in cents. balance: type: integer description: Gift card balance in cents. name: type: string description: Gift card name. id: type: string description: Gift card ID. inUse: type: boolean description: Indicates whether gift card is in use. isSpecialCard: type: boolean description: Indicates whether gift card is special. transactions: type: array description: Information on each transaction pertinent to the order. items: type: object properties: isActive: type: boolean description: Indicates whether transaction is active. transactionId: type: string description: Transaction ID. merchantName: type: string description: Merchant name. payments: type: array description: Information on each payment. items: type: object properties: accountId: type: string description: Account ID. bin: type: string description: Bin. nullable: true installments: type: integer description: Number of installments. paymentSystem: type: string description: Payment system. referenceValue: type: integer description: Reference value for calculating interest rates, in case it applies. Displayed in cents. value: type: integer description: Value including interest, in case it applies. Displayed in cents. sharedTransaction: type: boolean description: Indicates whather transaction is shared. marketingData: type: object nullable: true description: Object containing promotion data such as coupon tracking information and internal or external UTMs. properties: coupon: type: string description: Sending an existing coupon code in this field will return the corresponding discount in the purchase. Use the [cart simulation](https://developers.vtex.com/vtex-rest-api/reference/orderform#orderformsimulation) request to check which coupons might apply before placing the order. example: free-shipping utmSource: type: string description: UTM source. example: Facebook utmMedium: type: string description: UTM medium. example: CPC utmCampaign: type: string description: UTM campaign example: Black friday utmiPage: type: string description: utmi_page (internal utm). example: utmi_page-example nullable: true utmiPart: type: string description: utmi_part (internal utm). example: utmi_part-example nullable: true utmiCampaign: type: string description: utmi_campaign (internal utm). example: utmi_campaign-example nullable: true sellers: type: array description: Information on each seller. items: type: object properties: id: type: string description: Seller ID. name: type: string description: Seller name. logo: type: string description: Seller logo. nullable: true clientPreferencesData: type: object description: Object containing preferences from the client who placed the order. properties: locale: type: string description: 'Client''s locale. Examples: `pt-BR` and `en-US`.' optinNewsLetter: type: boolean description: '`true` if the client opted to receive newsletter from the store.' example: false nullable: true commercialConditionData: type: object description: Object containing commercial condition information. nullable: true storePreferencesData: type: object description: Object containing data from the store's configuration (stored in VTEX's License Manager). giftRegistryData: type: object description: Gift registry list information. nullable: true openTextField: type: string description: Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/vtex-rest-api/docs/creating-customizable-fields-in-the-cart-with-checkout-api-1). example: open-text-example nullable: true invoiceData: type: object description: Object containing information pertinent to the order's invoice. nullable: true customData: type: object description: Customer additional information. nullable: true itemMetadata: type: object description: Item metadata. properties: items: type: array description: List of objects containing metadata on each item in the order. items: type: object properties: id: type: string description: Item ID. seller: type: string description: Seller. name: type: string description: Product name. skuName: type: string description: SKU name. productId: type: string description: Product ID. refId: type: string description: Ref ID. ean: type: string description: European Article Number. nullable: true imageUrl: type: string description: Image URL. detailUrl: type: string description: Detail URL. hooksData: type: object description: Hooks information. nullable: true ratesAndBenefitsData: type: object description: Information on rates and benefits that apply to the order. properties: rateAndBenefitsIdentifiers: type: array description: List with rates and benefits identifiers. items: type: string description: Benefit identifier. teaser: type: array description: List with rates and benefits teasers. items: type: string description: Benefit teaser. subscriptionData: type: object description: Subscription information. nullable: true itemsOrdination: type: object description: Object containing information about the ordering of items within the `orderForm`. properties: criteria: type: string description: Criteria adopted to order the items in the list. ascending: type: boolean description: Indicates whether the ordering is ascending. PriceChangeRequest: required: - price type: object properties: price: type: integer format: int32 description: The new price of the item. example: price: 10000 parameters: Accept: name: Accept in: header description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand. required: true style: simple schema: type: string default: application/json Content-Type: name: Content-Type in: header description: Type of the content being sent. required: true style: simple schema: type: string default: application/json securitySchemes: VtexIdclientAutCookie: type: apiKey in: header name: VtexIdclientAutCookie description: '[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.'