---
title: "Place order"
method: PUT
path: "/api/checkout/pub/orders"
tags: ["Order placement"]
---

# Place order

`PUT /api/checkout/pub/orders`

Places order without having any prior cart information. This means all information on items, client, payment and shipping must be sent in the body.

>⚠️ The authentication of this endpoint is required if you are creating an order with an item that has an attachment that creates a Subscription. For more information, access [Subscriptions API](https://developers.vtex.com/docs/api-reference/subscriptions-api-v3).

## Permissions

Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:

| **Product** | **Category** | **Resource** |
| --------------- | ----------------- | ----------------- |
| Checkout | CheckoutResources | **Orders Full Access** |

There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).

>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.

## Query parameters

- `sc` integer
- `individualShippingEstimates` boolean

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Request body

- object
  - `items` object[], required — Array of objects containing information on each of the order's items.
    - `id` string, required — The SKU ID.
    - `quantity` integer, required — The quantity of items of this specific SKU in the cart to be simulated.
    - `seller` string, required — The ID of the seller responsible for this SKU. This ID can be found in your VTEX Admin.
    - `commission` integer — Comission.
    - `freightCommission` integer — Freight comission.
    - `price` integer — Item price within the context of the order without separating cents. For example, $24.99 is represented `2499`.
    - `bundleItems` object[] — Information on services sold along with the SKU. Example: a gift package.
      - `type` string — Service type.
      - `id` string — Service identifier.
      - `name` string — Service name.
      - `price` integer — Service price. The last two digits are the cents.
    - `itemAttachment` object — Item attachment.
      - `name` string — Attachment name.
      - `content` string — Content referring to the customization requested by the customer.
    - `attachments` string[] — Array containing information on attachments.
    - `priceTags` object[] — Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.
      - `identifier` string, nullable — Promotion unique identifier.
      - `isPercentual` boolean — Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.
      - `name` string — Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where: - `type` indicates whether the tag refers to a discount or tax. - `where` specifies the context, either price or shipping. - `identifier` is the promotion ID. - `calculationId` is a hash that may vary with each price calculation.
      - `rawValue` number — Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.
      - `value` integer — Price tag value representing either a promotion (value decrease) or a tax (value increase).
    - `measurementUnit` string — SKU measurement unit.
    - `unitMultiplier` integer — SKU unit multiplier.
    - `isGift` boolean — Indicates whether the order is a gift.
  - `clientProfileData` object, nullable, required — Customer's profile information. The `email` functions as a customer's ID. For customers already in your database, sending only the email address is enough to register the order to the shopper’s existing account. > If the shopper exists in you database but is not logged in, sending other profile information along with the email will cause the platform to fail placing the order. This happens because this action is interpreted as an attempt to edit profile data, which is not possible unless the customer is logged in to the store.
    - `email` string, nullable, required — Customer's email address.
    - `firstName` string, nullable — Customer's first name.
    - `lastName` string — Customer's last name.
    - `documentType` string — Type of the document informed by the customer.
    - `document` string — Document number informed by the customer.
    - `phone` string — Customer's phone number.
    - `corporateName` string — Company name, if the customer is a legal entity.
    - `tradeName` string — Trade name, if the customer is a legal entity.
    - `corporateDocument` string — Corporate document, if the customer is a legal entity.
    - `stateInscription` string — State inscription, if the customer is a legal entity.
    - `corporatePhone` string — Corporate phone number, if the customer is a legal entity.
    - `isCorporate` boolean — `true` if the customer is a legal entity.
  - `shippingData` object, nullable, required — Shipping information.
    - `address` object, nullable — Shipping address. For customers already in your data base, it is enough to send this object only with an `addressId`, which you may obtain from a [Cart simulation request](https://developers.vtex.com/vtex-rest-api/reference/shopping-cart#cartsimulation), for example.
      - `addressType` string — Type of address. For example, `Residential` or `Pickup`, among others.
      - `receiverName` string — Name of the person who is going to receive the order.
      - `addressId` string, nullable — Address ID.
      - `postalCode` string — Postal Code.
      - `city` string — City of the shipping address.
      - `state` string — State of the shipping address.
      - `country` string — Three letter ISO code of the country of the shipping address.
      - `street` string — Street of the shipping address.
      - `number` string — Number of the building, house or apartment in the shipping address.
      - `neighborhood` string — Neighborhood of the shipping address.
      - `complement` string, nullable — Complement to the shipping address, in case it applies.
      - `reference` string — Complement that might help locate the shipping address more precisely in case of delivery.
      - `geoCoordinates` number[] — Array containing two floats with geocoordinates, first longitude, then latitude.
    - `logisticsInfo` object[] — Array of objects containing logistics information of each item.
      - `itemIndex` integer, required — Index of the item in the `items` array, starting from 0.
      - `selectedSla` string, nullable, required — Selected SLA. For example, `normal` or `express`. If the store uses the [Delivery Options](https://help.vtex.com/en/docs/tutorials/delivery-options-beta) feature, this field returns the delivery option ID selected for this SLA, for example, `1223d5b4-52a4-442f-ab23-01345b60be48`. If this field is `null` or omitted, the API automatically selects the best delivery option available, excluding pickup and scheduled delivery options. To select a pickup option or a scheduled delivery option, it must be explicitly sent in this field. For more information, see the [Add shipping address and select delivery option](https://developers.vtex.com/docs/guides/checkout-api#tag/Cart-attachments/operation/AddShippingAddress) endpoint description.
      - `selectedDeliveryChannel` string, nullable — String with the selected delivery channel. This field supports the following values: - `delivery`, - `pickup-in-point`.
      - `lockTTL` string, nullable — Logistics reservation waiting time.
      - `shippingEstimate` string — Estimated time until delivery for the item. The unit can be `bd` for business days, `d` for days, `h` for hours, or `m` for minutes.
      - `price` integer, required — Shipping price for the item. Does not account for the whole order's shipping price.
      - `deliveryWindow` object — In case of scheduled delivery, this object will contain information on the delivery window selected by the shopper.
        - `startDateUtc` string — Delivery window starting day and time in UTC.
        - `endDateUtc` string — Delivery window ending day and time in UTC.
        - `price` integer — Delivery window price.
        - `lisPrice` integer — Delivery window list price.
        - `tax` integer — Delivery window tax.
    - `updateStatus` string — Indicate whether this object's information is up to date according to the order's items. An order can not be placed if `"outdated"`.
  - `paymentData` object, required — Payment infomation.
    - `giftCards` object[] — Gift card information, if it applies to the order.
      - `redemptionCode` string, required — Gift card redemption code.
      - `value` integer, required — Gift card value.
      - `balance` integer — Gift card balance.
      - `name` string — Gift card name.
      - `id` string — Gift card ID.
      - `inUse` boolean — Indicates whether gift card is in use.
      - `isSpecialCard` boolean — Indicates whether gift card is special.
    - `giftCardMessages` string[] — Array of gift card messages.
    - `paymentSystems` object[] — Information on payment systems.
      - `id` integer — Payment system ID.
      - `name` string — Payment system name.
      - `groupName` string — Payment group name.
      - `validator` object — Payment system validator.
        - `regex` string — Payment system validator.
        - `mask` string — Validator mask.
        - `cardCodeRegex` string — Card code regular expression.
        - `cardCodeMask` string — Card code mask.
        - `weights` integer[] — Weights.
      - `stringId` string — String ID.
      - `template` string — Template.
      - `requiresDocument` boolean — Indicates whether a document is required.
      - `selected` boolean — Indicates whether this payment system has been selected.
      - `isCustom` boolean — Indicates whether it is custom.
      - `description` string — Description.
    - `payments` object[], required — Payment information.
      - `accountId` string — Account ID.
      - `bin` string, nullable — Payment bin.
      - `installments` integer, required — Number of installments.
      - `paymentSystem` integer, required — Payment system.
      - `referenceValue` integer, required — Reference value for calculating interest rates, in case it applies.
      - `value` integer, required — Value including interest, in case it applies.
    - `updateStatus` string — Indicates whether this object's information is up to date according to the order's items. An order can not be placed if `"outdated"`.
  - `marketingData` object, nullable — Coupon information.
    - `coupon` string — 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.
    - `utmSource` string — UTM source.
    - `utmMedium` string — UTM medium.
    - `utmCampaign` string — UTM campaign.
    - `utmiPage` string — utmi_page (internal utm).
    - `utmiPart` string — utmi_part (internal utm).
    - `utmiCampaign` string — utmi_campaign (internal utm).
  - `openTextField` string — Optional field meant to hold additional information about the order. We recommend using this field for text, not data formats such as `JSON` even if escaped. For that purpose, see [Creating customizable fields](https://developers.vtex.com/docs/guides/customizable-fields-with-checkout-api).
  - `salesAssociateData` object — Sales Associate information.
    - `salesAssociateId` string — Sales Associate (Seller) identification code. All information should be registered by the merchant. Maximum of 100 characters.

## Response `200`

OK

- object
  - `orderForm` string, nullable — This is `null` since this request does not depend on any previously existing orderForm information in the platform.
  - `transactionData` object — Information on each transaction pertinent to the order placed.
    - `merchantTransactions` object[] — Information on each merchant transaction.
      - `id` string — ID of the seller.
      - `transactionId` string — ID of the transaction in the platform.
      - `merchantName` string — Name of the merchant responsible for the sale.
      - `payments` object[] — Information on each payment pertinent to the transaction.
        - `paymentSystem` integer — Payment system.
        - `bin` string, nullable — Payment bin.
        - `accountId` string, nullable — Account ID.
        - `tokenId` string, nullable — Token ID.
        - `value` integer — Total value to be paid in this payment.
        - `referenceValue` integer — Reference value over which interests may be applied.
        - `giftCardRedemptionCode` string, nullable — Gift card redemption code.
        - `giftCardProvider` string, nullable — Gift card provider.
        - `giftCardId` string, nullable — Gift card ID.
    - `receiverUri` string — Receiver URI.
    - `gatewayCallbackTemplatePath` string — Template of the gateway callback path, which may later be used to send information about the transaction.
  - `orders` object[] — Information on each of the orders created.
    - `orderId` string — ID of the order in the Order Management System (OMS).
    - `orderGroup` string — Order group. Orders that involve different sellers are split into different orders of a same order group.
    - `state` string, nullable — State.
    - `isCheckedIn` boolean — Indicates whether order is checked in.
    - `sellerOrderId` string, nullable — ID of the order in the seller.
    - `storeId` string, nullable — Store ID.
    - `checkedInPickupPointId` string, nullable — Checked in pickup point.
    - `value` integer — Value of the order.
    - `items` object[] — Information on each item in the order.
      - `uniqueId` string — Unique ID.
      - `id` string — ID of the item.
      - `productId` string — Product ID.
      - `productRefId` string — Product Ref ID.
      - `refId` string — Ref ID.
      - `ean` string, nullable — European Article Number.
      - `name` string — Product name.
      - `skuName` string — SKU name.
      - `modalType` string, nullable — Modal type.
      - `parentItemIndex` integer, nullable — Parent item index.
      - `parentAssemblyBinding` string, nullable — Parent assembly binding.
      - `priceValidUntil` string — Price expiration date and time.
      - `tax` integer — Tax value in cents.
      - `price` integer — Price in cents.
      - `listPrice` integer — List price in cents.
      - `manualPrice` integer, nullable — Manual price in cents.
      - `manualPriceAppliedBy` string, nullable — User that applied the manual price, if that is the case.
      - `sellingPrice` integer — 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` integer — Reward value in cents.
      - `isGift` boolean — Indicates whether item is a gift.
      - `additionalInfo` object — Additional information.
        - `dimension` string, nullable — Dimension.
        - `brandName` string — Brand name.
        - `brandId` string — Brand ID.
        - `offeringInfo` string, nullable — Offering information.
        - `offeringType` string, nullable — Offering type.
        - `offeringTypeId` string, nullable — Offering type ID.
      - `preSaleDate` string, nullable — Presale date.
      - `productCategoryIds` string — Product category IDs.
      - `productCategories` object — Object, where each field is an ID from `productCategoryIds`.
        - `{ID}` string — Product category corresponding to the ID in the field key.
      - `quantity` integer — Quantity.
      - `seller` string — Seller.
      - `sellerChain` string[] — Sellers involved in the chain. The list should contain only one seller, unless it is a [Multilevel Omnichannel Inventory](https://help.vtex.com/pt/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) order.
      - `imageUrl` string — Image URL.
      - `detailUrl` string — Detail URL.
      - `bundleItems` object[] — Information on services sold along with the SKU. Example: a gift package.
        - `type` string — Service type.
        - `id` integer — Service identifier.
        - `name` string — Service name.
        - `price` integer — Service price in cents.
      - `attachments` string[] — Array containing information on attachments.
      - `priceTags` object[] — Array of price tags, each of which, modifies the price in some way, like discounts or taxes that apply to the item in the context of the order.
        - `identifier` string, nullable — Promotion unique identifier.
        - `isPercentual` boolean — Indicates whether the `value` and `rawValue` of the price tag represent a percentage to be applied during checkout calculation. The default value is `false`. When set to `true`, the `value` and `rawValue` fields are interpreted as percentages, and the final price is calculated accordingly.
        - `name` string — Price tag name in the format: `{type}@{where}-{identifier}#{calculationId}`. Where: - `type` indicates whether the tag refers to a discount or tax. - `where` specifies the context, either price or shipping. - `identifier` is the promotion ID. - `calculationId` is a hash that may vary with each price calculation.
        - `rawValue` number — Raw price tag value with up to five decimals, sourced from the promotion configuration. This value is informational only and is not used in checkout calculations.
        - `value` integer — Price tag value representing either a promotion (value decrease) or a tax (value increase).
      - `availability` string — Availability.
      - `measurementUnit` string — Measurement unit.
      - `unitMultiplier` integer — Unit multiplier.
      - `manufacturerCode` string, nullable — Manufacturer code.
      - `priceDefinition` object — Price information for all units of a specific item.
        - `calculatedSellingPrice` integer — Item's calculated unitary selling price in cents.
        - `total` integer — Total value for all units of the item in cents.
        - `sellingPrices` object[] — 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.
          - `value` integer — Value in cents for that specific rounding.
          - `quantity` integer — Rounding quantity, meaning how many items are rounded to this value.
    - `sellers` object[] — Information on each seller.
      - `id` string — Seller ID.
      - `name` string — Seller name.
      - `logo` string, nullable — Seller logo.
      - `minimumOrderValue` integer, nullable — Minimum order value configured at the seller, in cents.
    - `totals` object[] — Information on order totals.
      - `id` string — Total ID.
      - `name` string — Total name.
      - `value` integer — Total value.
    - `clientProfileData` object, nullable — Customer's profile information.
      - `email` string, nullable — Email address.
      - `firstName` string, nullable — First name.
      - `lastName` string — Last name.
      - `documentType` string — Type of the document informed by the customer.
      - `document` string — Document informed by the customer.
      - `phone` string — Phone number.
      - `corporateName` string, nullable — Company name, if the customer is a legal entity.
      - `tradeName` string, nullable — Trade name, if the customer is a legal entity.
      - `corporateDocument` string, nullable — Corporate document, if the customer is a legal entity.
      - `stateInscription` string, nullable — State inscription, if the customer is a legal entity.
      - `corporatePhone` string, nullable — Corporate phone number, if the customer is a legal entity.
      - `isCorporate` boolean — Indicates whether the customer is a legal entity.
      - `profileCompleteOnLoading` boolean — Indicates whether profile is complete on loading.
      - `profileErrorOnLoading` boolean, nullable — Indicates whether profile presents error on loading.
      - `customerClass` string, nullable — Customer class.
    - `ratesAndBenefitsData` object — Information on rates and benefits that apply to the order.
      - `rateAndBenefitsIdentifiers` string[] — List with rates and benefits identifiers.
      - `teaser` string[] — List with rates and benefits teasers.
    - `shippingData` object — Shipping information pertinent to the order.
      - `address` object, nullable — Address information.
        - `addressType` string — Type of address. For example, `Residential` or `Pickup`.
        - `receiverName` string — Name of the person who is going to receive the order.
        - `addressId` string, nullable — Address ID.
        - `isDisposable` boolean — Indicates whether the address is disposable. Addresses marked as `isDisposable = true` are not saved to the shopper's profile when the order is completed, while addresses with `isDisposable = false` definitely belong to the shopper. Behavior by address type: - `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart. - `residential`: may be disposable. Addresses from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. All other residential addresses are disposable, including those from first-time purchases, since no complete profile exists yet. - `invoice`: does not have the `isDisposable` flag, since invoice addresses are of type `Address` rather than `ShippingAddress`. In practice, only authenticated shoppers can add invoice attachments to the cart, so they are never treated as disposable. - `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses. When a residential address is marked as disposable and the profile is complete, authentication is required to complete the order. Additionally, when a disposable residential address is used to complete a purchase, saved cards cannot be used.
        - `postalCode` string — Postal code.
        - `city` string — City of the shipping address.
        - `state` string — State of the shipping address.
        - `country` string — Three letter ISO code of the country of the shipping address.
        - `street` string — Street of the shipping address.
        - `number` string — Number of the building, house or apartment in the shipping address.
        - `neighborhood` string — Neighborhood of the shipping address.
        - `complement` string, nullable — Complement to the shipping address, in case it applies.
        - `reference` string, nullable — Complement that might help locate the shipping address more precisely in case of delivery.
        - `geoCoordinates` number[] — Array containing two floats with geocoordinates, first longitude, then latitude.
      - `logisticsInfo` object[] — Array with logistics information. Each object in this array corresponds to an object in the `items` array, based on the respective `itemIndex`.
        - `itemIndex` integer — Index corresponding to the position of the object in the `items` array.
        - `selectedSla` string, nullable — Selected SLA. For example, `normal` or `express`. If the store uses the [Delivery Options](https://help.vtex.com/en/docs/tutorials/delivery-options-beta) feature, this field returns the delivery option ID selected for this SLA, for example, `1223d5b4-52a4-442f-ab23-01345b60be48`. If this field is `null` or omitted, the API automatically selects the best delivery option available, excluding pickup and scheduled delivery options. To select a pickup option or a scheduled delivery option, it must be explicitly sent in this field. For more information, see the [Add shipping address and select delivery option](https://developers.vtex.com/docs/guides/checkout-api#tag/Cart-attachments/operation/AddShippingAddress) endpoint description.
        - `selectedDeliveryChannel` string, nullable — Delivery channel selected by the customer. For example, `"delivery"` or `"pickup-in-point"`.
        - `addressId` string, nullable — Address ID.
        - `slas` object[] — Information on available SLAs.
          - `id` string — SLA ID. If the store uses the [Delivery Options](https://help.vtex.com/en/docs/tutorials/delivery-options-beta) feature, this field returns the delivery option ID selected for this SLA, as the example `1223d5b4-52a4-442f-ab23-01345b60be48`.
          - `deliveryChannel` string — Delivery channel.
          - `name` string — SLA name. If the store uses the [Delivery Options](https://help.vtex.com/en/docs/tutorials/delivery-options-beta) feature, the value of this field will show the specific delivery option name selected for this SLA, as the example `Delivery | BRA | Up to 30 hours`.
          - `deliveryIds` object[] — Information on each delivery ID.
            - `courierId` string — Courier ID.
            - `warehouseId` string — Warehouse ID.
            - `dockId` string — Warehouse ID.
            - `courierName` string — Courier name.
            - `quantity` integer — Quantity.
          - `shippingEstimate` string — Shipping estimate. For instance, Three business days will be represented `3bd`. The unit can be `bd` for business days, `d` for days, `h` for hours, or `m` for minutes.
          - `shippingEstimateDate` string, nullable — When using the query parameter `individualShippingEstimates=true`, it will contain the estimated shipping date (e.g. `2023-09-09T11:29:00+00:00`), otherwise it will contain `null`.
          - `useIndividualShippingEstimates` boolean — Shows the product's estimated shipping date in the `shippingEstimate` field from the `orderForm`.
          - `lockTTL` string, nullable — Estimate date of delivery.
          - `price` integer — Price in cents.
          - `listPrice` integer — List price in cents.
          - `tax` integer — Tax in cents.
          - `pickupStoreInfo` object — Information on the pickup store.
            - `isPickupStore` boolean — Indicates whether it is the pickup store.
            - `friendlyName` string, nullable — Friendly name.
            - `address` object, nullable — Address information.
              - …
            - `additionalInfo` string, nullable — Additional information.
            - `dockId` string, nullable — Corresponding dock ID.
          - `pickupPointId` string, nullable — Pickup point ID.
          - `pickupDistance` integer — Pickup point distance.
          - `polygonName` string, nullable — Polygon name.
          - `transitTime` string — Transit time. For instance, "three business days" is represented `3bd`.
        - `shipsTo` string[] — List of countries that the item may be shipped to.
        - `itemId` string — Unique ID of the item in the cart. This ID is generated by VTEX and is used to identify the item in the cart.
        - `deliveryChannels` object[] — List of available delivery channels.
          - `id` string — Delivery channel ID.
      - `selectedAddresses` object[] — Array with information on the selected addresses for the order.
        - `addressType` string — Type of address. For example, `Residential` or `Pickup`.
        - `receiverName` string — Name of the person who is going to receive the order.
        - `addressId` string, nullable — Address ID.
        - `isDisposable` boolean — Indicates whether the address is disposable. Addresses marked as `isDisposable = true` are not saved to the shopper's profile when the order is completed, while addresses with `isDisposable = false` definitely belong to the shopper. Behavior by address type: - `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart. - `residential`: may be disposable. Addresses from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. All other residential addresses are disposable, including those from first-time purchases, since no complete profile exists yet. - `invoice`: does not have the `isDisposable` flag, since invoice addresses are of type `Address` rather than `ShippingAddress`. In practice, only authenticated shoppers can add invoice attachments to the cart, so they are never treated as disposable. - `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses. When a residential address is marked as disposable and the profile is complete, authentication is required to complete the order. Additionally, when a disposable residential address is used to complete a purchase, saved cards cannot be used.
        - `postalCode` string — Postal code.
        - `city` string — City of the shipping address.
        - `state` string — State of the shipping address.
        - `country` string — Three letter ISO code of the country of the shipping address.
        - `street` string — Street of the shipping address.
        - `number` string — Number of the building, house or apartment in the shipping address.
        - `neighborhood` string — Neighborhood of the shipping address.
        - `complement` string, nullable — Complement to the shipping address, in case it applies.
        - `reference` string, nullable — Complement that might help locate the shipping address more precisely in case of delivery.
        - `geoCoordinates` number[] — Array containing two floats with geocoordinates, first longitude, then latitude.
      - `availableAddresses` object[] — Array with information on the available addresses for the order.
        - `addressType` string — Type of address. For example, `Residential` or `Pickup`.
        - `receiverName` string — Name of the person who is going to receive the order.
        - `addressId` string, nullable — Address ID.
        - `isDisposable` boolean — Indicates whether the address is disposable. Addresses marked as `isDisposable = true` are not saved to the shopper's profile when the order is completed, while addresses with `isDisposable = false` definitely belong to the shopper. Behavior by address type: - `giftRegistry`, `pickup`, `search`, and `inStore`: always disposable, as they do not belong to the shopper navigating the cart. - `residential`: may be disposable. Addresses from a complete shopper profile, or entered by an authenticated shopper with a complete profile, are not disposable. All other residential addresses are disposable, including those from first-time purchases, since no complete profile exists yet. - `invoice`: does not have the `isDisposable` flag, since invoice addresses are of type `Address` rather than `ShippingAddress`. In practice, only authenticated shoppers can add invoice attachments to the cart, so they are never treated as disposable. - `commercial`: corresponds to company addresses used in B2B contexts and follows the same logic as residential addresses. When a residential address is marked as disposable and the profile is complete, authentication is required to complete the order. Additionally, when a disposable residential address is used to complete a purchase, saved cards cannot be used.
        - `postalCode` string — Postal code.
        - `city` string — City of the shipping address.
        - `state` string — State of the shipping address.
        - `country` string — Three letter ISO code of the country of the shipping address.
        - `street` string — Street of the shipping address.
        - `number` string — Number of the building, house or apartment in the shipping address.
        - `neighborhood` string — Neighborhood of the shipping address.
        - `complement` string, nullable — Complement to the shipping address, in case it applies.
        - `reference` string, nullable — Complement that might help locate the shipping address more precisely in case of delivery.
        - `geoCoordinates` number[] — Array containing two floats with geocoordinates, first longitude, then latitude.
    - `paymentData` object — Information on the order's payment.
      - `giftCards` object[] — Gift card information, if it applies to the order.
        - `redemptionCode` string — Gift card redemption code.
        - `value` integer — Gift card value in cents.
        - `balance` integer — Gift card balance in cents.
        - `name` string — Gift card name.
        - `id` string — Gift card ID.
        - `inUse` boolean — Indicates whether gift card is in use.
        - `isSpecialCard` boolean — Indicates whether gift card is special.
      - `transactions` object[] — Information on each transaction pertinent to the order.
        - `isActive` boolean — Indicates whether transaction is active.
        - `transactionId` string — Transaction ID.
        - `merchantName` string — Merchant name.
        - `payments` object[] — Information on each payment.
          - `accountId` string — Account ID.
          - `bin` string, nullable — Bin.
          - `installments` integer — Number of installments.
          - `paymentSystem` integer — Payment system.
          - `referenceValue` integer — Reference value for calculating interest rates, in case it applies. Displayed in cents.
          - `value` integer — Value including interest, in case it applies. Displayed in cents.
        - `sharedTransaction` boolean — Indicates whather transaction is shared.
    - `itemMetadata` object — Item metadata.
      - `items` object[] — List of objects containing metadata on each item in the order.
        - `id` string — Unique ID of the item in the cart. This ID is generated by VTEX and is used to identify the item in the cart.
        - `seller` string — Seller.
        - `name` string — Product name.
        - `skuName` string — SKU name.
        - `productId` string — Product ID.
        - `refId` string — Ref ID.
        - `ean` string, nullable — European Article Number.
        - `imageUrl` string — Image URL.
        - `detailUrl` string — Detail URL.
    - `salesChannel` string — Sales channel.
    - `followUpEmail` string — Follow up email address.
    - `creationDate` string — Creation date.
    - `lastChange` string — Last change.
    - `timeZoneCreationDate` string — Time zone creation date.
    - `timeZoneLastChange` string — Time zone last change.
    - `isCompleted` boolean — Indicates whether order is completed.
    - `hostName` string — Host name.
    - `merchantName` string, nullable — Merchant name.
    - `userType` string — User type.
    - `roundingError` integer — Rounding error.
    - `allowEdition` boolean — Indicates whether edition is allowed.
    - `allowCancelation` boolean — Indicates whether cancelation is allowed.
    - `allowChangeSeller` boolean — Indicates whether seller changing is allowed.
    - `isUserDataVisible` boolean — Indicates whether user data is visible.
    - `orderFormCreationDate` string — `orderForm` creation date.
    - `salesAssociateId` string — Sales Associate (Seller) identification code.

---

[API](https://skmtc.net/vtex/apis/checkout-api.md) · [All operations](https://skmtc.net/vtex/apis/checkout-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vtex/checkout-api/revisions/fc777477b318/schema)
